Authentication Settings
APIs for authentication settings, such as IdP and SSO
Create authentication settings for IdP SSO or metadata URL. You must include either the metadata_url field or all of the following fields: idp_sso_url, idp_issuer, and idp_certificate.
You must have Instance Administrator permissions to run this endpoint.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management.
{api_key}
{api_key_id}
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/authentication-settings/create HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 419
{
"request_data": {
"name": "IdP configuration",
"default_role": "Analyst",
"domain": "my-test-domain.com",
"mappings": {
"email": "user@company.com",
"firstname": "John",
"lastname": "Smith",
"group_name": "analysts"
},
"idp_sso_url": "https://cortex-test.okta.com/app/cortex-test/xxxxxxx/sso/SAML",
"idp_certificate": "MY_CERTIFICATE_FROM_OKTA",
"idp_issuer": "https://cortex-test.okta.com/idp",
"advanced_settings": {},
"is_account_role": true
}
}{
"reply": true
}Update existing authentication settings. To update the default domain, include empty value for both current_domain_value and new_domain_value.
You must have Instance Administrator permissions to run this endpoint.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management.
{api_key}
{api_key_id}
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/authentication-settings/update HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 500
{
"request_data": {
"name": "IDP configuration",
"default_role": "Analyst",
"current_domain_value": "my-test-domain.com",
"new_domain_value": "my-test-domain.org",
"mappings": {
"email": "user@company.com",
"firstname": "John",
"lastname": "Smith",
"group_name": "analysts"
},
"idp_sso_url": "https://cortex-test.okta.com/app/cortex-test/xxxxxxx/sso/SAML",
"idp_certificate": "========MY_UPDATED_TEST_CERTIFICATE_FROM_OKTA======",
"idp_issuer": "https://cortex-test.okta.com/idp",
"advanced_settings": {},
"is_account_role": true
}
}{
"reply": true
}Delete all authentication settings for the specified domain.
**Note: ** The first configuration on the tenant is the default configuration and cannot be deleted.
You must have Instance Administrator permissions to run this endpoint.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management.
{api_key}
{api_key_id}
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/authentication-settings/delete HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"request_data": {
"domain": "my-test-domain.org"
}
}{
"reply": true
}Get all the authentication settings for every configured domain in the tenant.
You must have Instance Administrator permissions to run this endpoint.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management.
{api_key}
{api_key_id}
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/authentication-settings/get/settings HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"request_data": {}
}{
"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"
}
]
}Get the metadata for all IdPs.
You must have Instance Administrator permissions to run this endpoint.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management.
{api_key}
{api_key_id}
OK
Bad Request. Got an invalid JSON.
Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
Unauthorized access. User does not have the required license type to run this API.
Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
Internal server error. A unified status for API communication type errors.
POST /public_api/v1/authentication-settings/get/metadata HTTP/1.1
Host: api-yourfqdn
Authorization: text
x-xdr-auth-id: text
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"request_data": {}
}{
"reply": {
"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",
"tenant_id": "9949042437653"
}
}Last updated
Was this helpful?