Get Client Custom Roles (v2.1)

GET 
/v2.1/api/tenants/:tenant_id/clients/:client_id/roles

List all the client custom roles.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

client_id stringrequired

The client ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items CustomRoleV2N1[]
Array [
custom_permissions CustomPermission[]
The details of the custom role permissions.
Array [
allowed_after_ms int64
Allowed After Ms
allowed_before_ms int64
Allowed Before Ms
disabled boolean
List the disabled custom permissions.
disabled_reason string
The reason for disabling the custom permission.
disallow_permission boolean
Disallow Permission
id string
The ID.
inactive boolean
List the inactive custom permissions.
inactive_reason string
The reason for the custom permission being inactive.
region string
The region.
tenant_id stringrequired
ID of the tenant.
value stringrequired
The custom permission value.
]
description
The descriptions of the custom roles.
disabled boolean
List the disabled custom roles.
disabled_reason string
The reason for disabling the custom role.
disallow_permissions AuthPermission[]
The details of the disallowed permissions.
Array [
value string
The value of the permissions. Max size = 500.
]
id string
The ID.
inactive boolean
List the inactive custom roles.
inactive_reason string
Reason the custom role is inactive.
is_system_owned boolean
The custom role is system owned.
name stringrequired
The name of the custom role. (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root))
permissions AuthPermission[]
The permissions for the custom role.
Array [
value string
The value of the permissions. Max size = 500.
]
region string
The region.
roles AuthRole[]
The names of the roles.
Array [
name stringrequired
The name of the custom role. (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root))
]
tenant_id stringrequired
ID of the tenant.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "custom_permissions": [
        {
          "allowed_after_ms": 0,
          "allowed_before_ms": 0,
          "disabled": true,
          "disabled_reason": "string",
          "disallow_permission": true,
          "id": "string",
          "inactive": true,
          "inactive_reason": "string",
          "region": "string",
          "tenant_id": "string",
          "value": "string"
        }
      ],
      "disabled": true,
      "disabled_reason": "string",
      "disallow_permissions": [
        {
          "value": "string"
        }
      ],
      "id": "string",
      "inactive": true,
      "inactive_reason": "string",
      "is_system_owned": true,
      "name": "string",
      "permissions": [
        {
          "value": "string"
        }
      ],
      "region": "string",
      "roles": [
        {
          "name": "string"
        }
      ],
      "tenant_id": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "TENANT_INVALID_TENANT_ID"
      },
      {
        "code": "ESP_CLIENT_ID_INVALID"
      }
    ]
  }
}

Loading...