Skip to main content

Add SAML Settings for Prisma Cloud Compute

POST 

/api/v31.02/settings/saml

x-prisma-cloud-target-env: {"permission":"authConfiguration","saas":false,"self-hosted":true}
x-public: true

Configures the SAML settings that is used to authenticate to the Prisma Cloud Compute.

For more information, see Okta via SAML 2.0, G Suite via SAML, Azure AD via SAML, PingFederate via SAML, and ADFS via SAML.

cURL Request

Refer to the following example cURL request that uses the basic auth to set up and enable the SAML integration with Prisma Cloud Compute:

$ curl -k \
-u <USER> \
-H 'Content-Type: application/json' \
-X POST \
-d '{
"enabled": true,
"url": "https://my-adfs-server.twistlock.com/adfs/SSO",
"cert": "<CERTIFICATE>",
"issuer": "https://my-adfs-server.twistlock.com/adfs/services/trust",
"type": "adfs",
"audience": "twistlock",
"appId": "",
"tenantId": "",
"appSecret": {
"encrypted": ""
}
}' \
"https://<CONSOLE>/api/v<VERSION>/settings/saml"

Request

Body

    appId string

    AppID is the Azure application ID.

    appSecret object

    Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database

    encrypted string

    Specifies an encrypted value of the secret.

    plain string

    Specifies the plain text value of the secret.

    audience string

    Audience specifies the SAML audience used in the verification of the SAML response.

    cert string

    Cert is idp certificate in PEM format.

    consoleURL string

    ConsoleURL is the external Console URL that is used by the IDP for routing the browser after login.

    enabled boolean

    Enabled indicates whether saml settings are enabled.

    groupAttribute string

    GroupAttribute is the name of the group attribute.

    issuer string

    Issuer is idp issuer id.

    providerAlias string

    ProviderAlias is the provider alias used for display.

    skipAuthnContext boolean

    SkipAuthnContext indicates whether request authentication contexts should be skipped.

    tenantId string

    TenantID is the Azure Tenant ID.

    type identity.SamlType (string)

    Possible values: [okta,gsuite,ping,shibboleth,azure,adfs]

    SamlType represents the type of a SAML configured settings

    url string

    URL is idp sso url.

Responses

OK

Loading...