API Reference
Start typing to search…

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

Name of principal

include
array of strings

Array of subnodes (multi-valued) to be returned. By default, no subnodes are returned

include
string
Defaults to enabled

Status of this group. One of enabled, disabled.

Responses

Response body
object
int64

Number of records matching filter query.

searchItems
array of objects

List of user groups matching query filter.

searchItems
object
string

Name of group.

string

ID of group.

string

Status of group.

enabled disabled

groupDetails
object

Information about group.

users
array of objects

List of users.

users
object
string

Name of user.

string

Status of user.

string

Type of user.

User Apikey

roles
array of objects

List of user roles.

roles
object
string

Name of role.

string

ID of role.

string | null

Name of tenant.

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
Request

Updated 5 months ago

Did this page help you?