GuidesAPI Reference
API Reference

Get the list of members of the Project

get
https://Use API Lookup for a base URL/projects//members

Get the list of members of the Project.

Note: If 'onlyIncludeIdentities' query parameter is set to true, 'total' is NOT returned in Response.


Access Control:

  • The calling principal must have "read" action permission for the resource "{project}" in the "authorization" service.
  • In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins.
  • The calling principal MUST NOT include a project scope.
Path Params
string
required

HRN identifying the project

Query Params
boolean

If true, returns an effective project members list containing only user and app identities, including those that are members of the project indirectly via a group. It will also return users who are project admins of the specified project, and Resource Managers for the realm. Response will NOT include total number of identities. If false, returns users, apps, and groups that are direct members of the project, excluding any users and apps that only have membership via a group. Defaults to false.

Suppose there are a user U and a group G with app A in it. Suppose user U and group G are the members of the project, then

  • onlyIncludeIdentities=true will return U and A
  • onlyIncludeIdentities=false or absent will return U and G
integer
0 to 100
Defaults to 10

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

string

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

Headers
string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated.

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