REST APIリファレンス

前へ次へ

ユーザー

このリソースを使用して、

Informatica Intelligent Cloud Services

ユーザーアカウントの詳細、または組織の全ユーザーアカウントの詳細を要求します。管理者特権を持っている場合にこのリソースを使用すると、ユーザーアカウントの作成または更新、ユーザーアカウントの削除を行うこともできます。組織のセキュリティを確保するため、このリソースはユーザーアカウントのパスワードを表示せず、更新しません。

完全なユーザー管理機能を活用するには、バージョン2のuserリソースではなく、バージョン3のusersリソースを使用します。バージョン3のusersリソースは、ユーザー、ユーザーグループ、およびロールをサポートします。バージョン2のuserリソースは、ユーザーグループおよびロールをサポートせず、GET要求は組織内のすべてのユーザーを返さない場合があります。

GET要求

Informatica Intelligent Cloud Services

ユーザーアカウントの詳細を要求するには、次のURIを使用します。

/api/v2/user

特定の

Informatica Intelligent Cloud Services

ユーザーアカウントの詳細を要求する場合、URIにユーザーアカウントIDまたはユーザー名を含めることができます。次のいずれかのURIを使用します。

/api/v2/user/<id>

/api/v2/user/name/<name>

URIにユーザー名を使用し、ユーザー名にスペースが含まれる場合、スペースは

%20

に置き換えます。以下に例を示します。

/api/v2/user/name/Fred%20Smith

GET応答

ユーザーアカウントの詳細を要求すると、

Informatica Intelligent Cloud Services

は要求されたユーザーアカウントのユーザーオブジェクトを返します。すべてのユーザーアカウントの詳細を要求すると、

Informatica Intelligent Cloud Services

は組織の各ユーザーアカウントのユーザーオブジェクトを返します。

ユーザーオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
id	String	ユーザーID。
orgId	String	ユーザーが属する組織のID。 22文字。従来のInformatica Cloudで作成された組織では、6文字の組織IDである可能性があります。
orgUuid	String	組織の一意のID。
name	String	Informatica Intelligent Cloud Services のユーザー名。
description	String	ユーザーの説明。
createTime	String	ユーザーアカウントの作成日時。
updateTime	String	ユーザーアカウントの最終作成日時。
createdBy	String	ユーザーアカウントを作成した Informatica Intelligent Cloud Services ユーザー。
updatedBy	String	ユーザーアカウントを最後に更新した Informatica Intelligent Cloud Services ユーザー。
sfUsername	String	Salesforceのユーザー名。ユーザーがSalesforceによって認証されるように設定されている場合に含まれます。
password	String	Salesforceのユーザーパスワード。ユーザーがSalesforceによって認証されるように設定されている場合に含まれます。
firstName	String	ユーザーアカウントの名。
lastName	String	ユーザーアカウントの姓。
title	String	ユーザーの役職。
phone	String	ユーザーの電話番号。
securityQuestion	String	セキュリティの質問。次のいずれかのコードを返します。 SPOUSE_MEETING_CITY FIRST_JOB_CITY CHILDHOOD_FRIEND MOTHER_MAIDEN_NAME PET_NAME CHILDHOOD_NICKNAME CUSTOM_QUESTION:"<question>"
securityAnswer	String	セキュリティの質問に対する答え。
roles		ユーザーに割り当てられた各ロールのロールオブジェクトを含むオブジェクト。
name	String	ロールオブジェクトに含まれます。ロール名。次のいずれかのコードを返します。サービスコンシューマ Designer Admin
description	String	ロールオブジェクトに含まれます。ロールの説明。
emails	String	ユーザーがアカウントパスワードを変更する際に通知される電子メールアドレス。
timezone	String	ユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。詳細については、タイムゾーンのコードを参照してください。
serverUrl	String	ユーザーが属する組織の Informatica Intelligent Cloud Services のURL。最も正確なバージョン2 REST APIのリソースURIのベースとしてserverUrlを使用します。
spiUrl	String	このフィールドは適用されなくなり、非推奨になりました。
uuId	String	ユーザーの一意のID。
icSessionId	String	バージョン2 REST APIセッションの Informatica Intelligent Cloud Services セッションID。最も正確なバージョン2 REST API要求ヘッダーで使用します。
forceChangePassword	Boolean	初回ログイン後、ユーザーがパスワードをリセットする必要があるかどうかを決定します。次の値が含まれます。 True。ユーザーはパスワードをリセットする必要があります。 False。ユーザーはパスワードをリセットする必要がありません。

POST要求

ユーザーを作成したり、ユーザーの詳細を更新したりするには、管理者としてログインする必要があります。既存のユーザーアカウントの詳細を更新するには、次のURIでユーザーアカウントIDを使用します。

/api/v2/user/<id>

新しい

Informatica Intelligent Cloud Services

ユーザーアカウントを作成するには、URIでオプションのユーザーアカウントIDを省略します。

SAMLシングルサインオンユーザーアカウントを作成するには、パスワードを含めません。

ユーザー

オブジェクトでは次の属性を使用できます。

フィールド	タイプ	必須	説明
orgId	String	○	ユーザーが属する組織のID。 22文字。従来のInformatica Cloudで作成された組織では、6文字の組織IDである可能性があります。loginリソースを使用して組織のIDを検索できます。
name	String	○	Informatica Intelligent Cloud Services のユーザー名。このリソースを使用してユーザーアカウントを作成する場合、有効な電子メールアドレスである必要があります。最大長は255文字です。
sfUsername	String	-	Salesforceのユーザー名。
password	String	〇（ユーザーがSAMLシングルサインオンユーザーの場合を除く）	Informatica Intelligent Cloud Services のパスワード。ユーザーがSAMLシングルサインオンユーザーであり、組織でSAMLが有効な場合は含めません。最大長は255文字です。
firstName	String	○	ユーザーアカウントの名。
lastName	String	○	ユーザーアカウントの姓。
title	String	○	ユーザーの役職。
phone	String	○	ユーザーの電話番号。
emails	String	-	ユーザーがアカウントパスワードを変更する際に通知される電子メールアドレス。
description	String	-	ユーザーの説明。
timezone	String	-	ユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。該当するタイムゾーンコードを使用します。有効なタイムゾーンが渡されない場合、 Informatica Intelligent Cloud Services はデフォルトでAmerica/Los_Angelesを使用します。詳細については、タイムゾーンのコードを参照してください。
securityQuestion	String	-	セキュリティの質問。次のいずれかのコードを使用してセキュリティの質問を選択します。 SPOUSE_MEETING_CITY FIRST_JOB_CITY CHILDHOOD_FRIEND MOTHER_MAIDEN_NAME PET_NAME CHILDHOOD_NICKNAME CUSTOM_QUESTION:"<question>"
securityAnswer	String	-	セキュリティの質問に対する答え。
roles		はい	ユーザーに割り当てられた各ロールのロールオブジェクトを含むオブジェクト。
name	String	○	ロールオブジェクトに含めます。ユーザーに割り当てるロール。次のいずれかの値を使用します。サービスコンシューマデザイナ管理者
description	String	-	ロールオブジェクトに含めます。ロールの説明。
forceChangePassword	String	-	初回ログイン後、ユーザーがパスワードをリセットする必要があるかどうかを決定します。次の値が含まれます。 True。ユーザーはパスワードをリセットする必要があります。 False。ユーザーはパスワードをリセットする必要がありません。

POST応答

要求されたユーザーアカウントのユーザー応答オブジェクトを返します。または、すべてのユーザーアカウントの情報を要求した場合は、組織の各ユーザーアカウントのユーザー応答オブジェクトを返します。

エラーが発生した場合はエラーオブジェクトを返します。

DELETE要求

ユーザーを削除するには、次のURIでユーザーアカウントIDを使用します。

/api/v2/user/<id>

DELETE応答

要求に成功した場合に200の応答コードを返します。

エラーが発生した場合はエラーオブジェクトを返します。

POSTの例

新規ユーザーを作成するには、次の要求を使用できます。

POST <serverUrl>/api/v2/user/ 
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<user>
 <orgId>00342000</orgId>
 <name>username@company.com</name>
 <firstName>User</firstName>
 <lastName>Name</lastName>
 <title>developer</title>
 <password>UserPassword</password>
 <phone>5555555555</phone>
 <email>larry@company.com</email>
 <roles>
    <role>
      <name>Designer</name>
    </role>
 </roles>
 <timezone>America/Chicago</timezone>
</user>

プラットフォームREST APIバージョン2リソース

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal