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.

Use the users resource along with the userGroups and roles resources to manage user privileges for Informatica Intelligent Cloud Services tasks and assets. Users and groups can perform tasks and access assets based on the roles that you assign to them.
For information about using the userGroups and roles REST API resources, see the following topics:

  • roles
  • userGroups
    For general information about users, user groups, and roles, see the Administrator help.

GET request

You can request the details for all users in the organization or request the details for a particular user.
To get user details, use the following URI
To get the details for a particular user, you can include the following query parameters in the URI:

/public/core/v3/users
ParameterTypeDescription
qStringQuery filter. You can filter using one of the following fields:
userId. Unique identifier for the user.
userName. Informatica Intelligent Cloud Services user name.
limitIntMaximum number of users to return.
Maximum of 200. Default is 100.
skipIntAmount to offset the list of results.
Default is 0.

For example, to get details for a particular user using the user's ID, you might use the following request:

/public/core/v3/users?q=userId==5N9JGth6pRYfOGjGKv3Q2D &limit=1 &skip=0

GET response

If successful, returns the following information for each user:

FieldTypeDescription
IdStringUser ID.
orgStringID of the organization the user belongs to.
createdByStringUser who created the user account.
updatedByStringUser who last updated the user account.
createTimeStringDate and time the user was created.
updatetimeStringDate and time the user was last updated.
userNameStringUser name for the user account.
firstNameStringFirst name for the user account.
lastNameStringLast name for the user account.
descriptionStringUser description.
titleStringJob title of the user.
phoneStringPhone number for the user.
emailStringEmail address for the user.
stateStringState of the user account. Returns one of the following values:
Active. User account exists and user has activated the account.
Provisioned. User account exists but the user has not activated the account.
Disabled. User account is disabled because the user exceeded the maximum number of login attempts.
timeZoneIdStringTime zone of the user.
For more information, see Time zone codes.
maxLoginAttemptsIntNumber of times a user can attempt to log in before the account is locked
authenticationWhether the user accesses Informatica Intelligent Cloud Services through single sign-in (SAML).
Returns one of the following values:
- 0. Native.
- 1. SAML.
forcePasswordChangeBooleanWhether the user must reset the password after the user logs in for the first time
rolesArrayRoles assigned to the user account.
idStringIncluded in the roles object.
Role ID.
roleNameStringIncluded in the roles object.
Role name.
descriptionStringIncluded in the roles object.
Description of the role.
groups ArrayGroup in which the user account is a member.
idStringIncluded in the groups object.
User group ID.
userGroupNameStringIncluded in the groups object.
User group name.
descriptionStringIncluded in the groups object.
Description of the user group.

GET response example

If successful, you might receive a response similar to the following example:

[
    {
        "id": "5N9JGth6pRYfOGjGKv3Q2D",
        "orgId": "cPYWk02I4aBeuLEvYRtaMS",
        "createdBy": "ma",
        "updatedBy": "[email protected]",
        "createTime": "2019-03-06T22:04:00.000Z",
        "updateTime": "2019-03-18T22:34:53.000Z",
        "userName": "[email protected]",
        "firstName": "a",
        "lastName": "jones",
        "description": "",
        "title": "dev",
        "phone": "1112221111",
        "email": "[email protected]",
        "state": "Enabled",
        "timeZoneId": "America/Los_Angeles",
        "roles": [
            {
                "id": "9c2XrdpAz80hg29yXDBPEN",
                "roleName": "Data Preview",
                "description": "Role to preview data"
            },
            {
                "id": "1VfnsgZiCT1fi25VAupQg1",
                "roleName": "Designer",
                "description": "Role for creating assets, ... and runtime environments. Has access to the Application Integration Console."
            }
        ],
        "groups": [
            {
                "id": "a6x85hoMvH2kWUIlcIRBEh",
                "userGroupName": "group_a",
                "description": ""
            }
        ]
    },
    {
        "id": "aNJWtppg613c1YbXvRRHcV",
        "orgId": "cPYWk02I4aBeuLEvYRtaMS",
        "createdBy": "[email protected]",
        "updatedBy": "[email protected]",
        "createTime": "2019-03-13T20:15:58.000Z",
        "updateTime": "2019-03-13T20:15:58.000Z",
        "userName": "[email protected]",
        "firstName": "b",
        "lastName": "smith",
        "description": "",
        "title": "cs",
        "phone": "1112223333",
        "email": "[email protected]",
        "state": "Provisioned",
        "timeZoneId": "America/Los_Angeles",
         "roles": [
            {
                "id": "9c2XrdpAz80hg29yXDBPEN",
                "roleName": "Data Preview",
                "description": "Role to preview data"
            }
        ],
        "groups": [
            {
                "id": "a6x85hoMvH2kWUIlcIRBEh",
                "userGroupName": "group_a",
                "description": ""
            }
        ]
    }
]

POST request

To create a user, send a POST request using the following URI:

/public/core/v3/users

The number of users, user groups, and roles combined cannot exceed 1000 for an organization.
Include the following information:

FieldTypeRequiredDescription
nameStringYesInformatica Intelligent Cloud Services user name.
Maximum length is 255 characters.
firstNameStringYesFirst name for the user account.
lastNameStringYesLast name for the user account
passwordString-Informatica Intelligent Cloud Services password.
If password is empty, the user receives an activation email.
Maximum length is 255 characters.
descriptionString-Description of the user.
emailStringYesEmail address for the user.
titleString-Job title of the user.
phoneStringPhone number for the user.
forcePasswordChangeBoolean-Determines whether the user must reset the password after the user logs in for the first tim
maxLoginAttemptsInt-Number of times a user can attempt to log in before the account is locked
authenticationInt-Determines whether the user accesses Informatica Intelligent Cloud Services through single sign-in (SAML).
Use one of the following values:
- 0. Native.
- 1. SAML.
aliasNameStringMandatory when authentication is not 0The user identifier or user name in the 3rd party system
rolesArrayYesIDs of the roles to assign to the user.
groupsArray-IDs of the user groups to assign to the user.

POST response

If successful, returns the users object with the details you included in the POST request.

POST example

To create a user, you might send a request similar to the following example:

POST <baseApiUrl>/public/core/v3/users
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "name" : "[email protected]",
    "firstName" : "c",
    "lastName" : "smith",
    "email" : "[email protected]",
    "authentication" : 0,
    "roles" : ["5IPgtye09EbiWqz5XXuzwC", "9gedBDoYQoQibNMohf5KCh"],
    "groups" : ["a6x85hoMvH2kWUIlcIRBEh"]
}

You might receive a response similar to the following example:

{
    "id": "9EcgvBYZ9GGflOYr98GzOH",
    "orgId": "cPYWk02I4aBeuLEvYRtaMS",
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "createTime": "2019-03-20T18:29:19.987Z",
    "updateTime": "2019-03-20T18:29:20.653Z",
    "userName": "[email protected]",
    "firstName": "c",
    "lastName": "smith",
    "description": null,
    "title": "dev",
    "phone": null,
    "email": "[email protected]",
    "state": "Provisioned",
    "timeZoneId": "America/Los_Angeles",
    "roles": [
        {
            "id": "5IPgtye09EbiWqz5XXuzwC",
            "roleName": "test",
            "description": ""
        },
        {
            "id": "9gedBDoYQoQibNMohf5KCh",
            "roleName": "Admin",
            "description": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
        }
    ],
    "groups": [
        {
            "id": "a6x85hoMvH2kWUIlcIRBEh",
            "userGroupName": "group_a",
            "description": ""
        }
    ]
}

DELETE request

To delete a user account, use the following URI:

/public/core/v3/users/<userId>

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:

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.
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.
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
forceChangePasswordDetermines 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

FieldTypeRequiredDescription
orgIdStringYesID of the organization the user will belong to.
6 characters.
nameStringYesInformatica Intelligent Cloud Services user name.
passwordStringYes, 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.
firstnameStringYesFirst name for the user account.
lastnameStringYesLast name for the user account
titleStringTitle of the user.
phoneStringPhone number for the user.
emailStringEmail address to be notified when the user changes the account password.
descriptionStringDescription of the user.
timezoneStringTime 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.
securityQuestionStringSecurity 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:""
securityAnswerStringAnswer to the security question.
rolesStringRole for the user. Use one of the following codes:
- Service Consumer
- Designer
- Admin
forceChangePasswordStringDetermines 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>