Skip to main content

Get OAuth Settings

GET 
/api/v33.01/settings/oauth
x-prisma-cloud-target-env: {"permission":"authConfiguration"}

Returns the OAuth configuration settings.

cURL Request​

Refer to the following example cURL request:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  "https://<CONSOLE>/api/v<VERSION>/settings/oauth"

cURL Response​

Refer to the following example cURL response:

{
 "enabled": true,
 "clientID": "ef3a806a249a31b7d15e",
 "clientSecret": {
   "encrypted": "O27GsQ7PDX4LrVx6q+A7sMLUAKTbKU3DAYTZyaOhqTqdNwI7raKFCA3/RrmRPUgk"
 },
 "providerName": "github",
 "authURL": "https://github.com/login/oauth/authorize",
 "tokenURL": "https://github.com/login/oauth/access_token",
 "groupScope": "",
 "groupClaim": "",
 "userClaim": "",
 "cert": "",
 "openshiftBaseURL": "",
 "openIDIssuesURL": "",
 "providerAlias": "github_ss"
}

Responses​

ProviderSettings are the Oauth/ OpenID Connect connectivity settings

Schema
    authURL string

    AuthURL specifies auth URL.

    cert string

    Cert is idp certificate.

    clientID string

    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

    encrypted string

    Specifies an encrypted value of the secret.

    plain string

    Specifies the plain text value of the secret.

    enabled boolean

    Enabled indicates whether Auth settings are enabled.

    groupClaim string

    GroupClaim is the name of the group claim property.

    groupScope string

    GroupScope specifies name of group scope.

    openIDIssuesURL string

    OpenIDIssuesURL is the base URL for OpenID connect providers.

    openshiftBaseURL string

    OpenshiftBaseURL is openshift base URL.

    providerAlias string

    ProviderAlias is the provider alias used for display.

    providerName identity.ProviderName (string)

    Possible values: [github,openshift]

    ProviderName is the identity provider name

    tokenURL string

    TokenURL specifies token URL.

    userClaim string

    UserClaim is the name of the user claim property.

Loading...