Skip to main content

Search Granted Project Roles​

Lists the roles a granted projects has. These are the roles, that have been granted by the owner organization to my organization.

Path Parameters
  • projectId string required
  • grantId string required
Query Parameters
  • query.offset uint64
  • query.limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

  • query.asc boolean

    default is descending

Header Parameters
  • x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data.

Responses

A successful response.

Schema
  • details object
  • totalResult uint64
  • processedSequence uint64
  • viewTimestamp date-time

    the last time the view got updated

  • result object[]
  • Array [
  • key string
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
  • displayName string
  • group string
  • ]
GET /granted_projects/:projectId/grants/:grantId/roles/_search

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/management/v1
Bearer Token
projectId — path required
grantId — path required
query.offset — query
query.limit — query
query.asc — query
x-zitadel-orgid — header
Accept
curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/granted_projects/:projectId/grants/:grantId/roles/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'