OpenID Metadata

Via the openid-metadata config, the verifier service can be configured to expose details such as verifier name and logo in a standardized way with other services such as digital wallets. These services can then use this information to display a human-readable verifier name and logo to the end-user during credential exchange.

Learn more about the name and logo info exposure in the OAuth 2.0 standard here.

The configured info will be exposed via the public endpoint /.well-known/openid-configuration.

Get OpenID Metadata

CURL

Endpoint: /v1/{target}/verifier-service-api/configuration/openid-metadata/view | API Reference

Example Request

curl -X 'GET' \
  'https://{orgID}.enterprise-sandbox.waltid.dev/v1/{target}/verifier-service-api/configuration/openid-metadata/view' \
  -H 'Authorization: Bearer {yourToken}' \
  -H 'Content-Type: application/json'

Path Parameters

  • orgID: - When performing operations within an organization, it is essential to use the organization's Base URL or another valid host alias. For example, if your organization is named test, your default Base URL will be test.enterprise-sandbox.walt.dev when using the sandbox environment.
  • target: resourceIdentifier - The target indicates the organization + tenant + verifier service from which to receive the configuration({organizationID}.{tenantID}.{verifierServiceID}), e.g. waltid.tenant1.verifier1

Example Response

  • 200 - metadata retrieved successfully.
{
  "name": "walt.id Enterprise Verifier",
  "logoUri": "http://cdn.walt.id/verifier/logo.png"
}
  • name String: Human-readable string name of the verifier.
  • logoUri String: URL string that references a logo for the verifier.

If no metadata is setup the body will be empty.

  • 401 - Invalid authentication

Update OpenID Metadata

CURL

Endpoint: /v1/{target}/verifier-service-api/configuration/openid-metadata/update | API Reference

Example Request

curl -X 'PUT' \
  'https://{orgID}.enterprise-sandbox.waltid.dev/v1/{target}/verifier-service-api/configuration/openid-metadata/update' \
  -H 'Authorization: Bearer {yourToken}' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "walt.id Enterprise Verifier",
  "logoUri": "http://cdn.walt.id/verifier/logo.png"
}'

Path Parameters

  • orgID: - When performing operations within an organization, it is essential to use the organization's Base URL or another valid host alias. For example, if your organization is named test, your default Base URL will be test.enterprise-sandbox.walt.dev when using the sandbox environment.
  • target: resourceIdentifier - The target indicates the organization + tenant + verifier service in which to update the configuration({organizationID}.{tenantID}.{verifierServiceID}), e.g. waltid.tenant1.verifier1

Body

{
  "name": "walt.id Enterprise Verifier",
  "logoUri": "http://cdn.walt.id/verifier/logo.png"
}

Body Parameters

  • name (optional) String: Human-readable string name of the verifier.
  • logoUri (optional) String: URL string that references a logo for the verifier.

Example Response

  • 200 - metadata updated successfully.
{
  "name": "walt.id Enterprise Verifier",
  "logoUri": "http://cdn.walt.id/verifier/logo.png"
}
  • 401 - Invalid authentication

Delete OpenID Metadata

CURL

Endpoint: /v1/{target}/verifier-service-api/configuration/openid-metadata/delete | API Reference

Example Request

curl -X 'DELETE' \
  'https://{orgID}.enterprise-sandbox.waltid.dev/v1/{target}/verifier-service-api/configuration/openid-metadata/delete' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {yourToken}'

Path Parameters

  • orgID: - When performing operations within an organization, it is essential to use the organization's Base URL or another valid host alias. For example, if your organization is named test, your default Base URL will be test.enterprise-sandbox.walt.dev when using the sandbox environment.
  • target: resourceIdentifier - The target indicates the organization + tenant + verifier service in which to delete the configuration({organizationID}.{tenantID}.{verifierServiceID}), e.g. waltid.tenant1.verifier1

Example Response

  • 200 - metadata deleted successfully.
  • 401 - Invalid authentication
OverviewIntro