Getting a list of user groups

Execution permission

You must be a system administrator or a security administrator.

Request line

GET base-URL/security/v1/user-groups

Request message

Object ID

None.

Query parameters

Parameter	Type	Filter condition
search	string	String that must be included in the name of the user group

Body

None.

Response message

Body

[
    {
        "id": "caf4dd60-5213-430a-907c-17c98c3dca5e",
        "name": "opscenter-administrators",
        "path": "/opscenter-administrators",
        "dn": null,
        "description": null,
        "builtin": true,
        "essential": false,
        "external": false
    }
]

Attribute	Type	Description
id	string	Object ID of the user group
name	string	User group name
path	string	Path
dn	string	Distinguished Name If the group is not a group imported from the Active Directory server, the value null is always returned.
description	string	Description of the user group
builtin	boolean	Whether the user group is a built-in user group true: The user group is a built-in user group. false: The user group is not a built-in user group.
essential	boolean	Whether the user group is an essential user group (opscenter-users) true: The user group is an essential user group. false: The user group is not an essential user group.
external	boolean	Whether the user group was imported from an external source true: The user group was imported from an external source. false: The user group was not imported from an external source.

Coding example

When no query parameter is specified:

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

When a query parameter is specified:

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