Get Granted Project By ID

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

Returns a project owned by another organization and granted to my organization. A Project is a vessel for different applications sharing the same role context.

Request

Path Parameters

projectId stringrequired
grantId stringrequired

Header Parameters

x-zitadel-orgid string

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

Responses

200

A successful response.

application/json

Schema

Schema

grantedProject

object

grantId string

grantedOrgId string

grantedOrgName string

grantedRoleKeys string[]

state string

Possible values: [PROJECT_GRANT_STATE_UNSPECIFIED, PROJECT_GRANT_STATE_ACTIVE, PROJECT_GRANT_STATE_INACTIVE]

Default value: PROJECT_GRANT_STATE_UNSPECIFIED

current state of the project grant

projectId string

projectName string

projectOwnerId string

projectOwnerName 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)

Example (from schema)

{
  "grantedProject": {
    "grantId": "69629023906488334",
    "grantedOrgId": "69629023906488334",
    "grantedOrgName": "Some Organization",
    "grantedRoleKeys": [
      "role.super.man"
    ],
    "state": "PROJECT_GRANT_STATE_UNSPECIFIED",
    "projectId": "69629023906488334",
    "projectName": "ZITADEL",
    "projectOwnerId": "69629023906488334",
    "projectOwnerName": "ZITADEL",
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-25T15:37:46.175Z",
      "changeDate": "2025-03-25T15:37:46.175Z",
      "resourceOwner": "69629023906488334"
    }
  }
}

application/grpc

Schema

Schema

grantedProject

object

grantId string

grantedOrgId string

grantedOrgName string

grantedRoleKeys string[]

state string

Possible values: [PROJECT_GRANT_STATE_UNSPECIFIED, PROJECT_GRANT_STATE_ACTIVE, PROJECT_GRANT_STATE_INACTIVE]

Default value: PROJECT_GRANT_STATE_UNSPECIFIED

current state of the project grant

projectId string

projectName string

projectOwnerId string

projectOwnerName 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)

Example (from schema)

{
  "grantedProject": {
    "grantId": "69629023906488334",
    "grantedOrgId": "69629023906488334",
    "grantedOrgName": "Some Organization",
    "grantedRoleKeys": [
      "role.super.man"
    ],
    "state": "PROJECT_GRANT_STATE_UNSPECIFIED",
    "projectId": "69629023906488334",
    "projectName": "ZITADEL",
    "projectOwnerId": "69629023906488334",
    "projectOwnerName": "ZITADEL",
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-25T15:37:46.175Z",
      "changeDate": "2025-03-25T15:37:46.175Z",
      "resourceOwner": "69629023906488334"
    }
  }
}

application/grpc-web+proto

Schema

Schema

grantedProject

object

grantId string

grantedOrgId string

grantedOrgName string

grantedRoleKeys string[]

state string

Possible values: [PROJECT_GRANT_STATE_UNSPECIFIED, PROJECT_GRANT_STATE_ACTIVE, PROJECT_GRANT_STATE_INACTIVE]

Default value: PROJECT_GRANT_STATE_UNSPECIFIED

current state of the project grant

projectId string

projectName string

projectOwnerId string

projectOwnerName 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)

Example (from schema)

{
  "grantedProject": {
    "grantId": "69629023906488334",
    "grantedOrgId": "69629023906488334",
    "grantedOrgName": "Some Organization",
    "grantedRoleKeys": [
      "role.super.man"
    ],
    "state": "PROJECT_GRANT_STATE_UNSPECIFIED",
    "projectId": "69629023906488334",
    "projectName": "ZITADEL",
    "projectOwnerId": "69629023906488334",
    "projectOwnerName": "ZITADEL",
    "details": {
      "sequence": "2",
      "creationDate": "2025-03-25T15:37:46.176Z",
      "changeDate": "2025-03-25T15:37:46.176Z",
      "resourceOwner": "69629023906488334"
    }
  }
}

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' \
-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

x-zitadel-orgid — header

ResponseClear

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