REST API Reference

Back Next

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:

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

GET response

If successful, returns the following information for each user:

Field	Type	Description
id	String	User ID.
orgId	String	ID of the organization the user belongs to.
createdBy	String	User who created the user account.
updatedBy	String	User who last updated the user account.
createTime	String	Date and time the user was created.
updateTime	String	Date and time the user was last updated.
userName	String	User name for the user account.
firstName	String	First name for the user account.
lastName	String	Last name for the user account.
description	String	User description.
title	String	Job title of the user.
phone	String	Phone number for the user.
email	String	Email address for the user.
state	String	State 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. If the user's password is expired, the value is null.
timeZoneId	String	Time zone of the user. For more information, see Time zone codes.
maxLoginAttempts	Int	Number of times a user can attempt to log in before the account is locked.
authentication	String	Whether the user accesses Informatica Intelligent Cloud Services through single sign-in (SAML). Returns one of the following values: 0. Native. 1. SAML.
forcePasswordChange	Boolean	Whether the user must reset the password after the user logs in for the first time.
lastLoginTime	String	The date and time that the user last logged in.
lastLoginMode	String	Whether the user logged in through a REST API call or through the UI.
roles	Array	Roles assigned to the user account.
id	String	Included in the roles object. Role ID.
roleName	String	Included in the roles object. Role name.
description	String	Included in the roles object. Description of the role.
displayName	String	Included in the roles object. Role name that is displayed in the user interface.
displayDescription	String	Included in the roles object. Role description that is displayed in the user interface.
groups	Array	Group in which the user account is a member.
id	String	Included in the groups object. User group ID.
userGroupName	String	Included in the groups object. User group name.
description	String	Included 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": "a@abc.com",
        "createTime": "2019-03-06T22:04:00.000Z",
        "updateTime": "2019-03-18T22:34:53.000Z",
        "userName": "a@abc.com",
        "firstName": "a",
        "lastName": "jones",
        "description": "",
        "title": "dev",
        "phone": "1112221111",
        "email": "a@abc.com",
        "state": "Enabled",
        "timeZoneId": "America/Los_Angeles",
        "maxLoginAttempts": "10",
        "authentication": "Native",
        "forcePasswordChange": false,      
        "lastLoginTime": "2020-07-31T21:50:10Z",
        "lastLoginMode": "API",
        "roles": [
            {
                "id": "9c2XrdpAz80hg29yXDBPEN",
                "roleName": "Data Preview",
                "description": "Role to preview data"
                "displayName": "Data Preview",
                "displayDescription": "Role to preview data"
            },
            {
                "id": "1VfnsgZiCT1fi25VAupQg1",
                "roleName": "Designer",
                "description": "Role for creating assets, ... and runtime environments. Has access to the Application Integration Console."
                "displayName": "Designer",
                "displayDescription": "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": "a@abc.com",
        "updatedBy": "a@abc.com",
        "createTime": "2019-03-13T20:15:58.000Z",
        "updateTime": "2019-03-13T20:15:58.000Z",
        "userName": "b@abc.com",
        "firstName": "b",
        "lastName": "smith",
        "description": "",
        "title": "cs",
        "phone": "1112223333",
        "email": "b@abc.com",
        "state": "Provisioned",
        "timeZoneId": "America/Los_Angeles",
        "maxLoginAttempts": "10",
        "authentication": "Native",
        "forcePasswordChange": false,
        "lastLoginTime": "2020-07-31T21:50:10Z",
        "lastLoginMode": "API",
         "roles": [
            {
                "id": "9c2XrdpAz80hg29yXDBPEN",
                "roleName": "Data Preview",
                "description": "Role to preview data"
                "displayName": "Data Preview",
                "displayDescription": "Role to preview data"
            }
        ],
        "groups": [
            {
                "id": "a6x85hoMvH2kWUIlcIRBEh",
                "userGroupName": "group_a",
                "description": ""
            }
        ]
    }
]

Users

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage