REST APIリファレンス

前へ次へ

loginSaml

このバージョン2のAPIリソースを使用して、Security Assertion Markup Language（SAML）トークンで

Informatica Intelligent Cloud Services

にログインします。SAMLトークンは、SAMLアサーションを含むBase64でエンコードされたXMLファイルです。このトークンは、ログインが成功した後にIDプロバイダ（IDP）によって提供されます。

SAMLトークンがSSOログインの実行にすでに使用されている場合は、トークンの有効期限がまだ切れていなくても、APIログインの実行にこのトークンを使用することはできません。ユーザー名とパスワードを使用してログインする必要があります。

loginSaml応答には、後続のREST API呼び出しに含めるセッションIDとベースURLが含まれています。応答で返される次のフィールドの値を使用します。

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

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

serverURL。loginSamlを除くすべてのバージョン2リソースのURIで使用するベースURL。例:

<serverUrl>/api/v2/job

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

POST要求

ログイン要求にはSAMLトークンを含める必要があります。SAMLトークンを取得するには、IDプロバイダが提供するドキュメントを参照してください。SAMLトークンとSAML応答の例については、KBの記事「FAQ: What is samlToken in loginSaml ReST API call of IICS?」を参照してください。

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

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

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

このURLでは、ログインオブジェクトの次の属性を使用します。

フィールド	タイプ	必須	説明
samlToken	String	○	SAMLトークン。
orgId	String	○	Informatica Intelligent Cloud Services の組織ID。

POST応答

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

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

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

フィールド	タイプ	説明
id	String	ユーザーID。
orgId	String	ユーザーが属する組織のID。
orgUuid	文字列	組織の一意の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 ユーザー。
firstName	String	ユーザーアカウントの名。
lastName	String	ユーザーアカウントの姓。
title	String	ユーザーの役職。
phone	String	ユーザーの電話番号。
roles		ユーザーに割り当てられたロールを含むオブジェクト。
name	String	ロールオブジェクトに含まれます。ロール名。次のいずれかのコードを返します。サービスコンシューマ Designer Admin
description	String	ロールオブジェクトに含まれます。ロールの説明。
email	String	ユーザーがアカウントパスワードを変更する際に通知される電子メールアドレス。
timezone	String	ユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。詳細については、タイムゾーンのコードを参照してください。
serverUrl	String	ユーザーが属する組織の Informatica Intelligent Cloud Services のURL。最も正確なバージョン2 REST APIのリソースURIのベースとしてserverUrlを使用します。
icSessionId	String	バージョン2 REST APIセッションの Informatica Intelligent Cloud Services セッションID。最も正確なバージョン2 REST API要求ヘッダーで使用します。
spiUrl	String	このフィールドは適用されなくなり、非推奨になりました。
uuId	String	ユーザーの一意のID。

POSTの例

SAMLシングルサインオンを使用して

Informatica Intelligent Cloud Services

にログインするには、次の要求を使用できます。

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

{
"@type": "login",
"samlToken": "<SAML token>",
"orgId": "003420"
}

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

{    
    "id": "0101TQ03000000000007",    
    "orgId": "003420",    
    "orgUuid": "3FNFLs1uHe2IIgTs8tRjSJ",    
    "name": "John@infa.com",    
    "description": "",    
    "createTime": "2018-02-16T00:20:07.000Z",    
    "updateTime": "2018-07-17T22:45:50.000Z",    
    "createdBy": "System built-in user",    
    "updatedBy": "John@infa.com",    
    "sfUsername": null,    
    "firstName": "John",    
    "lastName": "Randall",    
    "title": "IICS Admin",    
    "phone": "123-456-7899",    
    "emails": "John@infa.com",    
    "timezone": null,    
    "serverUrl": "https://na4.dm-us.informaticacloud.com/saas",    
    "icSessionId": "1Ckv5VDHe2IICHi2hq04EF",    
    "securityQuestion": "In what city were you born?",    
    "securityAnswer": "********",    
    "uuid": "a51jk7TB0IDcnWLwJdLaW2",    
    "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."
        }
    ],    
}

上記のような応答を例として使用し、GET要求を送信してSecure Agent情報を取得するには、次の要求を使用できます。

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

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

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal