Project Grant By ID
GET/projects/:projectId/grants/:grantId
Returns a project grant. A project grant is when the organization grants its project to another organization.
Request​
Path Parameters
Header Parameters
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
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
projectGrant
object
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
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
  "projectGrant": {
    "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": "2024-07-31T12:22:59.022Z",
      "changeDate": "2024-07-31T12:22:59.022Z",
      "resourceOwner": "69629023906488334"
    }
  }
}
- Schema
- Example (from schema)
Schema
projectGrant
object
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
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
  "projectGrant": {
    "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": "2024-07-31T12:22:59.022Z",
      "changeDate": "2024-07-31T12:22:59.022Z",
      "resourceOwner": "69629023906488334"
    }
  }
}
- Schema
- Example (from schema)
Schema
projectGrant
object
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
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
{
  "projectGrant": {
    "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": "2024-07-31T12:22:59.023Z",
      "changeDate": "2024-07-31T12:22:59.023Z",
      "resourceOwner": "69629023906488334"
    }
  }
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}