Skip to main content
POST
/
v2.0
/
identityprovider
/
configure
Configure an identity provider for your organisation.
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/identityprovider/configure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "idpType": "saml",
  "idpIssuer": "<string>",
  "idpLoginEndpoint": "<string>",
  "idpLogoutEndpoint": "<string>",
  "idpCertificate": "<string>",
  "wantAuthnResponseSigned": true,
  "decryptionPrivateKey": "<string>",
  "idpDisableRequestedAuthnContext": false
}'
This response does not have an example.

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Body

application/json
  • Option 1
  • Option 2
​
idpType
enum<string>
Available options:
saml
​
idpIssuer
string<url>

The value that will be in the issuer field in the SAML request.

​
idpLoginEndpoint
string<url>

The URL to use to login in the IDP. Used in the SP initiated Flow.

​
idpLogoutEndpoint
string<url>

The URL to send SLO requests against. Not all identity providers support this.

​
idpCertificate
string

The certificate from the ID used to sign the SAML requests. It is base64 encoded.

​
wantAuthnResponseSigned
boolean

If the SAML authentification response should be signed, not all providers support this.

​
decryptionPrivateKey
string

An optional decryption key. This is necessary if the SAML request is encoded.

​
idpDisableRequestedAuthnContext
boolean
default:false

For some providers, e.g. Azure on-prem, it might be necessary to disable the authn context field in the SAML request.

Response

The identity provider was configured for your organisation.

⌘I