GuidesAPI Reference
API Reference

Search for invitations in a realm

get
https://Use API Lookup for a base URL/realms//invites

Search for invitations in the realm, optionally providing a group.


Access Control:

  • The calling principal must have either "manageInvites" or "readMembers" action permission for the resource "{realm}" in the "authorization" service.
  • The calling principal MUST NOT include a project scope.
Path Params
string
required

HRN identifying the realm

Query Params
string

HRN idenitifying the group to search.

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 invites in the realm will consider the 'firstName', 'lastName', and 'emailAddress' fields of the invites. The precise search algorithm used to match invites is not specified, but generally any invite where one of the considered fields has a full or partial match should be included in the results.

Responses

404

Realm or group not found.

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