Search Granted Project Roles

GET 
https://$CUSTOM-DOMAIN/management/v1/granted_projects/:projectId/grants/:grantId/roles/_search

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

Request

Path Parameters

projectId stringrequired
grantId stringrequired

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

200

A successful response.

application/json

Schema

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 (string)

displayName string

group string

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2025-03-05T15:24:30.833Z"
  },
  "result": [
    {
      "key": "role.super.man",
      "details": {
        "sequence": "2",
        "creationDate": "2025-03-05T15:24:30.833Z",
        "changeDate": "2025-03-05T15:24:30.833Z",
        "resourceOwner": "69629023906488334"
      },
      "displayName": "Super man",
      "group": "people"
    }
  ]
}

application/grpc

Schema

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 (string)

displayName string

group string

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2025-03-05T15:24:30.834Z"
  },
  "result": [
    {
      "key": "role.super.man",
      "details": {
        "sequence": "2",
        "creationDate": "2025-03-05T15:24:30.834Z",
        "changeDate": "2025-03-05T15:24:30.834Z",
        "resourceOwner": "69629023906488334"
      },
      "displayName": "Super man",
      "group": "people"
    }
  ]
}

application/grpc-web+proto

Schema

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 (string)

displayName string

group string

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2025-03-05T15:24:30.834Z"
  },
  "result": [
    {
      "key": "role.super.man",
      "details": {
        "sequence": "2",
        "creationDate": "2025-03-05T15:24:30.834Z",
        "changeDate": "2025-03-05T15:24:30.834Z",
        "resourceOwner": "69629023906488334"
      },
      "displayName": "Super man",
      "group": "people"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/management/v1/granted_projects/:projectId/grants/:grantId/roles/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/management/v1

Auth

Bearer Token

Parameters

projectId — pathrequired

grantId — pathrequired

query.offset — query

query.limit — query

query.asc — query

---truefalse

x-zitadel-orgid — header

ResponseClear

Click the Send API Request button above and see the response here!