API Reference

Search user groups

get
https://{host}/platform/security/v1/groups
Query Params
integer
Defaults to 0

Number of page displaying the returned records, starting 0

integer
Defaults to 100

Number of records returned per page. See Response Pagination.

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

string of strings

Name of API key or login of principal, e.g. [email protected] or [email protected] for federated tenants. Login strings are lowercase. See Logins.

include
array of strings

List of subnodes to return. One or more of groupDetails, roles, usernames. By default, no subnodes are returned

include
Allowed:
string
enum
Defaults to enabled

Status of user group. One of enabled, disabled.

Allowed:
Responses

Updated about 6 hours ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 6 hours ago

Did this page help you?