Create an IDP (v3.3)

POST 
/sdwan/v3.3/api/idps

Create an IDP.

Request

application/json

Body

Idp details

auto_provision_operators boolean

The option Auto Create Operators is selected. True or False.

auto_provision_roles boolean

The option Auto Create Operator Roles is selected. True or False.

disabled boolean

List the disabled IdP configurations.

disabled_reason string

List the reasons for disabled IdP configurations.

id string

The ID.

idp_domain_admin_email stringrequired

The entered email ID of the Palo Alto Networks Customer Support.

idp_domains string[]

The configured IdP domain name. Max length = 128. Consisting of letters all in lower case and numbers only.

idp_entity_id stringrequired

The IdP identity provider ID.

idp_login_url string

The IdP login URL.

idp_logout_url string

The IdP log out URL.

idp_metadata_b64 string

The IdP metadata b64.

inactive boolean

List the inactive IdP configurations.

inactive_reason string

The reason for the IdP configuration being inactive.

is_hob boolean

The is_hob true or false.

match_email_domain boolean

The match email domain.

role_map object

Role mapping as defined in the IdP system.

session_timeout_s int32

The session timeout duration for a session in seconds. The default value is 3600 seconds.

sign_redirect_binding boolean

The sign redirect binding is true or false.

sp_metadata_b64 string

The SP metadata b64.

sp_x509_b64 string

sp_x509_b64.

sp_x509_serial_no string

The SP x509 serial number. Max length = 1024.

Responses

200

Successful Operation

application/json

Schema

Schema

auto_provision_operators boolean

The option Auto Create Operators is selected. True or False.

auto_provision_roles boolean

The option Auto Create Operator Roles is selected. True or False.

disabled boolean

List the disabled IdP configurations.

disabled_reason string

List the reasons for disabled IdP configurations.

id string

The ID.

idp_domain_admin_email stringrequired

The entered email ID of the Palo Alto Networks Customer Support.

idp_domains string[]

The configured IdP domain name. Max length = 128. Consisting of letters all in lower case and numbers only.

idp_entity_id stringrequired

The IdP identity provider ID.

idp_login_url string

The IdP login URL.

idp_logout_url string

The IdP log out URL.

idp_metadata_b64 string

The IdP metadata b64.

inactive boolean

List the inactive IdP configurations.

inactive_reason string

The reason for the IdP configuration being inactive.

is_hob boolean

The is_hob true or false.

match_email_domain boolean

The match email domain.

role_map object

Role mapping as defined in the IdP system.

session_timeout_s int32

The session timeout duration for a session in seconds. The default value is 3600 seconds.

sign_redirect_binding boolean

The sign redirect binding is true or false.

sp_metadata_b64 string

The SP metadata b64.

sp_x509_b64 string

sp_x509_b64.

sp_x509_serial_no string

The SP x509 serial number. Max length = 1024.

Example (from schema)

{
  "auto_provision_operators": true,
  "auto_provision_roles": true,
  "disabled": true,
  "disabled_reason": "string",
  "id": "string",
  "idp_domain_admin_email": "string",
  "idp_domains": [
    "string"
  ],
  "idp_entity_id": "string",
  "idp_login_url": "string",
  "idp_logout_url": "string",
  "idp_metadata_b64": "string",
  "inactive": true,
  "inactive_reason": "string",
  "is_hob": true,
  "match_email_domain": true,
  "role_map": {},
  "session_timeout_s": 0,
  "sign_redirect_binding": true,
  "sp_metadata_b64": "string",
  "sp_x509_b64": "string",
  "sp_x509_serial_no": "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": "BAD_REQUEST"
      }
    ]
  }
}

Loading...