Getting a list of users who belong to a specific user group

Execution permission

You must be a system administrator or a security administrator.

Request line

GET base-URL/security/v1/user-groups/object-ID-of-the-user-group/users

Request message

Object ID of the user group

Specify the value of id acquired by using the request for getting information about a list of user groups.

Attribute	Type	Description
id	string	(Required) Object ID of the user group

Query parameters

None.

Body

None.

Response message

Body

[
    {
        "id": "a010279b-ae66-4c1d-b066-c45d50c9f75a",
        "username": "sysadmin",
        "firstName": "firstName",
        "lastName": null,
        "email": "sysadmin@example.com",
        "dn": null,
        "description": "Built-in user",
        "enabled": true,
        "builtin": true
    }
]

Attribute	Type	Description
id	string	Object ID of the user
username	string	Username
firstName	string	First name of the user
lastName	string	Last name of the user
email	string	Email address
dn	string	Distinguished Name If the user is not an Active Directory user, the value null is always returned.
description	string	Description of the user account
enabled	boolean	Whether the user account is enabled true: The user account is enabled. false: The user account is disabled.
builtin	boolean	Whether the user is a built-in user true: The user is a built-in user. false: The user is not a built-in user.

Coding example

curl -v -X GET -s "https://example.com:443/portal/security/v1/user-groups/4760d4c0-c593-42fe-b44a-553da4793882/users" -H "Authorization:Bearer eyJhbxxx"