Get Client Permissions (v2.1)

GET 
/sdwan/v2.1/api/operators/:operator_id/clients/:client_id/permissions

List permissions assigned under a client.

Request

Path Parameters

operator_id stringrequired

The operator ID.

client_id stringrequired

The client ID.

Responses

200

Successful Operation

application/json

Schema

Schema

client_id stringrequired

The MSP client ID.

custom_roles CustomRole[]
The list/details of the custom roles.
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.
value stringrequired
The custom permission value.
]
disabled boolean
List the disabled custom roles.
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.
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.
]
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))
]
]
disabled boolean

List the disabled client permissions.

disabled_reason string

The reason for disabling the client permissions.

email string

The client email ID

enable_session_ip_lock boolean

Enable the sessin IP lock.

id string

The ID.

inactive boolean

List the inactive client permissions.

inactive_reason string

The reason for the client permission being inactive.

ipv4_list IPv4Address[]
The list of IPv4 addresses.
Array [
ipv4 string
The IPv4 address of the tenant.
]
name string

The MSP operator name. Max size = 100.

operator_id stringrequired

The operator ID.

region string

The region of the MSP operator.

roles AuthRole[]
The user roles list. Max size = 7.
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))
]
settings string

The MSP operator settings. Maximum of 100 KB data size is allowed.

Example (from schema)

{
  "client_id": "string",
  "custom_roles": [
    {
      "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",
          "value": "string"
        }
      ],
      "disabled": true,
      "disallow_permissions": [
        {
          "value": "string"
        }
      ],
      "id": "string",
      "inactive": true,
      "name": "string",
      "permissions": [
        {
          "value": "string"
        }
      ],
      "roles": [
        {
          "name": "string"
        }
      ]
    }
  ],
  "disabled": true,
  "disabled_reason": "string",
  "email": "string",
  "enable_session_ip_lock": true,
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "ipv4_list": [
    {
      "ipv4": "string"
    }
  ],
  "name": "string",
  "operator_id": "string",
  "region": "string",
  "roles": [
    {
      "name": "string"
    }
  ],
  "settings": "string"
}

Loading...