REST APIリファレンス

前へ次へ

loginOAuth

このリソースを使用して、JSON Web Token（JWT）アクセストークンを使用して

Informatica Intelligent Cloud Services

にログインします。

JWTアクセストークンは、IDプロバイダ（IDP）によって提供されます。IDプロバイダからトークンを取得し、loginOAuth要求に含めます。トークンは1つのログイン要求に対して使用することができます。

loginOAuthリソースを使用する前に、次の前提条件を満たす必要があります。

組織にSAMLを使用するためのライセンスがあり、SAMLを使用するように設定されている。

ユーザーがSAMLユーザーとして設定され、組織内でアクティブ化されている。

組織のIDプロバイダが登録されている。

JWTアクセストークンのオーディエンスクレームが、組織のSAMLセットアップで設定されたSAMLエンティティIDにマッピングされている。オーディエンスクレームは、次のいずれかの値になります:

api://<orgId>.<クラウドプロバイダ>-<リージョン>.informaticacloud.com

api://<クラウドプロバイダ>-<リージョン>.informaticacloud.com.<orgId>

api://<cloud provider>-<region>.informaticacloud.com/<orgId>

https://<orgId>.<クラウドプロバイダ>-<リージョン>.informaticacloud.com

https://<クラウドプロバイダ>-<リージョン>.informaticacloud.com.<orgId>

https://<cloud provider>-<region>.informaticacloud.com/<orgId>

必要に応じて、オーディエンスクレームにリソースを含めることができます。リソース名はカスタマイズ可能で、LoginResource1やUserLoginResourceなどの任意の値に設定することができます。

SAML設定の詳細については、『Administrator

』の「ユーザー管理」を参照してください。

IDプロバイダの登録の詳細については、IDプロバイダを参照してください。

応答で返される次のフィールドの値を使用します。

icSessionId。REST API呼び出しのヘッダーに含める、30分のREST APIセッションID。セッションIDの期限が切れたら、再度ログインしてREST APIでの操作を続行します。

セッションステータスの詳細取得については、セッションIDを参照してください。

serverURL。すべてのリソースURIで使用するベースURL。

このlogoutリソースを使用して、セッションを終了します。

POST要求

ログイン要求にはJWTアクセストークンを含める必要があります。JWTアクセストークンを取得するには、IDプロバイダが提供するマニュアルを参照してください。

ログインするには、次のURLを使用します。

https://<cloud provider>-<region>.informaticacloud.com/ma/api/v2/user/loginOAuth

クラウドプロバイダとリージョンの値のリストについては、ログインを参照してください。

要求に次の属性を含めます。

フィールド	タイプ	必須	説明
oauthToken	String	○	JWTアクセストークン。
orgId	String	○	ユーザーが属する組織のID。

POST応答

要求が成功すると、ユーザーオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。

このセッション中は、後続の要求の応答で返されるベースURLとセッションIDを使用します。

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

フィールド	タイプ	説明
id	String	ユーザーID。
orgId	String	ユーザーが属する組織の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	ユーザーの役職。
password	String	ユーザーパスワード（難読化済み）。
phone	String	ユーザーの電話番号。
emails	String	ユーザーがアカウントパスワードを変更する際に通知される電子メールアドレス。
timezone	String	ユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。詳細については、タイムゾーンのコードを参照してください。
serverUrl	String	ユーザーが属する組織の Informatica Intelligent Cloud Services のURL。ほぼすべてのバージョン2およびバージョン3のREST APIリソースURIのベースとして使用します。
icSessionId	String	Informatica Intelligent Cloud Services のセッションID。ほぼすべてのバージョン2およびバージョン3のREST API要求ヘッダーで使用します。
securityQuestion	String	セキュリティの質問。次のいずれかのコードを返します。 SPOUSE_MEETING_CITY FIRST_JOB_CITY CHILDHOOD_FRIEND MOTHER_MAIDEN_NAME PET_NAME CHILDHOOD_NICKNAME CUSTOM_QUESTION:"<question>"
securityAnswer	String	セキュリティの質問に対する回答（難読化済み）。
uuId	String	ユーザーの一意のID。
forceChangePassword	Boolean	初回ログイン後、ユーザーがパスワードをリセットする必要があるかどうかを決定します。次の値が含まれます。 True。ユーザーはパスワードをリセットする必要があります。 False。ユーザーはパスワードをリセットする必要がありません。
roles		ユーザーに割り当てられたロールを含むオブジェクト。
name	String	ロールオブジェクトに含まれます。ロール名。次のいずれかのコードを返します。サービスコンシューマ Designer Admin
description	String	ロールオブジェクトに含まれます。ロールの説明。
usergroups		ユーザーに割り当てられたusergroupsを含むオブジェクト。
id	文字列	usergroupsオブジェクトに含まれます。ユーザーグループID。
orgId	String	usergroupsオブジェクトに含まれます。ユーザーグループが属する組織のID。
name	文字列	usergroupsオブジェクトに含まれます。ユーザーグループの名前。
description	文字列	usergroupsオブジェクトに含まれます。ユーザーグループの説明。
createTime	文字列	usergroupsオブジェクトに含まれます。ユーザーグループを作成した日時。
updateTime	文字列	usergroupsオブジェクトに含まれます。ユーザーグループが最後に更新された日時。
createdBy	文字列	usergroupsオブジェクトに含まれます。ユーザーアカウントを作成したユーザー。
updatedBy	String	usergroupsオブジェクトに含まれます。ユーザーアカウントを最後に更新したユーザー。
spiUrl	String	このフィールドは適用されなくなり、非推奨になりました。

POSTの例

JWTアクセストークンを使用して

Informatica Intelligent Cloud Services

にログインするには、次の要求を使用します:

POST https://dm-us.informaticacloud.com/ma/api/v2/user/loginOAuth
Content-Type: application/json
Accept: application/json

{
"orgId": "6xVpQpzHBAoizhbMOLzty9",
"oauthToken": "<JWT token>"
}

応答では、後続の呼び出しで使用するserverUrlおよびicSessionIdの値が含まれるユーザーオブジェクトが返されます。次に例を示します。

{
    "id": "01000103000000000002",
    "orgId": "010001",
    "orgUuid": "6xVpQpzHBAoizhbMOLzty9",
    "name": "Larry@infa.com",
    "description": null,
    "createTime": "2023-07-20T15:13:12.000Z",
    "updateTime": "2023-07-20T15:13:32.000Z",
    "createdBy": "ma",
    "updatedBy": "Scott@infa.com",
    "sfUsername": null,
    "firstName": "Larry",
    "lastName": "Felyne",
    "title": "Manager",
    "password": "********",
    "phone": "423435546657652",
    "emails": "Larry@infa.com",
    "timezone": null,
    "serverUrl": "https://na4.dm-us.informaticacloud.com/saas",
    "icSessionId": "0UNdbRXUXHpfqKZEbfmxoQ",
    "securityQuestion": "In what city did you meet your spouse/significant other?",
    "securityAnswer": "********",
    "uuid": "6qnnXdzBdtUbObUTYhyWO1",
    "forceChangePassword": false,
    "roles": [
        {
            "name": "Admin",
            "description": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
        },
        {
            "name": "Data Preview",
            "description": "Role to preview data"
        },
        {
            "name": "Designer",
            "description": "Role for creating assets, tasks, and processes. Can configure connections, schedules, and runtime environments. Has access to the Application Integration Console."
        }
    ],
    "usergroups": [
        {
            "id": "aRfrqNzCfg7e9SDOJ3y1Yn",
            "orgId": "010001",
            "name": "G2",
            "description": "",
            "createTime": "2023-08-01T05:33:22.000Z",
            "updateTime": "2023-08-01T05:33:23.000Z",
            "createdBy": "Scott@infa.com",
            "updatedBy": "Scott@infa.com"
        }
    ],
    "spiUrl": null
}

後続の要求でserverUrl値とicSessionId値を使用する例として、Secure Agent情報を取得するためのGET要求を送信するには、次の要求を使用します:

GET https://na4.dm-us.informaticacloud.com/saas/api/v2/agent
Content-Type: application/json
Accept: application/json
icSessionId: 0UNdbRXUXHpfqKZEbfmxoQ

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

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal