REST API Reference

Back Next

loginOAuth

Use this resource to log in to

Informatica Intelligent Cloud Services

using a JSON Web Token (JWT) access token.

The JWT access token is provided by your identity provider (IDP). Retrieve the token from your identity provider and include it in the loginOAuth request. The token can be used for one login request.

Before you can use the loginOAuth resource, the following prerequisites must be met:

The organization is licensed and configured to use SAML.

Users are set up as SAML users and are activated in the organization.

The organization's identity provider is registered.

The JWT access token's audience claim maps to the SAML entity ID configured in your organization's SAML setup. The audience claim can be one of the following values:

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

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

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

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

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

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

Optionally, you can include the resource in the audience claim. The resource name is customizable and can be set to any value, for example, LoginResource1, or UserLoginResource.

For more information about SAML configuration, see "User Administration" in

Administrator

For more information about registering identity providers, see Identity providers.

Use values from the following fields returned in the response:

icSessionId. A 30-minute REST API session ID that you include in the header for 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 resource URIs.

Use the logout resource to end the session.

POST Request

The login request must include a JWT access token. To get a JWT access token, see the documentation provided by your identity provider.

To log in, use the following URL:

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

For a list of cloud provider and region values, see login.

Include the following attributes in the request:

Field	Type	Required	Description
oauthToken	String	Yes	JWT access token.
orgId	String	Yes	ID of the organization the user belongs to.

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.
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.
sfUsername	String	Salesforce user name. Included when user is configured to authenticate through Salesforce.
password	String	Salesforce user password. Included when user is configured to authenticate through Salesforce.
firstName	String	First name for the user account.
lastName	String	Last name for the user account.
title	String	Title of the user.
password	String	User password, obfuscated.
phone	String	Phone number for the user.
emails	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 that the user belongs to. Use as a base for most version 2 and version 3 REST API resource URIs.
icSessionId	String	Informatica Intelligent Cloud Services Session ID. Use in most version 2 and version 3 REST API request headers.
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:"<question>"
securityAnswer	String	Answer to the security question, obfuscated.
uuId	String	Unique identifier for the user.
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.
roles		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.
usergroups		Object that contains the usergroups assigned to the user.
id	String	Included in the usergroups object. User group ID.
orgId	String	Included in the usergroups object. ID of the organization the user group belongs to.
name	String	Included in the usergroups object. Name of the user group.
description	String	Included in the usergroups object. Description of the user group.
createTime	String	Included in the usergroups object. Date and time the user group was created.
updateTime	String	Included in the usergroups object. Date and time the user group was last updated.
createdBy	String	Included in the usergroups object. User who created the user account.
updatedBy	String	Included in the usergroups object. User who last updated the user account.
spiUrl	String	This field is no longer applicable and has been deprecated.

POST Example

To log in to

Informatica Intelligent Cloud Services

using a JWT access token, you might use the following request:

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

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

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

As an example of using the serverUrl and icSessionId values in subsequent requests, 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: 0UNdbRXUXHpfqKZEbfmxoQ

Platform REST API version 2 resources

Download Guide

Watch

Comments

Cloud Data Integration Homepage