User Grant By ID

Returns a user grant per ID. A user grant is a role a user has for a specific project and organization.

Path Parameters

userId string required
grantId string required

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
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

userGrant object
id 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
roleKeys string[]
state string
Possible values: [USER_GRANT_STATE_UNSPECIFIED, USER_GRANT_STATE_ACTIVE, USER_GRANT_STATE_INACTIVE]
Default value: USER_GRANT_STATE_UNSPECIFIED
current state of the user
userId string
userName string
firstName string
lastName string
email string
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
displayName string
display name of the user
orgId string
orgName string
orgDomain string
projectId string
projectName string
projectGrantId string
avatarUrl string
avatar URL of the user
preferredLoginName string
userType string
Possible values: [TYPE_UNSPECIFIED, TYPE_HUMAN, TYPE_MACHINE]
Default value: TYPE_UNSPECIFIED
type of the user (human / machine)
grantedOrgId string
grantedOrgName string
grantedOrgDomain string

{
  "userGrant": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-06-17T09:46:07.853Z",
      "changeDate": "2024-06-17T09:46:07.853Z",
      "resourceOwner": "69629023906488334"
    },
    "roleKeys": [
      "role.super.man"
    ],
    "state": "USER_GRANT_STATE_UNSPECIFIED",
    "userId": "69629023906488334",
    "userName": "gigi-giraffe",
    "firstName": "Gigi",
    "lastName": "Giraffe",
    "email": "gigi@zitadel.com",
    "displayName": "Gigi Giraffe",
    "orgId": "69629023906488334",
    "orgName": "ZITADEL",
    "orgDomain": "zitadel.cloud",
    "projectId": "69629023906488334",
    "projectName": "ZITADEL",
    "projectGrantId": "69629023906488334",
    "avatarUrl": "{your-domain}/assets/v1/avatar-32432jkh4kj32",
    "preferredLoginName": "gigi@zitadel.com",
    "userType": "TYPE_UNSPECIFIED",
    "grantedOrgId": "69629023906488334",
    "grantedOrgName": "ZITADEL",
    "grantedOrgDomain": "zitadel.cloud"
  }
}

Schema

Example (from schema)

---

Schema

userGrant object
id 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
roleKeys string[]
state string
Possible values: [USER_GRANT_STATE_UNSPECIFIED, USER_GRANT_STATE_ACTIVE, USER_GRANT_STATE_INACTIVE]
Default value: USER_GRANT_STATE_UNSPECIFIED
current state of the user
userId string
userName string
firstName string
lastName string
email string
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
displayName string
display name of the user
orgId string
orgName string
orgDomain string
projectId string
projectName string
projectGrantId string
avatarUrl string
avatar URL of the user
preferredLoginName string
userType string
Possible values: [TYPE_UNSPECIFIED, TYPE_HUMAN, TYPE_MACHINE]
Default value: TYPE_UNSPECIFIED
type of the user (human / machine)
grantedOrgId string
grantedOrgName string
grantedOrgDomain string

{
  "userGrant": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-06-17T09:46:07.856Z",
      "changeDate": "2024-06-17T09:46:07.856Z",
      "resourceOwner": "69629023906488334"
    },
    "roleKeys": [
      "role.super.man"
    ],
    "state": "USER_GRANT_STATE_UNSPECIFIED",
    "userId": "69629023906488334",
    "userName": "gigi-giraffe",
    "firstName": "Gigi",
    "lastName": "Giraffe",
    "email": "gigi@zitadel.com",
    "displayName": "Gigi Giraffe",
    "orgId": "69629023906488334",
    "orgName": "ZITADEL",
    "orgDomain": "zitadel.cloud",
    "projectId": "69629023906488334",
    "projectName": "ZITADEL",
    "projectGrantId": "69629023906488334",
    "avatarUrl": "{your-domain}/assets/v1/avatar-32432jkh4kj32",
    "preferredLoginName": "gigi@zitadel.com",
    "userType": "TYPE_UNSPECIFIED",
    "grantedOrgId": "69629023906488334",
    "grantedOrgName": "ZITADEL",
    "grantedOrgDomain": "zitadel.cloud"
  }
}

Schema

Example (from schema)

---

Schema

userGrant object
id 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
roleKeys string[]
state string
Possible values: [USER_GRANT_STATE_UNSPECIFIED, USER_GRANT_STATE_ACTIVE, USER_GRANT_STATE_INACTIVE]
Default value: USER_GRANT_STATE_UNSPECIFIED
current state of the user
userId string
userName string
firstName string
lastName string
email string
email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)
displayName string
display name of the user
orgId string
orgName string
orgDomain string
projectId string
projectName string
projectGrantId string
avatarUrl string
avatar URL of the user
preferredLoginName string
userType string
Possible values: [TYPE_UNSPECIFIED, TYPE_HUMAN, TYPE_MACHINE]
Default value: TYPE_UNSPECIFIED
type of the user (human / machine)
grantedOrgId string
grantedOrgName string
grantedOrgDomain string

{
  "userGrant": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2024-06-17T09:46:07.857Z",
      "changeDate": "2024-06-17T09:46:07.857Z",
      "resourceOwner": "69629023906488334"
    },
    "roleKeys": [
      "role.super.man"
    ],
    "state": "USER_GRANT_STATE_UNSPECIFIED",
    "userId": "69629023906488334",
    "userName": "gigi-giraffe",
    "firstName": "Gigi",
    "lastName": "Giraffe",
    "email": "gigi@zitadel.com",
    "displayName": "Gigi Giraffe",
    "orgId": "69629023906488334",
    "orgName": "ZITADEL",
    "orgDomain": "zitadel.cloud",
    "projectId": "69629023906488334",
    "projectName": "ZITADEL",
    "projectGrantId": "69629023906488334",
    "avatarUrl": "{your-domain}/assets/v1/avatar-32432jkh4kj32",
    "preferredLoginName": "gigi@zitadel.com",
    "userType": "TYPE_UNSPECIFIED",
    "grantedOrgId": "69629023906488334",
    "grantedOrgName": "ZITADEL",
    "grantedOrgDomain": "zitadel.cloud"
  }
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

GET /users/:userId/grants/:grantId

Authorization

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"
    }
  }
}

Request

Base URL

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

Bearer Token

userId — path required

grantId — path required

x-zitadel-orgid — header

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X GET 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants/:grantId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'