Fetch OIDC Configuration for an OIDC identity provider

POST 
/api/web/v1/identityproviders/oidc/configuration

Fetch OIDC Configuration for an OIDC identity provider. Caller requires the IDENTITYPROVIDERS:VIEW permission.

Request

application/json

Body

required

issuerUrl stringrequired

The issuer URL of the OIDC/OAuth identity provider.

Responses

200

Successful

application/json

Schema

Schema

authorizationEndpoint string

The authorization endpoint of the external OIDC identity provider.

claimsSupported string[]

A list of claims supported by the external OIDC identity provider.

jwksUri string

The JWKS URI endpoint of the external OIDC identity provider used to verify a token signature.

requireUserinfoSignature boolean

A flag indicating if the user information endpoint of the external OIDC identity provider should be signed and verified.

revocationEndpoint string

The revocation endpoint of the external OIDC identity provider.

scopesSupported string[]

A list of scopes supported by the external OIDC identity provider.

tokenEndpoint string

The token endpoint of the external OIDC identity provider.

userinfoEndpoint string

The user information endpoint of the external OIDC identity provider.

Example (from schema)

{
  "authorizationEndpoint": "https://account.mycompany.com/oauth/authorize",
  "claimsSupported": [
    "string"
  ],
  "jwksUri": "https://account.mycompany.com/oauth/keys",
  "requireUserinfoSignature": true,
  "revocationEndpoint": "https://account.mycompany.com/oauth/revoke",
  "scopesSupported": "openid email profile",
  "tokenEndpoint": "https://account.mycompany.com/oauth/token",
  "userinfoEndpoint": "https://account.mycompany.com/oauth/userinfo"
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...