User

Use this resource to request Informatica Intelligent Cloud Services user details. If you have administrator privileges, you can also use this resource to create or delete a user.

V2 / User

Use this resource to request the details of an Informatica Intelligent Cloud Services user account or the details of all user accounts in the organization. If you have administrator privileges, you can also use this resource to create or update a user account and to delete a user account. To ensure organization security, this resource does not display or update the password for a user account.

Note
To leverage full user management capabilities, use the version 3 users resource instead of the version 2 user resource. The version 3 users resource supports users, user groups, and roles. The version 2 user resource does not support user groups and roles, and a GET request might not return all users in the organization

GET Request

To request the details of all Informatica Intelligent Cloud Services user accounts, use the following URI:

/api/v2/user

To request the details of a particular Informatica Intelligent Cloud Services user account, you can include the user account ID or user name in the URI. Use one of the following URIs

/api/v2/user/<id>
/api/v2/user/name/<name>

If you use the user name in the URI and the user name includes a space, replace the space with %20. For example:

/api/v2/user/name/Fred%20Smith

GET Response

When you request the details for a user account, Informatica Intelligent Cloud Services returns the user object for the requested user account. When you request the details of all user accounts, Informatica Intelligent Cloud Services returns the user object for each user account in the organization.
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

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 Request

You must be logged in as an administrator in order to create users or update user details. To update the details of an existing user account, use the user account ID in the following URI.

/api/v2/user/<id>

To create a new Informatica Intelligent Cloud Services user account, omit the optional user account ID in the URI.
To create a SAML single sign-on user account, do not include password.
You can use the following attributes in a user object

Field

Type

Required

Description

orgId

String

Yes

ID of the organization the user will belong to.
6 characters.

name

String

Yes

Informatica Intelligent Cloud Services user name.

password

String

Yes, unless the user is a SAML single sign-on user.

Informatica Intelligent Cloud Services password.
Do not include if the user is a SAML single sign-on user and the organization is SAML enabled.

firstname

String

Yes

First name for the user account.

lastname

String

Yes

Last name for the user account

title

String

Title of the user.

phone

String

Phone number for the user.

email

String

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

description

String

Description of the user.

timezone

String

Time zone of the user. Time zone honors Daylight Saving Time. Use the appropriate time zone code.
If no valid time zone is passed, Informatica Intelligent Cloud Services uses America/Los_Angeles by default.
For more information, see Time zone codes.

securityQuestion

String

Security question. Use one of the following codes to select the security question:

  • 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

Role for the user. Use one of the following codes:

  • Service Consumer
  • Designer
  • Admin

forceChangePassword

String

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 Response

Returns the user response object for the requested user account. Or, if you requested information for all user accounts, returns the user response object for each user account in the organization.
Returns an error object if errors occur.Returns the user response object for the requested user account. Or, if you requested information for all user accounts, returns the user response object for each user account in the organization.
Returns an error object if errors occur.

DELETE Request

To delete a user, use the user account ID in the following URI.

/api/v2/user/<id>

DELETE Response

Returns the 200 response code if the request is successful.
Returns an error object if errors occur.

POST Example

To create a new user, you might use the following request:

POST <serverUrl>/api/v2/user/ 
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<user>
 <orgId>00342000</orgId>
 <name>[email protected]</name>
 <firstName>User</firstName>
 <lastName>Name</lastName>
 <title>developer</title>
 <timeZone>America/Chicago</timeZone>
</user>