Update an Authentication Provider

PUT/v1/users/authentication-providers/{id}

Updates an existing Authentication Provider by providing its ID.

Analytic events

USER_AUTHENTICATION_PROVIDER_UPDATE_START
USER_AUTHENTICATION_PROVIDER_UPDATE_SUCCESS
USER_AUTHENTICATION_PROVIDER_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Authentication Provider ID

Formatuuid

Request Body

application/json

Update an Authentication Provider

TypeScript Definitions

Use the request body type in TypeScript.

scope?array<string>

OpenID scopes to use during authentication. Each scope returns a set of user attributes which are called claims. Be sure to test that right scopes are added to get all the information you need. If no scopes are provided, [openid,profile,email] are added by default. If any scopes are provided, openid must also be included in the array.

Default

[  "openid",  "profile",  "email"]

clientId*string

The client ID of the application client created on your IdP.

clientSecret?string

The client secret of the application client created on your IdP.

tokenEndpointAuthMethod?string

Authentication method for your IdP token endpoint:

client_secret_post: Your credentials are passed as parameters in the request body.
client_secret_basic (default): Your credentials are passed as a base 64 encoded token.

Default"client_secret_basic"

Value in

"client_secret_basic"
"client_secret_post"

staticRequestParameters?

Additional parameters (maximum 1000 entries allowed) that will be included in the request to your IdP. These parameters are identical for every request as defined in your configuration. An example would be setting the prompt to be login to let your IdP know it should show the login page every time. Keys must be strings. Values of top-level object keys must stringify to less than 1000 characters.

Propertiesproperties <= 1000

forwardedRequestParameters?array<>

In contrast to staticRequestParameters, you can provide dynamic parameters that are fetched uniquely for each request to make the user journey more seamless. You can forward params to your IdP like login_hint which will pass the email of the user starting the flow. Values are limited to 1000 characters each, and cannot override any core Authorize Parameters.

Default[]

claimsToPersist?array<string>

List of claims to persist from your IdP to MATTR VII. If you have attributes from the ID token (e.g. user identifier, email, etc.) that you would like persisted on MATTR VII, add them to this array. By default this array is empty, meaning no claims are persisted on MATTR VII.

Default[]

Response Body

`application/json`

curl -X PUT "https://example.com/v1/users/authentication-providers/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "clientId": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "redirectUrl": "http://example.com",  "url": "http://example.com",  "scope": [    "openid",    "profile",    "email"  ],  "clientId": "string",  "tokenEndpointAuthMethod": "client_secret_basic",  "staticRequestParameters": {    "property1": "string",    "property2": "string"  },  "forwardedRequestParameters": [],  "claimsToPersist": [],  "clientSecret": "string"}

Update an Authentication Provider

Roles

Analytics Events

Analytic events

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Update an Authentication Provider

Roles

Analytics Events

Analytic events

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

`application/json`

`application/json`

`application/json`