UserGroups

Use this resource to create and delete user groups.

Use the userGroups resource along with the users 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 users and roles REST API resources, see the following topics:

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

GET request

You can request the details for all user groups in the organization or request the details for a particular user group.

To get user group details, use the following URI:

/public/core/v3/userGroups

To get the details for a particular user group, 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:
userGroupId. Unique
identifier for the user group.
userGroupName. Name of the user group.

limit

Int

Maximum number of user groups to return.
Default is 100

skip

Int

Amount to offset the list of results.
Default is 0.

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

public/core/v3/userGroups?q=userGroupName=="group_a"

GET response

If successful, returns the following information for each user group:

Field

Type

Description

id

String

User group ID.

orgId

String

ID of the organization the user group 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 group was created.

updateTime

String

Date and time the user group was last updated.

userGroupName

String

Name of the user group.

description

String

Description of the user group.

roles

String

Roles assigned to the user group.

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.

users

String

Users assigned to the user group.

id

String

Included in the users object.
User ID.

userName

String

Included in the users object.
User name

description

String

Included in the users object.
Description of the user.

GET response example

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

[
    {
        "id": "a6x85hoMvH2kWUIlcIRBEh",
        "orgId": "cPYWk02I4aBeuLEvYRtaMS",
        "createdBy": "[email protected]",
        "updatedBy": "[email protected]",
        "createTime": "2019-03-19T17:27:09.000Z",
        "updateTime": "2019-03-19T17:27:09.000Z",
        "userGroupName": "group_a",
        "description": "",
        "roles": [
            {
                "id": "9gedBDoYQoQibNMohf5KCh",
                "roleName": "Admin",
                "description": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
            }
        ],
        "users": [
            {
                "id": "5N9JGth6pRYfOGjGKv3Q2D",
                "userName": "[email protected]",
                "description": ""
            }
        ]
    }
]

POST request

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

/public/core/v3/userGroups

Note
The number of users, user groups, and roles combined cannot exceed 1000 for an organization.

Field

Type

Required

Description

name

String

Yes

Name of the user group.

description

String

Description of the user group.

roles

Array

Yes

IDs of the roles to assign to the user group.

users

Array

IDs of the users to assign to the user group.

POST response

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

POST example

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

POST <baseApiUrl>/public/core/v3/userGroups
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "name" : "user_group_1",
    "roles" : ["5IPgtye09EbiWqz5XXuzwC", "9gedBDoYQoQibNMohf5KCh"],
    "users" : ["9EcgvBYZ9GGflOYr98GzOH"]
}
{
    "id": "0TLmCMwX0jNdJ5SzlQC2CW",
    "orgId": "cPYWk02I4aBeuLEvYRtaMS",
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "createTime": "2019-03-20T18:30:32.457Z",
    "updateTime": "2019-03-20T18:30:32.472Z",
    "userGroupName": "user_group_1",
    "description": null,
    "roles": [
        {
            "id": "9gedBDoYQoQibNMohf5KCh",
            "roleName": "Admin",
            "description": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
        },
        {
            "id": "5IPgtye09EbiWqz5XXuzwC",
            "roleName": "test_user_1",
            "description": ""
       }
    ],
    "users": [
        {
            "id": "9EcgvBYZ9GGflOYr98GzOH",
            "userName": "test_user_2",
            "description": null
        }
    ]
}

You might receive a response similar to the following example:

DELETE request

To delete a user group, use the following URI:

/public/core/v3/userGroups/<user group Id>