GuidesAPI Reference
API Reference

Get groups

get
https://Use API Lookup for a base URL/groups

Retrieve the list of groups within the realm associated with the calling party.


Access Control:

  • The calling principal must have "readMembers" action permission for the calling party "{realm}" in the "authorization" service.
  • The calling principal MUST NOT include a project scope.
Query Params
string

The cursor for pagination. Present only if there is an additional page of data to view.

integer
0 to 100
Defaults to 100

Number of records to return. Default is 100 records. Maximum is 100 records.

string

A free text query string used to filter the results. A search against groups in the realm will consider the 'id', 'name', and 'description' fields of the groups. The precise search algorithm used to match groups is not specified, but generally any member where one of the considered fields has a full or partial match should be included in the results.

Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago