Skip to main content
OpenID Connect Client

Create OIDC client

POST/v4/config/platform/extension/oidc/client

Creates an OpenID Connect client of the Passwordless Login extension. Your identity and access management system (for example Keycloak or Auth0) or your application uses the client to log people in with the EUDI Wallet: the authorisation page shows a QR code, the person presents the credentials of the presentation definition, and the tokens hold a sub that identifies the person.

Choose how the provider resolves the sub: with identityMatchingAttributes (a claim of the presentation) or with your own callbackURI. Give exactly one.

The answer holds clientId and clientSecret. Configure them in your system, with the discovery URL of the provider. The Passwordless Login (oidc) extension must be on.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:extensions:create

Body

application/json
  • presentationDefinitionIdstringrequired

    The presentation definition that the login page asks the EUDI Wallet to answer. It must not belong to another client. It must sign with an X.509 key that it names (cryptographicKeyFormat x509 and cryptographicKeyIdentifier) and use the client ID scheme x509_hash. It can have the transaction data template login_risk_transaction_non_ts12 or login_risk_transaction, but no credential that comes with its own transaction data (the TS12 payment wallet attestation, software statement, QESAC and SCA credentials): such a definition is for another purpose than login. It must not ask for a PID (an SD-JWT VC type that starts with urn:eudi:pid:, the mdoc type eu.europa.ec.eudi.pid.1 or the old type urn:eu.europa.ec.eudi:pid:1): the PID Rulebook does not allow a PID to sign transaction data.

  • namestringrequired

    The name of the client.

  • redirectURIsstring[]

    The redirect URIs of your identity and access management system or application. Each is a URL with scheme and host, without fragment. The redirect_uri of an authorisation request must match one of them exactly.

  • allowedOriginsstring[]

    The web origins of your application (scheme, host and optional port, no path).

  • identityMatchingAttributesobject

    The claim that becomes the sub, for each credential of the DCQL query of the presentation definition. The key is the vct (SD-JWT VC), the doctype (mdoc) or a type (W3C VC) of the credential, the value is the dot-separated path of the claim. Both must exist in the DCQL query. Do not send it with callbackURI.

  • callbackURIstring

    An HTTPS endpoint of yours that resolves the sub. At the token request, the provider sends it the presentations as a JSON array in a POST request, with Authorization: Bearer <callbackSecret> and an X-IGrant-Signature header. It must answer 200 within 30 seconds with a JSON object that holds sub. Do not send it with identityMatchingAttributes.

  • callbackSecretstring

    The secret that the provider sends to callbackURI as a bearer token, and the key of the X-IGrant-Signature HMAC. Mandatory with callbackURI.

  • transactionDataActionstring

    The text that the EUDI Wallet shows about the login, for example Log in to your online bank account, at most 140 characters. Mandatory when the presentation definition has a transaction data template, refused when it has none.

    At most 140 characters.

    Example:"Log in to your online bank account"

Response

application/json

The client is created.

Headers

  • Cache-Controlstring

    The answer holds a secret. Do not cache it.

    Example:"no-store"

  • clientIdstring

    The client ID.

  • clientSecretstring

    The client secret. Keep it on your server. Read the client to get it again.