Skip to main content

Create Auth Token (v2.0)

POST 

/sdwan/v2.0/api/operators/:operator_id/authtokens

Create an auth token.

Request

Path Parameters

    operator_id stringrequired

    The operator ID.

Body

Auth token 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))

  • ]
  • ]
  • expires_utc_ms int64

    The auth token expiry time in seconds.

    id string

    The auth token ID.

    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))

  • ]
  • session_key_c string

    The session key C. Max size = 128.

    x_auth_token string

    The X auth token.

Responses

Successful Operation

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))

  • ]
  • ]
  • expires_utc_ms int64

    The auth token expiry time in seconds.

    id string

    The auth token ID.

    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))

  • ]
  • session_key_c string

    The session key C. Max size = 128.

    x_auth_token string

    The X auth token.

Loading...