Update an oidc configuration

Updates the specified oidc configuration by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/accounts/{id}/oidc-configuration

JWT

account:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the oidc configuration.

Request Body Schema

Property	Type	Description	Constraints
issuerUrl	string	OIDC Issuer URL.	min: 1, max: 2048, format: uri
clientId	string	OIDC Client ID.	min: 1, max: 2048
additionalClientIds	array	Additional Client IDs that are authorized.	items: string
defaultRole	string	Default role assigned to the new users.	min: 1, max: 256
autoProvisionUsers	boolean	If enabled, a new User in Cryptlex is automatically created at first sign-in.
roleMappings	array	Role mappings.	items: object
identityProviderRole*	string	Identity provider role.	min: 1, max: 256
serviceProviderRole*	string	Service provider role.	min: 1, max: 256
enabled	boolean	Enable or disable the OIDC SSO.
claimMapping	object
email	array	JWT claim to map to the User email. User will not be created if an email is not found. By default, the email is mapped to 'email' property in the [UserInfo response](https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse).	items: string
name	array	JWT claim to map to the User name. Name will be set to 'External User' if not found.	items: string
role	array	JWT claim to map to the User role. Default role will used if not found.	items: string

Request Example

{
  "issuerUrl": "http://example.com",
  "clientId": "string",
  "additionalClientIds": [
    "string"
  ],
  "defaultRole": "string",
  "autoProvisionUsers": true,
  "roleMappings": [
    {
      "identityProviderRole": "string",
      "serviceProviderRole": "string"
    }
  ],
  "enabled": true,
  "claimMapping": {
    "email": [
      "string"
    ],
    "name": [
      "string"
    ],
    "role": [
      "string"
    ]
  }
}

Triggers webhook: oidcConfiguration.updated

POST <your-webhook-url>
{
  "event": "oidcConfiguration.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "issuerUrl": "string",
    "clientId": "string",
    "additionalClientIds": [
      "string"
    ],
    "enabled": true,
    "defaultRole": "string",
    "autoProvisionUsers": true,
    "roleMappings": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "serviceProviderRole": "string",
        "identityProviderRole": "string"
      }
    ],
    "claimMapping": {
      "name": [
        "string"
      ],
      "email": [
        "string"
      ],
      "role": [
        "string"
      ]
    }
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "issuerUrl": "string",
  "clientId": "string",
  "additionalClientIds": [
    "string"
  ],
  "enabled": true,
  "defaultRole": "string",
  "autoProvisionUsers": true,
  "roleMappings": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "serviceProviderRole": "string",
      "identityProviderRole": "string"
    }
  ],
  "claimMapping": {
    "name": [
      "string"
    ],
    "email": [
      "string"
    ],
    "role": [
      "string"
    ]
  }
}