Add Project Grant

POST 
https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/grants

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Deprecated: use CreateProjectGrant instead.

Grant a project to another organization. The project grant will allow the granted organization to access the project and manage the authorizations for its users. Project Grant will be listed in the granted project of the granted organization.

Request

Path Parameters

projectId stringrequired

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.

application/json

Bodyrequired

grantedOrgIdstring
Example: 28746028909593987
roleKeysstring[]
Example: ["RoleKey1","RoleKey2"]

application/grpc

Bodyrequired

grantedOrgIdstring
Example: 28746028909593987
roleKeysstring[]
Example: ["RoleKey1","RoleKey2"]

application/grpc-web+proto

Bodyrequired

grantedOrgIdstring
Example: 28746028909593987
roleKeysstring[]
Example: ["RoleKey1","RoleKey2"]

Responses

200

A successful response.

application/json

Schema

Schema

grantIdstring
Example: 28746028909593987
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "grantId": "28746028909593987",
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

Schema

Schema

grantIdstring
Example: 28746028909593987
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "grantId": "28746028909593987",
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

Schema

Schema

grantIdstring
Example: 28746028909593987
details object
sequenceuint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
Example: 2
creationDatedate-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDatedate-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwnerresource_owner is the organization an object belongs to (string)
Example: 69629023906488334

Example (auto)

{
  "grantId": "28746028909593987",
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "changeDate": "2024-07-29T15:51:28.071Z",
    "resourceOwner": "69629023906488334"
  }
}

default

An unexpected error response.

application/json

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

application/grpc-web+proto

Schema

Schema

codeint32
messagestring
details object[]
Array [
@typestring
]

Example (auto)

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

Authorization: oauth2

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

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

Auth

Bearer Token

Parameters

projectId — pathrequired

x-zitadel-orgid — header

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "grantedOrgId": "28746028909593987",
  "roleKeys": [
    "RoleKey1",
    "RoleKey2"
  ]
}

ResponseClear

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