Add Open ID Connect Settings

POST 
/api/v34.00/settings/oidc

x-prisma-cloud-target-env: {"permission":"authConfiguration"}

Configures the OpenID Connect settings.

For more information, see OIDC.

cURL Request

Refer to the following example cURL request:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  -d '{"enabled": true,"clientID":"0oajdm6atavfYyJfr4x6","clientSecret":{"encrypted":"rnEk+1be20FLv+BYnDX4s5/T0NOb49hkNkaZQtgiF7K2s65"},"groupScope":"groups","groupClaim":"groups","openIDIssuesURL":"https://ss-123456.okta.com","providerAlias":"oidc_okta_ss"}' \
  "https://<CONSOLE>/api/v<VERSION>/settings/oidc"

Request

application/json

Body

authURLstring

AuthURL specifies auth URL.

certstring

Cert is idp certificate.

clientIDstring

ClientID is the client identifier issued to the client during the registration process.

clientSecret object

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

encryptedstring

Specifies an encrypted value of the secret.

plainstring

Specifies the plain text value of the secret.

enabledboolean

Enabled indicates whether Auth settings are enabled.

groupClaimstring

GroupClaim is the name of the group claim property.

groupScopestring

GroupScope specifies name of group scope.

openIDIssuesURLstring

OpenIDIssuesURL is the base URL for OpenID connect providers.

openshiftBaseURLstring

OpenshiftBaseURL is openshift base URL.

providerAliasstring

ProviderAlias is the provider alias used for display.

providerNameidentity.ProviderName (string)

ProviderName is the identity provider name

Possible values: [github,openshift]

tokenURLstring

TokenURL specifies token URL.

userClaimstring

UserClaim is the name of the user claim property.

Responses

200

OK

default

• curl
• python
• go
• nodejs
• csharp
• php

• CURL

curl -L 'https://pan.dev/api/v34.00/settings/oidc' \
-H 'Content-Type: application/json' \
-d '{
  "authURL": "string",
  "cert": "string",
  "clientID": "string",
  "clientSecret": {
    "encrypted": "string",
    "plain": "string"
  },
  "enabled": true,
  "groupClaim": "string",
  "groupScope": "string",
  "openIDIssuesURL": "string",
  "openshiftBaseURL": "string",
  "providerAlias": "string",
  "providerName": [
    "github",
    "openshift"
  ],
  "tokenURL": "string",
  "userClaim": "string"
}'

Request Collapse all

Body

{
  "authURL": "string",
  "cert": "string",
  "clientID": "string",
  "clientSecret": {
    "encrypted": "string",
    "plain": "string"
  },
  "enabled": true,
  "groupClaim": "string",
  "groupScope": "string",
  "openIDIssuesURL": "string",
  "openshiftBaseURL": "string",
  "providerAlias": "string",
  "providerName": [
    "github",
    "openshift"
  ],
  "tokenURL": "string",
  "userClaim": "string"
}