light-mode-image
Learn
API ReferenceVerifier clients

Update an OIDC Client

Roles

adminverifier

Analytics Events

OIDC_VERIFIER_CLIENT_UPDATE_STARTOIDC_VERIFIER_CLIENT_UPDATE_SUCCESSOIDC_VERIFIER_CLIENT_UPDATE_FAIL
PUT/ext/oidc/v1/verifiers/{id}/clients/{clientId}

Updates an existing OIDC Verifier Client by providing its ID.

Analytic events

  • OIDC_VERIFIER_CLIENT_UPDATE_START
  • OIDC_VERIFIER_CLIENT_UPDATE_SUCCESS
  • OIDC_VERIFIER_CLIENT_UPDATE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

OIDC Verifier ID

Formatuuid
clientId*string

OIDC Verifier Client ID

Formatuuid

Request Body

application/json

Update a client

name*string

Insert a meaningful name for your OIDC Client.

redirectUris*array<>

This array can include a list of URLs. One of the URIs in that list must match the callback URI configured for your OIDC Client for the Authorization Request:

  • Must be a valid URL.
  • Must use the HTTPS protocol.
  • Must not be an IP address.
  • Must not include query parameters.
  • For testing, it’s okay to add a localhost uri like https://localhost:9090/callback
responseTypes?array<>

Determines the authorization processing flow.

grantTypes?array<>

OAuth Grant Type.

tokenEndpointAuthMethod?string

OAuth Token Endpoint Authentication Method.

idTokenSignedResponseAlg*string

Algorithm must match configured jwks. Defaults to ES256.

applicationType?string
logoUri?string

The logo to display above the QR code.

Formaturi

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.vii.au01.mattr.global/ext/oidc/v1/verifiers/41458e5a-9092-40b7-9a26-d4eb43c5792f/clients/da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d" \  -H "Content-Type: application/json" \  -d '{    "name": "OIDC Client for the verifier",    "redirectUris": [      "https://example.com/callback"    ],    "responseTypes": [      "code"    ],    "grantTypes": [      "authorization_code"    ],    "tokenEndpointAuthMethod": "client_secret_post",    "idTokenSignedResponseAlg": "ES256",    "applicationType": "web",    "logoUri": "https://example.com/logo.png"  }'
{
  "id": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d",
  "secret": "H2epdcmNJ46hXJo5opdzvhbZK9W2ZGPkQh.E",
  "name": "OIDC Client for the verifier",
  "redirectUris": [
    "https://example.com/callback"
  ],
  "responseTypes": [
    "code"
  ],
  "grantTypes": [
    "authorization_code"
  ],
  "tokenEndpointAuthMethod": "client_secret_post",
  "idTokenSignedResponseAlg": "ES256",
  "applicationType": "web",
  "logoUri": "https://example.com/logo.png"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Retrieve an OIDC Client GET

Retrieves an existing OIDC Verifier Client by providing its ID. ### **Analytic events** * OIDC_VERIFIER_CLIENT_RETRIEVE_START * OIDC_VERIFIER_CLIENT_RETRIEVE_SUCCESS * OIDC_VERIFIER_CLIENT_RETRIEVE_FAIL

Delete an OIDC Client DELETE

Deletes an existing OIDC Verifier Client by providing its ID. ### **Analytic events** * OIDC_VERIFIER_CLIENT_DELETE_START * OIDC_VERIFIER_CLIENT_DELETE_SUCCESS * OIDC_VERIFIER_CLIENT_DELETE_FAIL