Use the users resource to request Informatica Intelligent Cloud Services user details, create users, update role and user group assignments, and delete users.
Note: This resource uses a dynamic rate limit. When the system experiences a large volume or size of requests, responses might be slow or fail with the error message, "too many requests."
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:
For general information about users, user groups, and roles, see the Administrator help.
Getting user details
Use the users resource to request Informatica Intelligent Cloud Services user details. You can request the details for all users in the organization or request the details for a particular user.
GET request
To get user details, use the following URI:
/public/core/v3/users
To get the details for a particular user, you can include the following query parameters in the URI:
Parameter
Type
Description
q
String
Query filter. You can filter using one of the following fields:
- userId. Unique identifier for the user.
- userName. Informatica Intelligent Cloud Services user name.
limit
Int
Maximum number of users to return.
Maximum of 200. Default is 100.
skip
Int
Amount to offset the list of results.
Default is 0.
For example, to get details for a particular user based on the user's ID, you might use the following request:
If you have administrator privileges, you can use the users resource to create a user.
POST request
To create a user, send a POST request using the following URI:
/public/core/v3/users
Note: The number of users, user groups, and roles combined cannot exceed 1000 for an organization.
Include the following information:
Field
Type
Required
Description
name
String
Yes
Informatica Intelligent Cloud Services user name. Must be either a valid email address or contain only alphanumeric characters, hyphens, underscores, periods, and apostrophes.
Maximum length is 255 characters.
firstName
String
Yes
First name for the user account.
lastName
String
Yes
Last name for the user account.
password
String
-
Informatica Intelligent Cloud Services password.
If password is empty, the user receives an activation email.
Maximum length is 255 characters.
description
String
-
Description of the user.
email
String
Yes
Email address for the user.
title
String
-
Job title of the user.
phone
String
-
Phone number for the user.
forcePasswordChange
Boolean
-
Determines whether the user must reset the password after the user logs in for the first time.
maxLoginAttempts
Int
-
Number of times a user can attempt to log in before the account is locked.
authentication
Int
-
Determines whether the user accesses Informatica Intelligent Cloud Services through single sign-in (SAML).
Use one of the following values:
- 0. Native.
- 1. SAML.
aliasName
String
Required when authentication is not 0.
The user identifier or user name in the 3rd party system.
roles
Array
Required when no group IDs are included.
IDs of the roles to assign to the user.
groups
Array
Required when no role IDs are included.
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:
You can add or remove role assignments for a user.
You cannot update a user's role assigments if your organization enabled the Map SAML Groups and Roles option for SAML single sign-on. For more information, see User Administration in the Administrator help.
Assign roles
To assign a role to a user, send a PUT request using one of the following URIs:
/public/core/v3/users/<user ID>/addRoles
/public/core/v3/users/name/<user name>/addRoles
Include an array of the roles that you want to assign to the user.
For example, to assign the Admin and Business Manager roles to a user, you might use the following request:
You can add or remove user group assignments for a user.
You cannot update a user's user group assignments if your organization enabled the Map SAML Groups and Roles option for SAML single sign-on. For more information, see User Administration in the Administrator help.
Assign user groups
To assign a user group to a user, send a PUT request using one of the following URIs:
/public/core/v3/users/<user ID>/addGroups
/public/core/v3/users/name/<user name>/addGroups
Include an array of the user groups that you want to assign to the user.
For example, to assign the Workflow Manager and MDM Admin user groups to a user, you might use the following request: