ZITADEL Docs
APIsCore ResourcesV1Organization Objects

ListUserGrants

Search User Grants

Deprecated: List authorizations and pass the user ID filter to search for a users grants on owned or granted projects.

Returns a list of user grants that match the search queries. User grants are the roles users have for a specific project and organization.

POST
/users/grants/_search

Request Body

application/json

query?

list limitations and ordering

queries?

criteria the client is looking for

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/users/grants/_search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "viewTimestamp": "1s"
  },
  "result": [
    {
      "id": "string",
      "details": {
        "sequence": 0,
        "creationDate": "1s",
        "changeDate": "1s",
        "resourceOwner": "string"
      },
      "roleKeys": [
        "string"
      ],
      "state": "USER_GRANT_STATE_UNSPECIFIED",
      "userId": "string",
      "userName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "displayName": "string",
      "orgId": "string",
      "orgName": "string",
      "orgDomain": "string",
      "projectId": "string",
      "projectName": "string",
      "projectGrantId": "string",
      "avatarUrl": "string",
      "preferredLoginName": "string",
      "userType": "TYPE_UNSPECIFIED",
      "grantedOrgId": "string",
      "grantedOrgName": "string",
      "grantedOrgDomain": "string"
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?