List groups

Lists the groups accessible to the current user. Each group includes the contracts related to that group, as well as your permissions of READ, WRITE, ADD, or DELETE zone on that group.

Query Params
integer
required

The currently selected group ID to manage.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Response

Response body
object
groups
array of objects
required

A customer group and associated permissions.

groups*
object
contractIds
array of strings
required

Contract IDs that this group contains.

contractIds*
integer
required

The group ID.

string
required

The name of this group.

permissions
array of strings
required

Permissions that the current user has on this group: ADD, DELETE, READ, and WRITE.

permissions*
Language
Authentication
URL