Login

You can use this resource to log in to your organization using your Informatica Intelligent Cloud Services user account.

V2 / login

Use the base URL and session ID returned in the response for subsequent requests during this session.

Use the logout resource to end the session.

To log in using SAML single sign-on, see loginSaml.

To log in using Salesforce credentials, see loginSf.

POST Request

  • North America:
https://dm-us.informaticacloud.com/ma/api/v2/user/login
  • Europe
https://dm-em.informaticacloud.com/ma/api/v2/user/login
  • Asia Pacific:
https://dm-ap.informaticacloud.com/ma/api/v2/user/login

Field

Type

Required

Descrption

username

String

Yes

Informatica Intelligent Cloud Services user name.

password

String

Yes

Informatica Intelligent Cloud Services password.

POST Response

Returns the user object if the request is successful. Returns the error object if errors occur.
The response includes the following information that you need to include in the header of subsequent REST API calls:

  • icSessionId. A REST API session ID that you include in the header for version 2 REST API calls.The session ID expires after 30 minutes of inactivity. After the session ID expires, log in again to continue working with the REST API.
    For information on retrieving session status details, see Session IDs.
    . serverUrl. The base URL that you use in all version 2 resource URIs except for login, for example:
    /api/v2/job
    The user object includes the following attributes:

Field

Type

Description

id

String

User ID.

orgid

String

ID of the organization the user belongs to.
6 characters.

orgUuid

String

Unique identifier for the organization.

name

String

Informatica Intelligent Cloud Services user name.

description

String

Description of the user.

createTime

String

When the user account was created.

updateTime

String

When the user account was last updated

createdBy

String

Informatica Intelligent Cloud Services user who created the user account

updatedBy

String

Informatica Intelligent Cloud Services user who last updated the user account.

firstName

String

First name for the user account.

lastName

String

Last name for the user account.

title

String

Title of the user.

phone

String

Phone number for the user

securityQuestion

String

Security question. Returns one of the following codes:

  • SPOUSE_MEETING_CITY
  • FIRST_JOB_CITY
  • CHILDHOOD_FRIEND
  • MOTHER_MAIDEN_NAME
  • PET_NAME
  • CHILDHOOD_NICKNAME
  • CUSTOM_QUESTION:""

securityAnswer

String

Answer to the security question.

roles

String

Object that contains roles assigned to the user.

name

String

Included in role object.
Role name. Returns one of the following codes:

  • SERVICE_CONSUMER
  • DESIGNER
  • ADMIN

description

String

Included in role object.
Role description.

email

String

Email address to be notified when the user changes the account password.

timezone

String

Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see Time zone codes.

serverUrl

String

Informatica Intelligent Cloud Services URL for the organization the user belongs to. Use the serverUrl as a base for most version 2 REST API resource URIs.

spiUrl

String

Informatica Cloud Application Integration URL for the organization the user belongs to.

uuId

String

Unique identifier for the user

icSessionId

String

Informatica Intelligent Cloud Services session ID for version 2 REST API session. Use in most version 2 REST API request headers.

forceChangePassword

Boolean

Determines if the user must reset the password after the user logs in for the first time. Includes the following values:

  • True. The user must reset the password.
  • False. The user is not forced to reset the password.

POST Example

To log in to your Informatica Intelligent Cloud Services organization, you might use the following request:

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

{
"@type": "login",
"username": "[email protected]",
"password": "mypassword"
}

The response returns the user object which contains the serverUrl and icSessionId values to use in subsequent calls, as shown in the following example:

{    
    "id": "0101TQ03000000000007",    
    "orgId": "0101TQ",    
    "orgUuid": "3FNFLs1uHe2IIgTs8tRjSJ",    
    "name": "[email protected]",    
    "description": "",    
    "createTime": "2018-02-16T00:20:07.000Z",    
    "updateTime": "2018-07-17T22:45:50.000Z",    
    "createdBy": "System built-in user",    
    "updatedBy": "[email protected]",    
    "sfUsername": null,    
    "firstName": "John",    
    "lastName": "Randall",    
    "title": "IICS Admin",    
    "password": "**********",    
    "phone": "123-456-7899",    
    "emails": "[email protected]",    
    "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."
        }
    ],    
    "spiUrl": "https://na4.ai.dm-us.informaticacloud.com"
}

Using the above response as an example, to send a GET request to obtain Secure Agent information, you might use the following request:

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

LoginSaml

Use this version 2 API resource to log in to Informatica Intelligent Cloud Services using a Security Assertion Markup Language (SAML) token. The SAML token is a SAML response generated by your identity provider that contains a SAML assertion.

The loginSaml response includes the session ID and base URL that you include in subsequent REST API calls. Use values from the following fields returned in the response:

  • icSessionId. A two hour REST API session ID that you include in the header for version 2 REST API calls. After the session ID expires, log in again to continue working with the REST API. For information on retrieving session status details, see Session IDs.
  • serverUrl. The base URL that you use in all version 2 resource URIs except for loginSaml, for example:/api/v2/job

Use the logout resource to end the session.

POST Request

The login request must include a SAML token. To get a SAML token, see the documentation provided by your identity provider. To see an example of a SAML token or SAML response, see https://www.samltool.com/generic_sso_res.php.
To log in, use the following URL:

https://dm-us.informaticacloud.com/ma/api/v2/user/loginSaml

With this URL, use the following attributes in a login object:

Field

Type

Required

Description

samlToken

String

Yes

SAML token.

orgId

String

Yes

Informatica Intelligent Cloud Services organization ID.

POST Response

Returns the user object if the request is successful. Returns the error object if errors occur.
Use the base URL and session ID returned in the response for subsequent requests during this session.
The user object includes the following attributes:

Field

Type

Description

id

String

User ID.

orgId

String

ID of the organization the user belongs to.
6 characters.

name

String

Informatica Intelligent Cloud Services user name.

description

String

Description of the user.

createTime

String

When the user account was created.

updateTime

String

When the user account was last updated

createdBy

String

Informatica Intelligent Cloud Services user who created the user account.

updatedBy

String

Informatica Intelligent Cloud Services user who last updated the user account.

firstName

String

First name for the user account.

lastName

String

Last name for the user account.

title

String

Title of the user.

phone

String

Phone number for the user.

roles

String

Object that contains roles assigned to the user.

name

String

Included in role object.
Role name. Returns one of the following codes:

  • Service Consumer
  • Designer
  • Admin

description

String

Included in role object.
Role description.

email

String

Email address to be notified when the user changes the account password.

timezone

String

Time zone of the user. Time zone honors Daylight Saving Time.
For more information, see Time zone codes.

serverUrl

String

Informatica Intelligent Cloud Services URL for the organization the user belongs to. Use the serverUrl as a base for most version 2 REST API resource URIs.

icSessionId

String

Informatica Intelligent Cloud Services session ID for version 2 REST API session. Use in most version 2 REST API request headers

spiUrl

String

Informatica Cloud Application Integration URL for the organization the user belongs to.

uuId

Boolean

Unique identifier for the user.

POST Example

To log in to Informatica Intelligent Cloud Services using SAML single sign-on, you might use the following request:

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"
}

The response returns the user object which contains the serverUrl and icSessionId values to use in subsequent calls, as shown in the following example:

{    
    "id": "0101TQ03000000000007",    
    "orgId": "003420",    
    "orgUuid": "3FNFLs1uHe2IIgTs8tRjSJ",    
    "name": "[email protected]",    
    "description": "",    
    "createTime": "2018-02-16T00:20:07.000Z",    
    "updateTime": "2018-07-17T22:45:50.000Z",    
    "createdBy": "System built-in user",    
    "updatedBy": "[email protected]",    
    "sfUsername": null,    
    "firstName": "John",    
    "lastName": "Randall",    
    "title": "IICS Admin",    
    "phone": "123-456-7899",    
    "emails": "[email protected]",    
    "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."
        }
    ],    
    "spiUrl": "https://na4.ai.dm-us.informaticacloud.com"

Using the above response as an example, to send a GET request to obtain Secure Agent information, you might use the following request:

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