Sign in
Tenant Access

Retrieve tenant access for a user

Changed on

Fetches the tenant access configuration for a given user

get/api/v1/{tenant}/tenant-access/{userId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/tenant-access/{userId}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

userIdstring required

The user id

tenantstring required

Response

Tenant access successfully retrieved

tenantIdstring
userIdstring
usernamestring
displayNamestring
superAdminboolean

Example response

{
  "groups": [
    {
      "external": true,
      "name": "name",
      "id": "id"
    }
  ]
}

Changes

  • b6097dbc46aeRevision changes
    • warning

      added the new AI_COPILOT enum value to the //// response property for the response status

    • warning

      added the new CREDENTIAL enum value to the //// response property for the response status