Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. RunAJob utility
  8. REST API codes
  9. REST API resource quick references

REST API Reference

REST API Reference

loginSf

loginSf

Use this resource to log in to an
Informatica Intelligent Cloud Services
organization using Salesforce credentials.
The login response includes the session ID and base URL that you need to include in subsequent REST API calls.
You must activate your
Informatica Intelligent Cloud Services
user account before you can log in using the loginSf resource.
Use the Salesforce Web Services API to generate a Salesforce session ID and to retrieve the Salesforce server URL. For more information, see the Salesforce
Web Services API Developer's Guide
.
Use the logout resource to end the session.

POST Request

To log in using Salesforce credentials, use one of the following URLs:
  • North America:
    https://dm-us.informaticacloud.com/ma/api/v2/user/loginSf
  • Europe:
    https://dm-em.informaticacloud.com/ma/api/v2/user/loginSf
  • Asia Pacific:
    https://dm-ap.informaticacloud.com/ma/api/v2/user/loginSf
Use the following attributes in a loginSf object:
Field
Type
Required
Description
sfSessionId
String
Yes
Salesforce session ID. For information about generating the Salesforce session ID, see the login resource in the Salesforce
Web Services API Developer's Guide
.
sfServerUrl
String
Yes
Salesforce server URL.
Retrieve the Salesforce server URL from the Salesforce API login resource response.

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:
    <serverUrl>/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.
22 characters.
Organizations that were created in legacy Informatica Cloud might have an organization ID of 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.
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.
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:"<question>"
securityAnswer
String
Answer to the security question.
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.
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 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/loginSf Content-Type: application/json Accept: application/json { "@type": "loginSf", "sfSessionId": "00Df40000000coF!ARYAQDO2SvoD3eRXOrNaiOb9a3Pp", "sfServerUrl": "https://c.na41.visual.force.com/services/Soap/u/27.0/00Df40000000coF" }
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": "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": "JohnR", "firstName": "John", "lastName": "Randall", "title": "IICS Admin", "password": "**********", "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." } ], "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


Updated May 03, 2021