Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.

Table of Contents

Search

  1. Preface
  2. IDMC REST API
  3. REST API resource quick references
  4. Platform REST API version 2 resources
  5. Platform REST API version 3 resources
  6. Data Integration REST API
  7. Cloud Data Integration for PowerCenter (CDI-PC) REST API
  8. Data Ingestion and Replication REST API
  9. RunAJob utility
  10. ParamSetCli utility
  11. REST API codes

REST API Reference

REST API Reference

Logging in

Logging in

Use this resource to log into
IDMC
when you use resources that require the IDS-SESSION-ID in the call header. The IDS-SESSION-ID is included in a successful login response.

POST request

Use the following URL:
<login URL>/identity-service/api/v1/Login
The login URL includes the region where your organization is located and the
IDMC
domain, informaticacloud.com. You can find your organization's login region by opening the
IDMC
log in page. The regional login URL is located in the browser's address bar before you log in to
IDMC
.
In the following example, https://dm-us.informaticacloud.com, is the region URL:
https://dm-us.informaticacloud.com/identity-service/home
The following table describes the fields to include in the request:
Field
Type
Required
Description
username
String
Yes
IDMC
user name.
Maximum length is 255 characters.
password
String
Yes
IDMC
password.
Maximum length is 255 characters.

POST response

Returns the user object if the request is successful. Returns the error object if errors occur.
Use the session ID returned in the response for subsequent requests.
The user object includes the following attributes:
Field
Type
Description
sessionId
String
REST API session ID for the current session. Use in most REST API request headers.
sessionExpireTime
String
Time the session expires.
id
String
User ID.
name
String
IDMC
user name.
currentOrgId
String
Current organization ID.
currentOrgName
String
Name of the current organization.
parentOrgId
String
ID of the parent organization.
orgId
String
ID of the organization the user belongs to.
orgName
String
Name of the organization the user belongs to.
groups
String
User group.
effectiveRoles
String
Roles assigned to the user.
effectivePrivileges
String
Privileges assigned to the user.
status
String
Status of the user.
timeZoneId
String
Time zone of the user. Time zone honors Daylight Saving Time. For more information, see Time zone codes.
authenticator
String
User authentication method.

0 COMMENTS

We’d like to hear from you!