Login

Use this resource to log in to Informatica Intelligent Cloud Services to use version 3 REST API resources.

V3 / Login

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

  • sessionId. A REST API session ID that you include in the header for version 3 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.

  • baseApiUrl. The base URL that you use in all version 3 resource URIs except for login, for example:

    /public/core/v3/lookup

POST Request

To log in using version 3 of the Informatica Intelligent Cloud Services API, use one of the following URLs:

  • North America:
https://dm-us.informaticacloud.com/saas/public/core/v3/login
  • Europe
https://dm-em.informaticacloud.com/saas/public/core/v3/login
  • Asia Pacific:
https://dm-ap.informaticacloud.com/saas/public/core/v3/login

Use the following fields in a login object:

FieldTypeRequiredDescription
usernameStringYesInformatica Intelligent Cloud Services user name.
Maximum length is 255 characters
passwordStringYesInformatica Intelligent Cloud Services password.
Maximum length is 255 characters.

Use the following fields in a login object:

POST Response

Returns user information 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.
A successful request returns the following objects:

FieldTypeDescription
productsCollectionSubscribed Informatica products.
nameStringProduct name.
baseApiUrlStringReturned in the product object.
Base API URL for the product. Use in REST API requests
userInfoCollectionUser information.
sessionIdStringReturned in the userInfo object.
REST API session ID for the current session. Use in most REST API request headers.
idStringReturned in the userInfo object.
User ID.
nameStringUser name.
parentOrgIdStringOrganization ID for the parent organization.
orgIdStringReturned in the userInfo object.
ID of the organization the user belongs to.
22 characters.
orgNameStringReturned in the userInfo object.
Organization name
groupsCollectionUser group information for the user.
statusStringStatus of the user.
Returns one of the following values:
- Active
- Inactive

POST Example

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

POST https://dm-us.informaticacloud.com/saas/public/core/v3/login 
Content-Type: application/json
Accept: application/json

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

If successful, the response includes the products and userInfo objects which contain the baseApiUrl and sessionId values to use in subsequent calls, as shown in the following example:

{
    "products": [
        {
            "name": "Integration Cloud",
            "baseApiUrl": "https://pod.clouddev.informaticacloud.com/saas"
        }
    ],
    "userInfo": {
        "sessionId": "9KA11tLGqxVcGeul8SQBK3",
        "id": "9L1GFroXSDHe2IIg7QhBaT",
        "name": "user",
        "parentOrgId": "52ZSTB0IDK6dXxaEQLUaQu",
        "orgId": "0cuQSDTq5sikvN7x8r1xm1",
        "orgName": "MyOrg_INFA",
        "groups": {},
        "status": "Active"
    }
}

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

GET https://pod.clouddev.informaticacloud.com/saas/public/core/v3/license/org/0cuQSDTq5sikvN7x8r1xm1
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3

V2 / login

You can use this resource to log in to your organization using your Informatica Intelligent Cloud Services user account.
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
FieldTypeRequiredDescrption
usernameStringYesInformatica Intelligent Cloud Services user name.
passwordStringYesInformatica 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:
FieldTypeDescription
idStringUser ID.
orgidStringID of the organization the user belongs to.
6 characters.
orgUuidStringUnique identifier for the organization.
nameStringInformatica Intelligent Cloud Services user name.
descriptionStringDescription of the user.
createTimeStringWhen the user account was created.
updateTimeStringWhen the user account was last updated
createdByStringInformatica Intelligent Cloud Services user who created the user account
updatedByStringInformatica Intelligent Cloud Services user who last updated the user account.
firstNameStringFirst name for the user account.
lastNameStringLast name for the user account.
titleStringTitle of the user.
phoneStringPhone number for the user
securityQuestionStringSecurity question. Returns one of the following codes:
- SPOUSE_MEETING_CITY
- FIRST_JOB_CITY
- CHILDHOOD_FRIEND
- MOTHER_MAIDEN_NAME
- PET_NAME
- CHILDHOOD_NICKNAME
- CUSTOM_QUESTION:""
securityAnswerStringAnswer to the security question.
roles StringObject that contains roles assigned to the user.
nameStringIncluded in role object.
Role name. Returns one of the following codes:
- SERVICE_CONSUMER
- DESIGNER
- ADMIN
descriptionStringIncluded in role object.
Role description.
emailStringEmail address to be notified when the user changes the account password.
timezoneStringTime zone of the user. Time zone honors Daylight Saving Time.
For more information, see Time zone codes.
serverUrlStringInformatica 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.
spiUrlStringInformatica Cloud Application Integration URL for the organization the user belongs to.
uuIdStringUnique identifier for the user
icSessionIdStringInformatica Intelligent Cloud Services session ID for version 2 REST API session. Use in most version 2 REST API request headers.
forceChangePasswordBooleanDetermines 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 SAML single sign-on.

The login response includes the session ID and base URL that you need to include in subsequent REST API calls. Use values from the following fields:
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

You can log in to an organization using SAML single sign-on credentials.
Use the following UR

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

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

FieldTypeRequiredDescription
samlTokenStringYesSAML login token.
orgIdStringYesInformatica 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:

FieldTypeDescription
idStringUser ID.
orgIdStringID of the organization the user belongs to.
6 characters.
nameStringInformatica Intelligent Cloud Services user name.
descriptionStringDescription of the user.
createTimeStringWhen the user account was created.
updateTimeStringWhen the user account was last updated
createdByStringInformatica Intelligent Cloud Services user who created the user account.
updatedByStringInformatica Intelligent Cloud Services user who last updated the user account.
firstNameStringFirst name for the user account.
lastNameStringLast name for the user account.
titleStringTitle of the user.
phoneStringPhone number for the user.
rolesStringObject that contains roles assigned to the user.
nameStringIncluded in role object.
Role name. Returns one of the following codes:
- Service Consumer
- Designer
- Admin
descriptionStringIncluded in role object.
Role description.
emailStringEmail address to be notified when the user changes the account password.
timezoneStringTime zone of the user. Time zone honors Daylight Saving Time.
For more information, see Time zone codes.
serverUrlStringInformatica 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.
icSessionIdStringInformatica Intelligent Cloud Services session ID for version 2 REST API session. Use in most version 2 REST API request headers
spiUrlStringInformatica Cloud Application Integration URL for the organization the user belongs to.
uuIdBooleanUnique 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": "<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