Get Auth Token (v2.1)
GET/sdwan/v2.1/api/operators/:operator_id/authtokens/:authtoken_id
Get an auth token.
Request
Path Parameters
The operator ID.
The auth token ID.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
custom_roles CustomRole[]
The list/details of the custom roles.
custom_permissions CustomPermission[]
The details of the custom role permissions.
Allowed After Ms
Allowed Before Ms
List the disabled custom permissions.
The reason for disabling the custom permission.
Disallow Permission
The ID.
List the inactive custom permissions.
The reason for the custom permission being inactive.
The region.
The custom permission value.
List the disabled custom roles.
disallow_permissions AuthPermission[]
The details of the disallowed permissions.
The value of the permissions. Max size = 500.
The ID.
List the inactive custom roles.
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.
The value of the permissions. Max size = 500.
roles AuthRole[]
The names of the roles.
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))
The auth token expiry time in seconds.
The auth token ID.
Is System Owned
roles AuthRole[]
The user roles list. Max size = 7.
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))
The session key C. Max size = 128.
The X auth token.
{
"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"
}
]
}
],
"expires_utc_ms": 0,
"id": "string",
"is_system_owned": true,
"roles": [
{
"name": "string"
}
],
"session_key_c": "string",
"x_auth_token": "string"
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "ESP_INVALID_TENANT_DATA"
},
{
"code": "TOKEN_INVALID_OPERATOR_ID"
}
]
}
}