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

Creating and deleting users

Creating and deleting users

If you have administrator privileges, you can use the users resource to create or delete a user.

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:
Field
Type
Required
Description
name
String
Yes
Informatica Intelligent Cloud Services
user name.
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:
POST <baseApiUrl>/public/core/v3/users Content-Type: application/json Accept: application/json INFA-SESSION-ID: <sessionId> { "name" : "c@abc.com", "firstName" : "c", "lastName" : "smith", "email" : "c@abc.com", "authentication" : 0, "roles" : ["5IPgtye09EbiWqz5XXuzwC", "9gedBDoYQoQibNMohf5KCh"], "groups" : ["a6x85hoMvH2kWUIlcIRBEh"] }
You might receive a response similar to the following example:
{ "id": "9EcgvBYZ9GGflOYr98GzOH", "orgId": "cPYWk02I4aBeuLEvYRtaMS", "createdBy": "a@abc.com", "updatedBy": "a@abc.com", "createTime": "2020-08-20T18:29:19.987Z", "updateTime": "2020-08-20T18:29:20.653Z", "userName": "c@abc.com", "firstName": "c", "lastName": "smith", "description": null, "title": "dev", "phone": null, "email": "c@abc.com", "state": "Provisioned", "timeZoneId": "America/Los_Angeles", "maxLoginAttempts": "10", "authentication": "Native", "forcePasswordChange": false, "lastLoginTime": null, "lastLoginMode": "None", "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>
For example, you might send a request similar to the following example:
DELETE <baseApiUrl>/public/core/v3/users/5N9JGth6pRYfOGdGKv3Q2D


Updated May 03, 2021