Skip to main content

List OIDC Client

GET 
/v3/config/extension/oidc/clients

Retrieves a list of all OpenID Connect clients configured for the organisation, including their verification request settings and configurations. The newest client comes first. System-managed clients are left out unless systemManaged is true. Each client holds clientSecret and callbackSecret in clear text.

Request​

Query Parameters

    offset integerrequired

    Default value: 0

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    limit integerrequired

    Default value: 10

    Maximum number of records to return per page.

    systemManaged booleanrequired

    Default value: false

    Set to true to include the system-managed clients in the list. Any other value leaves them out.

Responses​

List of clients

Response Headers
  • Cache-Control string

    Indicates that the response should not be cached.

Schema
    clients object[]required
  • Array [
    • 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

  • ]
    • pagination objectrequired
    currentPage integer

    Current page number

    totalItems integer

    Total number of items available

    totalPages integer

    Total number of pages based on limit

    limit integer

    Number of items per page

    hasPrevious boolean

    Indicates if there's a previous page

    hasNext boolean

    Indicates if there's a next page

Loading...
Last updated on