Sign Out API for MSP Client (v2.0)

POST 
/sdwan/v2.0/api/tenants/:client_id/logout

Sign out API for MSP client and reverts back to MSP session.

Request

Path Parameters

client_id stringrequired

The client ID.

application/json

Body

Tenant details

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))
]
]
disallowed_permissions object

The disallowed permissions.

id string

The ID.

operator_id string

The operator ID.

permissions object

The permissions for the auth resource.

redirect_region string

The redirected region for the auth resource.

redirect_urlpath string

The redirected URL for the auth resource.

redirect_x_auth_token string

The redirected x auth token for the auth resource.

resource_role_map object[]

The reource role map.

resource_uri_map object

The reource URI map.

resource_version_map object

The resource version map.

version_exceptions_map object[]

The version exception map.

x_auth_token string

The X auth token.

Responses

200

Successful Operation

application/json

Schema

Schema

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))
]
]
disallowed_permissions object

The disallowed permissions.

id string

The ID.

operator_id string

The operator ID.

permissions object

The permissions for the auth resource.

redirect_region string

The redirected region for the auth resource.

redirect_urlpath string

The redirected URL for the auth resource.

redirect_x_auth_token string

The redirected x auth token for the auth resource.

resource_role_map object[]

The reource role map.

resource_uri_map object

The reource URI map.

resource_version_map object

The resource version map.

version_exceptions_map object[]

The version exception map.

x_auth_token string

The X auth token.

Example (from schema)

{
  "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"
        }
      ]
    }
  ],
  "disallowed_permissions": {},
  "id": "string",
  "operator_id": "string",
  "permissions": {},
  "redirect_region": "string",
  "redirect_urlpath": "string",
  "redirect_x_auth_token": "string",
  "resource_role_map": [
    {}
  ],
  "resource_uri_map": {},
  "resource_version_map": {},
  "version_exceptions_map": [
    {}
  ],
  "x_auth_token": "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": "ESP_INVALID_OPERATOR_DATA"
      },
      {
        "code": "ESP_INVALID_OPERATOR_INACTIVE_ROLES"
      },
      {
        "code": "ESP_INVALID_TENANT_DATA"
      },
      {
        "code": "ESP_INVALID_TENANT_INACTIVE_CLIENTS"
      },
      {
        "code": "ESP_INVALID_TENANT_CLIENT_IP"
      },
      {
        "code": "ESP_INVALID_OPERATOR_IP"
      }
    ]
  }
}

Loading...