Read OIDC Client

GET 
/v3/config/extension/oidc/client/:clientId

Retrieves details of an OpenID Connect client. The client enables passwordless login with EUDI Wallet by requesting verifications from individuals. The client configuration includes presentation definition that specifies which credentials to request - appearing as a QR code or deep link on the authentication page. The answer holds clientSecret and callbackSecret in clear text.

Request

Path Parameters

clientId stringrequired

The ID of the client

Responses

200

Client details

Response Headers

• Cache-Control string

  Indicates that the response should not be cached.

application/json

Schema

Schema

client object

presentationDefinitionId string

The ID of the client's configured presentation definition. A presentation definition belongs to at most one client.

name string

The name of the client

clientId string

The ID of the client

clientSecret string

The secret of the client

redirectURIs string[]

The valid redirect URIs for the client. The redirect_uri of an authorisation request must match one of them exactly.

allowedOrigins string[]

The web origins of your application.

callbackURI string

The URI at which a sub value will be calculated and returned according to the sent presentation. Empty when the client uses identityMatchingAttributes.

callbackSecret string

The secret used to access the callbackURI. Required when callbackURI is set.

identityMatchingAttributes object

A map of credential identifiers to claim paths used as linking values for identity matching. Each key identifies a credential: the vct of an SD-JWT credential, the doctype of an mdoc credential, or a type value of a W3C credential. The value is the dot-separated path to the claim within that credential. The value of that claim becomes the sub. Empty when the client uses callbackURI.

property name* string

transactionDataAction string

Possible values: <= 140 characters

The text that describes the login to the user in the EUDI Wallet, for example Log in to your online bank account. Empty when the presentation definition has no transaction data.

kid string

The ID of the client's key

systemManaged boolean

Indicates whether the client is system-managed or not. A system-managed client cannot be updated or deleted.

updatedAt integer

The time of the last update of the client, as a Unix timestamp in seconds

createdAt integer

The time of the creation of the client, as a Unix timestamp in seconds

Example (from schema)

{
  "client": {
    "presentationDefinitionId": "string",
    "name": "string",
    "clientId": "string",
    "clientSecret": "string",
    "redirectURIs": [
      "string"
    ],
    "allowedOrigins": [
      "string"
    ],
    "callbackURI": "string",
    "callbackSecret": "string",
    "identityMatchingAttributes": {
      "urn:eudi:pid:1": "email"
    },
    "transactionDataAction": "Log in to your online bank account",
    "kid": "string",
    "systemManaged": true,
    "updatedAt": 1747015200,
    "createdAt": 1747011600
  }
}

400

Bad request. The Passwordless Login extension is not enabled.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

Client not found

Response Headers

application/json

Schema

Schema

error string

The error code, for example invalid_request, not_found or server_error

error_description string

The reason for the error

Example (from schema)

{
  "error": "string",
  "error_description": "string"
}

Example

{
  "error": "not_found",
  "error_description": "Client not found"
}

500

Internal server error. The answer has errorCode and errorDescription when it cannot reach the provider.

Response Headers

application/json

Schema

Schema

oneOf
Provider error
error string
The error code, for example invalid_request, not_found or server_error
error_description string
The reason for the error
API error
errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "error": "server_error",
  "error_description": "Internal server error"
}

Loading...