Get all group memberships for the app

Prev Next
Get
/sys/v1/apps/{app_id}/groups

Get all group memberships for the app

Path parameters
app_id
string (uuid) Required
Query parameters
GetGroupsParams
limit
integer
filter
string

If specified, only groups matching this filter are returned.

The following fields can be referenced in the filter:

  • name
  • created_at
  • description
  • wrapping_key_name
offset
integer

Number of groups to skip

continuation_token
string

Continuation token to continue getting results. It must be the same token returned from the backend from a previous call, or empty.

Existence of this query parameter controls the response (and the backend behavior):

  • If specified (including an empty value), the backend returns metadata alongside the collection of groups. The metadata will potentially contain a fresh continuation_token.

Note: If there is a limit specified in the request and DSM returns limit-many items in the response, it will still include a fresh continuation token if there are more items in the collection. Additionally, unlike other query parameters, limit is not required to remain unchanged in a chain of requests with coninutation_tokens.

  • If omitted, the backend returns just a collection of groups with no metadata.
OneOf
GroupSortVariantByGroupId
object (GroupSortVariantByGroupId)
sort_by
string
Pattern^group_id:(?:asc|desc)$
Examplegroup_id:asc
previous_id
string (uuid) Required
GroupSortVariantByGroupName
object (GroupSortVariantByGroupName)
sort_by
string
Pattern^group_name:(?:asc|desc)$
Examplegroup_name:asc
previous_sort_value
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
Responses
2XX

Success result

Expand All
object
metadata
object
all_groups
boolean

Whether the entity has been assigned an exclusive "all groups role"

items
Array of object (AppGroupMembership)

The collection of group memberships the entity is a member in

object
group_id
string (uuid)
roles
Array of object (AppGroupRoleDescriptor)
OneOf
object
object
$type
string
Valid values[ "SystemDefined" ]
value
string
Valid values[ "GroupAuditor", "GroupAdministrator" ]
object
object
$type
string
Valid values[ "Custom" ]
value
string (uuid)