Getting a list of users

Execution permission

You must be a system administrator or a security administrator.

Request line

GET base-URL/security/v1/users

Request message

Object ID

None.

Query parameters

Parameter	Type	Filter condition
search	string	String that must be included in the username, first name, last name, or email address of the user.

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,
        "federatedIdentities": null
    },
    {
        "id": "82576381-e765-4645-a697-782111f8f5b5",
        "username": "user_1",
        "firstName": "1",
        "lastName": "user",
        "email": "user_1@example.com",
        "dn": null,
        "description": "description user_1",
        "enabled": true,
        "builtin": false,
        "federatedIdentities": [
            {
                "alias": "dummy_alias",
                "displayName": "DUMMY DISPLAY NAME"
            }
        ]
    }
]

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 a user imported from an Active Directory or LDAP server, 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.
federatedIdentities	object	Identity provider information If the user is not an identity provider user, null is always returned.
alias	string	Alias name that identifies the identity provider This is displayed when the user is an identity provider user.
displayName	string	Display name of the identity provider This is displayed when the user is an identify provider user.

Coding example

When no query parameter is specified:

curl -v -X GET -s "https://example.com:443/portal/security/v1/users" -H "Authorization:Bearer eyJhbxxx"

When a query parameter is specified:

curl -v -X GET -s "https://example.com:443/portal/security/v1/users?search=smith" -H "Authorization:Bearer eyJhbxxx"