light-mode-image
Learn
API ReferenceVerifier clients

Configure an OIDC Client

Roles

adminverifier

Analytics Events

OIDC_VERIFIER_CLIENT_CREATE_STARTOIDC_VERIFIER_CLIENT_CREATE_SUCCESSOIDC_VERIFIER_CLIENT_CREATE_FAIL
POST/ext/oidc/v1/verifiers/{id}/clients

Configures an OIDC Verifier Client on your tenant.

In order to verify a credential using an OpenID Connect Authorization Code Flow, you need to set up an OIDC Client application. This is the client that will engage with your configured OIDC Verifier to initiate the verification workflow. There is a list of OIDC Client apps, also known as Relying Party Libraries, on the OpenID website. Pick one which you feel comfortable with.

Analytic events

  • OIDC_VERIFIER_CLIENT_CREATE_START
  • OIDC_VERIFIER_CLIENT_CREATE_SUCCESS
  • OIDC_VERIFIER_CLIENT_CREATE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Verifier ID

Formatuuid

Request Body

application/json

The client payload

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

curl -X POST "https://example.vii.au01.mattr.global/ext/oidc/v1/verifiers/41458e5a-9092-40b7-9a26-d4eb43c5792f/clients" \  -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"
    }
  ]
}

How would you rate this page?

Delete an OIDC Verifier DELETE

Deletes an existing OIDC Verifier by providing its ID. ### **Analytic events** * OIDC_VERIFIER_DELETE_START * OIDC_VERIFIER_DELETE_SUCCESS * OIDC_VERIFIER_DELETE_FAIL

Retrieve all OIDC Clients GET

Returns a list of all OIDC Verifier Clients on the Tenant. ### **Analytic events** * OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_START * OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_SUCCESS * OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_FAIL