Get authentication settings for all configured domains

post /public_api/v1/authentication-settings/get/settings

Get all the authentication settings for every configured domain in the tenant.

You must have Instance Administrator permissions to run this endpoint.

Request headers

Authorization

String

required

{api_key}

Example: authorization_example

x-xdr-auth-id

String

required

{api_key_id}

Example: xXdrAuthId_example

Body parameters

request_dataObject

CURL

  curl -X 'POST'

        -H
        'Accept: application/json'
      
        -H
        'Content-Type: application/json'
      
          -H
          'Authorization: authorization_example'
          -H
          'x-xdr-auth-id: xXdrAuthId_example'
      
      'https://api-yourfqdn/public_api/v1/authentication-settings/get/settings'
    
      -d
      ''

Responses

Body

replyArray

[

tenant_idString

nameString

domainString

idp_enabledBoolean

default_roleNull

is_account_roleNull

idp_certificateString

idp_issuerString

idp_sso_urlString

metadata_urlString

mappingsObject

emailString

firstnameString

group_nameString

lastnameString

advanced_settingsObject

authn_context_enabledBoolean

force_authnNull

idp_single_logout_urlString

relay_stateString

service_provider_private_keyString

service_provider_public_certString

sp_entity_idString

sp_logout_urlString

sp_urlString

]

RESPONSE

{
  "reply": [
    {
      "tenant_id": "9949042437653",
      "name": "SSO Integration",
      "domain": "",
      "idp_enabled": true,
      "default_role": null,
      "is_account_role": null,
      "idp_certificate": "certificate",
      "idp_issuer": "http://test.com",
      "idp_sso_url": "http://test.com/",
      "metadata_url": "",
      "mappings": {
        "email": "user@company.com",
        "firstname": "John",
        "group_name": "Users",
        "lastname": "Smith"
      },
      "advanced_settings": {
        "authn_context_enabled": false,
        "force_authn": null,
        "idp_single_logout_url": "",
        "relay_state": "",
        "service_provider_private_key": "",
        "service_provider_public_cert": ""
      },
      "sp_entity_id": "https://tenant.cortex.us.paloaltonetworks.com",
      "sp_logout_url": "https://tenant.cortex.us.paloaltonetworks.com/idp/logout",
      "sp_url": "https://tenant.cortex.us.paloaltonetworks.com/idp/saml"
    }
  ]
}

Bad Request. Got an invalid JSON.

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}

Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}

Unauthorized access. User does not have the required license type to run this API.

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}

Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}

Internal server error. A unified status for API communication type errors.

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}