API Reference

Search user groups

get
https://{host}/platform/security/v1/groups

Returns a list of user groups.

A user group is a collection of Intelligent Risk users. A user group may be assigned one or more roles, which determine the operations and exposure data that members of that user group may perform and access.

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

Login of principal e.g. [email protected] or [email protected] for federated tenants.

include
array of strings

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

include
string
enum
Defaults to enabled

Status of user group. One of enabled, disabled.

Allowed:
Responses

Updated over 1 year ago

Language
Credentials
URL
Request
Response 
 Choose an example:
application/json
Updated over 1 year ago