Essence Identity Provider API

Version v1 · OpenAPI 3.0.1 · 159 operations · Download the JSON document

OAuth 2.0 Authorization Server and OpenID Connect Provider

Generated from the IdP service's code at build time (api-specs/generated/IdP/Essence.Identity.IdP.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.

AccountLinks

GET/api/v1/account-links

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — LinkedAccountDto[]

403Forbidden — ProblemDetails

POST/api/v1/account-links

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

LinkAccountRequest as application/*+json, application/json, text/json

Responses

201Created — AccountLinkResult

202Accepted — AccountLinkResult

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — AccountLinkResult

GET/api/v1/account-links/users/{userId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`userId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — LinkedAccountDto[]

GET/api/v1/account-links/{linkId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`linkId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — LinkedAccountDto

404Not Found — ProblemDetails

DELETE/api/v1/account-links/{linkId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`linkId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

POST/api/v1/account-links/{linkId}/verify

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`linkId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — LinkedAccountDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

AccreditedIssuers

GET/api/v1/accredited-issuers

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`scheme`	query	`string`	no	—

Request body

No request body.

Responses

200OK — AccreditedIssuerDto[]

POST/api/v1/accredited-issuers

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

AccreditBodyRequest as application/*+json, application/json, text/json

Responses

201Created — AccreditedIssuerDto

400Bad Request — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/accredited-issuers/{bodyId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

No request body.

Responses

200OK — AccreditationRecordDto

400Bad Request — ProblemDetails

GET/api/v1/accredited-issuers/{bodyId}/accreditations

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — AccreditedIssuerDto[]

POST/api/v1/accredited-issuers/{bodyId}/keys

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

Not marked as required in the document.

RegisterIssuerKeyRequest as application/*+json, application/json, text/json

Responses

200OK — AccreditedIssuerDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/accredited-issuers/{bodyId}/keys/rotate

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

Not marked as required in the document.

RotateIssuerKeyRequest as application/*+json, application/json, text/json

Responses

200OK — AccreditedIssuerDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/accredited-issuers/{bodyId}/keys/{keyId}/retire

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`keyId`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

Not marked as required in the document.

RetireIssuerKeyRequest as application/*+json, application/json, text/json

Responses

200OK — AccreditedIssuerDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/accredited-issuers/{bodyId}/reinstate

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

Not marked as required in the document.

AccreditationStatusChangeRequest as application/*+json, application/json, text/json

Responses

200OK — AccreditedIssuerDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/accredited-issuers/{bodyId}/routes

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

Not marked as required in the document.

DesignateRouteRequest as application/*+json, application/json, text/json

Responses

200OK — AccreditedIssuerDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/accredited-issuers/{bodyId}/routes/{route}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`route`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

No request body.

Responses

200OK — AccreditedIssuerDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/accredited-issuers/{bodyId}/suspend

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

Not marked as required in the document.

AccreditationStatusChangeRequest as application/*+json, application/json, text/json

Responses

200OK — AccreditedIssuerDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/accredited-issuers/{bodyId}/withdraw

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`bodyId`	path	`string`	yes	—
`scheme`	query	`string`	no	—

Request body

Not marked as required in the document.

AccreditationStatusChangeRequest as application/*+json, application/json, text/json

Responses

200OK — AccreditedIssuerDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

Authorization

GET/connect/authorize

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK

POST/connect/authorize

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK

POST/connect/token

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK

Clients

POST/api/v1/clients

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateClientRequest as application/*+json, application/json, text/json

Responses

201Created — ClientDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/clients/by-client-id/{clientId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`clientId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ClientDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/clients/posture

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`oid4VcOnly`	query	`boolean`	no	—
`pageNumber`	query	`integer (int32)`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — Oid4VcClientPostureDtoPagedResult

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/clients/{clientId}/secrets

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`clientId`	path	`string`	yes	—

Request body

Not marked as required in the document.

AddClientSecretRequest as application/*+json, application/json, text/json

Responses

201Created — ClientSecretResponse

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/clients/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — ClientDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

Credentials

POST/api/v1/Credentials/issue

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

IssueCredentialRequest as application/*+json, application/json, text/json

Responses

201Created — IssuedCredentialDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

503Service Unavailable

GET/api/v1/Credentials/issued

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`activeOnly`	query	`boolean`	no	—

Request body

No request body.

Responses

200OK — IssuedCredentialDto[]

401Unauthorized — ProblemDetails

PUT/api/v1/Credentials/issued/{id}/vault-document

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RecordCredentialVaultDocumentRequest as application/*+json, application/json, text/json

Responses

200OK — IssuedCredentialDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/Credentials/issuer/rotate-key

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

RotateVcIssuerKeyRequest as application/*+json, application/json, text/json

Responses

200OK — VcIssuerKeyRotationDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

503Service Unavailable

GET/api/v1/Credentials/status/{listId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`listId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — unspecified

304Not Modified

404Not Found — ProblemDetails

503Service Unavailable

POST/api/v1/Credentials/verify

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

VerifyCredentialRequest as application/*+json, application/json, text/json

Responses

200OK — VerifyCredentialResultDto

400Bad Request — ProblemDetails

POST/api/v1/Credentials/{id}/revoke

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RevokeCredentialRequest as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

503Service Unavailable

DomainOwnership

GET/api/v1/clients/{clientId}/domain-ownership/challenges

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`clientId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — DomainOwnershipChallengeDto[]

POST/api/v1/clients/{clientId}/domain-ownership/challenges

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`clientId`	path	`string`	yes	—

Request body

Not marked as required in the document.

StartDomainOwnershipChallengeRequest as application/*+json, application/json, text/json

Responses

201Created — DomainOwnershipChallengeDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/clients/{clientId}/domain-ownership/challenges/{challengeId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`clientId`	path	`string`	yes	—
`challengeId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — DomainOwnershipChallengeDto

404Not Found — ProblemDetails

DELETE/api/v1/clients/{clientId}/domain-ownership/challenges/{challengeId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`clientId`	path	`string`	yes	—
`challengeId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RevokeDomainOwnershipRequest as application/*+json, application/json, text/json

Responses

200OK — DomainOwnershipChallengeDto

404Not Found — ProblemDetails

POST/api/v1/clients/{clientId}/domain-ownership/challenges/{challengeId}/check

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`clientId`	path	`string`	yes	—
`challengeId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — DomainOwnershipChallengeDto

404Not Found — ProblemDetails

503Service Unavailable

GET/api/v1/clients/{clientId}/domain-ownership/proof

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`clientId`	path	`string`	yes	—
`domain`	query	`string`	no	—

Request body

No request body.

Responses

200OK — DomainOwnershipProofDto

404Not Found — ProblemDetails

DvsRegisterSnapshot

GET/api/v1/oid4vc/dvs-register-snapshot

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — string

304Not Modified

503Service Unavailable — ProblemDetails

IdentityBindingPolicies

GET/api/v1/identity-binding/policies

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — MaterialChangePolicyDto[]

POST/api/v1/identity-binding/policies

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateMaterialChangePolicyRequestDto as application/*+json, application/json, text/json

Responses

201Created — MaterialChangePolicyDto

400Bad Request — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/identity-binding/policies/preview

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

PreviewMaterialChangePolicyRequestDto as application/*+json, application/json, text/json

Responses

200OK — PolicyPreviewResultDto

400Bad Request — ProblemDetails

PUT/api/v1/identity-binding/policies/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateMaterialChangePolicyRequestDto as application/*+json, application/json, text/json

Responses

200OK — MaterialChangePolicyDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

DELETE/api/v1/identity-binding/policies/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

IdentityBindings

POST/api/v1/identity-binding/actions/{actionId}/retry

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`actionId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — LifecycleActionDto

404Not Found — ProblemDetails

GET/api/v1/identity-binding/bindings

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`state`	query	`string`	no	—
`cursor`	query	`string`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — IdentityBindingDtoCursorResult

GET/api/v1/identity-binding/bindings/{id}/history

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—
`cursor`	query	`string`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — LifecycleActionDtoCursorResult

404Not Found — ProblemDetails

POST/api/v1/identity-binding/bindings/{id}/reinstate

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

ReinstateBindingRequestDto as application/*+json, application/json, text/json

Responses

200OK — LifecycleActionDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/identity-binding/health

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — BindingHealthDto

IdpAccountLinkReview

GET/api/v1/idp/account-links/review

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — LinkedAccountDto[]

403Forbidden — ProblemDetails

DELETE/api/v1/idp/account-links/{linkId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`linkId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

204No Content

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/idp/account-links/{linkId}/verify

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`linkId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

204No Content

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

IdpConnections

GET/api/v1/idp-connections

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`enabledOnly`	query	`boolean`	no	—
`connectorType`	query	`string`	no	—

Request body

No request body.

Responses

200OK — IdpConnectionDto[]

POST/api/v1/idp-connections

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateIdpConnectionRequest as application/*+json, application/json, text/json

Responses

201Created — IdpConnectionDto

400Bad Request — ProblemDetails

GET/api/v1/idp-connections/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — IdpConnectionDto

404Not Found — ProblemDetails

PUT/api/v1/idp-connections/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateIdpConnectionRequest as application/*+json, application/json, text/json

Responses

200OK — IdpConnectionDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/idp-connections/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/idp-connections/{id}/attribute-mappings

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — AttributeMappingDto[]

404Not Found — ProblemDetails

PUT/api/v1/idp-connections/{id}/attribute-mappings

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

AttributeMappingDto[] as application/*+json, application/json, text/json

Responses

200OK — IdpConnectionDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/idp-connections/{id}/test

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — TestIdpConnectionResponse

404Not Found — ProblemDetails

IdpFederation

GET/api/v1/idp/bindable-tenants

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — BindableTenantDto[]

GET/api/v1/idp/connections

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`enabledOnly`	query	`boolean`	no	—

Request body

No request body.

Responses

200OK — IdpConnectionDto[]

POST/api/v1/idp/connections

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateIdpConnectionRequest as application/*+json, application/json, text/json

Responses

201Created — IdpConnectionDto

400Bad Request — ProblemDetails

402Payment Required — ProblemDetails

GET/api/v1/idp/connections/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — IdpConnectionDto

404Not Found — ProblemDetails

PUT/api/v1/idp/connections/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateIdpConnectionRequest as application/*+json, application/json, text/json

Responses

200OK — IdpConnectionDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/idp/connections/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/idp/connections/{id}/attribute-mappings

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — AttributeMappingDto[]

404Not Found — ProblemDetails

PUT/api/v1/idp/connections/{id}/attribute-mappings

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

AttributeMappingDto[] as application/*+json, application/json, text/json

Responses

200OK — IdpConnectionDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/idp/connections/{id}/attribute-mappings/attest

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

AttestMappingsRequest as application/*+json, application/json, text/json

Responses

200OK — MappingAttestationDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/idp/connections/{id}/attribute-mappings/attestation

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — MappingAttestationDto

404Not Found — ProblemDetails

GET/api/v1/idp/connections/{id}/enforcement

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — EnforcementPolicyDto

404Not Found — ProblemDetails

PUT/api/v1/idp/connections/{id}/enforcement

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

EnforcementPolicyInput as application/*+json, application/json, text/json

Responses

200OK — EnforcementPolicyDto

400Bad Request — ProblemDetails

402Payment Required — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/idp/connections/{id}/enforcement/enforce

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

EnforceSsoRequest as application/*+json, application/json, text/json

Responses

200OK — EnforcementPolicyDto

400Bad Request — ProblemDetails

402Payment Required — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/idp/connections/{id}/enforcement/suspend

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — EnforcementPolicyDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/idp/connections/{id}/tenant-binding

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — IdpTenantBindingDto

404Not Found — ProblemDetails

PUT/api/v1/idp/connections/{id}/tenant-binding

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

BindIdpToTenantRequest as application/*+json, application/json, text/json

Responses

200OK — IdpTenantBindingDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/idp/connections/{id}/test

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — TestIdpConnectionResponse

404Not Found — ProblemDetails

GET/api/v1/idp/entitlement

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — IdpEntitlementDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/idp/scim/config

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ScimConfigDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

PUT/api/v1/idp/scim/config

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ScimConfigInputDto as application/*+json, application/json, text/json

Responses

200OK — ScimConfigDto

400Bad Request — ProblemDetails

402Payment Required — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/idp/scim/provisioning/lookup

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`email`	query	`string`	no	—

Request body

No request body.

Responses

200OK — UserProvisioningStatusDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/idp/scim/provisioning/{userRef}/retry

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`userRef`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — UserProvisioningStatusDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/idp/scim/token

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ScimTokenIssuedDto

400Bad Request — ProblemDetails

402Payment Required — ProblemDetails

403Forbidden — ProblemDetails

IssuerCredentials

GET/api/v1/credentials/instances/{instanceId}/issued

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`instanceId`	path	`string (uuid)`	yes	—
`storage`	query	`string`	no	—
`cursor`	query	`string`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — IssuedCredentialDtoCursorResult

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

NominatedCredentialWatches

GET/api/v1/credentials/nominated-watches

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`activeOnly`	query	`boolean`	no	—

Request body

No request body.

Responses

200OK — NominatedCredentialWatchDto[]

401Unauthorized — ProblemDetails

503Service Unavailable

POST/api/v1/credentials/nominated-watches

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateNominatedWatchRequest as application/*+json, application/json, text/json

Responses

201Created — NominatedCredentialWatchDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

503Service Unavailable

DELETE/api/v1/credentials/nominated-watches/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—
`reason`	query	`string`	no	—

Request body

No request body.

Responses

204No Content

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

503Service Unavailable

OpenId4VcConfiguration

GET/api/v1/oid4vc/status-list-health

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`maxIssuers`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — Oid4VcStatusListHealthDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/oid4vc/tenants/{tenantId}/credential-configurations

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`publishedOnly`	query	`boolean`	no	—

Request body

No request body.

Responses

200OK — Oid4VcCredentialConfigurationDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/credential-configurations

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

CreateOid4VcCredentialConfigurationRequest as application/*+json, application/json, text/json

Responses

201Created — Oid4VcCredentialConfigurationDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/credential-configurations/{configurationRecordId}/publish

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`configurationRecordId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — Oid4VcCredentialConfigurationDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/credential-configurations/{configurationRecordId}/unpublish

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`configurationRecordId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — Oid4VcCredentialConfigurationDto

404Not Found — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/credential-offers

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

MintCredentialOfferRequest as application/*+json, application/json, text/json

Responses

201Created — MintCredentialOfferResponse

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/oid4vc/tenants/{tenantId}/credential-pools

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`credentialConfigurationId`	query	`string (uuid)`	no	—
`includeRevoked`	query	`boolean`	no	—
`cursor`	query	`string`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — CredentialBatchPoolDtoCursorResult

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/credential-pools/{poolId}/revoke

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`poolId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RevokeCredentialPoolRequest as application/*+json, application/json, text/json

Responses

200OK — CredentialBatchPoolDto

404Not Found — ProblemDetails

GET/api/v1/oid4vc/tenants/{tenantId}/issuer-metadata

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — CredentialIssuerMetadataDto

401Unauthorized — ProblemDetails

GET/api/v1/oid4vc/tenants/{tenantId}/privacy-degradation

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`sinceUtc`	query	`string (date-time)`	no	—

Request body

No request body.

Responses

200OK — PrivacyDegradationRegisterDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/oid4vc/tenants/{tenantId}/privacy-degradation/export

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`sinceUtc`	query	`string (date-time)`	no	—

Request body

No request body.

Responses

200OK — PrivacyDegradationExportDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/privacy-degradation/raise-issuance-ceilings

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RaiseIssuanceCeilingsRequest as application/*+json, application/json, text/json

Responses

200OK — RaiseIssuanceCeilingsResponse

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/oid4vc/tenants/{tenantId}/query-templates

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`includeRetired`	query	`boolean`	no	—

Request body

No request body.

Responses

200OK — DcqlQueryTemplateDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/query-templates

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

CreateDcqlQueryTemplateRequest as application/*+json, application/json, text/json

Responses

201Created — DcqlQueryTemplateDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/query-templates/import/presentation-exchange

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

ImportPresentationExchangeRequest as application/*+json, application/json, text/json

Responses

201Created — DcqlQueryTemplateDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/query-templates/preview

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

PreviewDcqlQueryRequest as application/*+json, application/json, text/json

Responses

200OK — DcqlQueryPreviewResponse

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/oid4vc/tenants/{tenantId}/query-templates/{templateId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`templateId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — DcqlQueryTemplateDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

PUT/api/v1/oid4vc/tenants/{tenantId}/query-templates/{templateId}/name

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`templateId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RenameDcqlQueryTemplateRequest as application/*+json, application/json, text/json

Responses

200OK — DcqlQueryTemplateDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/query-templates/{templateId}/reinstate

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`templateId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — DcqlQueryTemplateDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/query-templates/{templateId}/retire

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`templateId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — DcqlQueryTemplateDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/oid4vc/tenants/{tenantId}/query-templates/{templateId}/revisions

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`templateId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

ReviseDcqlQueryTemplateRequest as application/*+json, application/json, text/json

Responses

200OK — DcqlQueryTemplateDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/oid4vc/transaction-code-policy

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — TransactionCodePolicyDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/oid4vc/verifier-certificate

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — Oid4VpVerifierCertificateDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

OpenId4VciProtocol

GET/.well-known/jwt-vc-issuer/oid4vci/{tenantId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — unspecified

304Not Modified

404Not Found — Oid4VcProtocolErrorResponse

503Service Unavailable — Oid4VcProtocolErrorResponse

GET/.well-known/openid-credential-issuer/oid4vci/{tenantId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — CredentialIssuerMetadataDto

304Not Modified

404Not Found — Oid4VcProtocolErrorResponse

GET/oid4vci/offers/{offerId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`offerId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — CredentialOfferDocument

GET/oid4vci/status-lists/{statusListId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`statusListId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — string

304Not Modified

404Not Found — Oid4VcProtocolErrorResponse

503Service Unavailable — Oid4VcProtocolErrorResponse

POST/oid4vci/{tenantId}/credential

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

CredentialRequest as application/*+json, application/json, text/json

Responses

200OK — CredentialIssuanceResponse

POST/oid4vci/{tenantId}/nonce

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — NonceResponse

POST/oid4vci/{tenantId}/notification

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

CredentialNotificationRequest as application/*+json, application/json, text/json

Responses

204No Content

POST/oid4vci/{tenantId}/reissue

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`Idempotency-Key`	header	`string`	no	—

Request body

Not marked as required in the document.

Oid4VciReissuanceRequest as application/*+json, application/json, text/json

Responses

200OK — Oid4VciReissuanceResponse

POST/oid4vci/{tenantId}/token

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

object as application/x-www-form-urlencoded

Responses

200OK — Oid4VciTokenResponse

OpenId4VpVerifier

GET/api/v1/oid4vp/jwks

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK

503Service Unavailable — Oid4VcProtocolErrorResponse

GET/api/v1/oid4vp/requests/{transactionId}/request-object

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`transactionId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK

404Not Found — ProblemDetails

POST/api/v1/oid4vp/{tenantId}/requests

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

CreatePresentationRequestDto as application/*+json, application/json, text/json

Responses

201Created — PresentationRequestDto

400Bad Request — ProblemDetails

403Forbidden — Oid4VcProtocolErrorResponse

GET/api/v1/oid4vp/{tenantId}/requests/{transactionId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`transactionId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — PresentationResultDto

404Not Found — ProblemDetails

POST/api/v1/oid4vp/{tenantId}/response/{transactionId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`tenantId`	path	`string (uuid)`	yes	—
`transactionId`	path	`string`	yes	—

Request body

Not marked as required in the document.

object as application/x-www-form-urlencoded

Responses

200OK

400Bad Request — ProblemDetails

OpenId4VpVerifierConsole

GET/api/v1/oid4vc/verifier-request-behaviour

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — Oid4VpRequestBehaviourDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/oid4vc/verifier-response-keys

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — Oid4VpResponseEncryptionKeysDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

PushedAuthorization

POST/connect/par

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

201Created

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

RelyingPartyRegistry

POST/api/v1/relying-parties

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

RegisterRelyingPartyRequest as application/*+json, application/json, text/json

Responses

201Created — RelyingPartyDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

409Conflict — ProblemDetails

GET/api/v1/relying-parties/{organizationId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`organizationId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — RelyingPartyDto

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/relying-parties/{organizationId}/purposes

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`organizationId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RelyingPartyPurposeRequest as application/*+json, application/json, text/json

Responses

201Created — RelyingPartyDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/relying-parties/{organizationId}/terms-acceptances

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`organizationId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RelyingPartyTermsAcceptanceRequest as application/*+json, application/json, text/json

Responses

201Created — RelyingPartyDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

ScimProtocol

GET/api/v1/idp/scim/v2/IdentityBindings

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`filter`	query	`string`	no	—
`count`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — ScimIdentityBindingListResponse

401Unauthorized — ScimErrorResponse

POST/api/v1/idp/scim/v2/IdentityBindings

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ScimIdentityBindingCreateRequest as application/*+json, application/json, text/json

Responses

201Created — ScimIdentityBindingResource

400Bad Request — ScimErrorResponse

401Unauthorized — ScimErrorResponse

GET/api/v1/idp/scim/v2/IdentityBindings/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — ScimIdentityBindingResource

404Not Found — ScimErrorResponse

DELETE/api/v1/idp/scim/v2/IdentityBindings/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200OK — ScimIdentityBindingDeleteResponse

404Not Found — ScimErrorResponse

PATCH/api/v1/idp/scim/v2/IdentityBindings/{id}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

ScimPatchRequest as application/*+json, application/json, text/json

Responses

200OK — ScimIdentityBindingResource

400Bad Request — ScimErrorResponse

404Not Found — ScimErrorResponse

GET/api/v1/idp/scim/v2/ResourceTypes

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ScimResourceType[]

GET/api/v1/idp/scim/v2/ServiceProviderConfig

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ScimServiceProviderConfig

GET/api/v1/idp/scim/v2/Users

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`filter`	query	`string`	no	—
`startIndex`	query	`integer (int32)`	no	—
`count`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200OK — ScimUserScimListResponse

400Bad Request — ScimErrorResponse

401Unauthorized — ScimErrorResponse

POST/api/v1/idp/scim/v2/Users

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ScimUser as application/*+json, application/json, text/json

Responses

201Created — ScimUser

401Unauthorized — ScimErrorResponse

403Forbidden — ScimErrorResponse

GET/api/v1/idp/scim/v2/Users/{externalId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`externalId`	path	`string`	yes	—

Request body

No request body.

Responses

200OK — ScimUser

401Unauthorized — ScimErrorResponse

404Not Found — ScimErrorResponse

DELETE/api/v1/idp/scim/v2/Users/{externalId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`externalId`	path	`string`	yes	—

Request body

No request body.

Responses

204No Content

401Unauthorized — ScimErrorResponse

403Forbidden — ScimErrorResponse

PATCH/api/v1/idp/scim/v2/Users/{externalId}

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`externalId`	path	`string`	yes	—

Request body

Not marked as required in the document.

ScimPatchRequest as application/*+json, application/json, text/json

Responses

204No Content

401Unauthorized — ScimErrorResponse

403Forbidden — ScimErrorResponse

Token

POST/connect/introspect

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

object as application/x-www-form-urlencoded

Responses

200OK — TokenIntrospectionResponse

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

POST/connect/revoke

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

object as application/x-www-form-urlencoded

Responses

200OK

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

Userinfo

GET/connect/userinfo

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK

POST/connect/userinfo

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK

VcProofSchemeWithdrawal

GET/api/v1/credentials/proof-schemes/compact-json/dependents

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`issuedBefore`	query	`string (date-time)`	no	—

Request body

No request body.

Responses

200OK — CompactProofDependentsDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

WalletAttestations

POST/api/v1/oid4vc/wallet-attestations

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

WalletAttestationBatchRequest as application/*+json, application/json, text/json

Responses

200OK — WalletAttestationBatchResponse

400Bad Request — ProblemDetails

503Service Unavailable — ProblemDetails

GET/api/v1/oid4vc/wallet-attestations/metadata

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — WalletAttestationMetadataResponse

503Service Unavailable — ProblemDetails

WalletProviderTrustAnchors

GET/api/v1/wallet-provider-trust-anchors

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — WalletProviderTrustAnchorDto[]

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/wallet-provider-trust-anchors

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

RegisterWalletProviderTrustAnchorRequest as application/*+json, application/json, text/json

Responses

201Created — WalletProviderTrustAnchorDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/wallet-provider-trust-anchors/{anchorId}/keys

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`anchorId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

AddWalletProviderTrustAnchorKeyRequest as application/*+json, application/json, text/json

Responses

200OK — WalletProviderTrustAnchorDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

POST/api/v1/wallet-provider-trust-anchors/{anchorId}/revoke

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`anchorId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RevokeWalletProviderTrustAnchorRequest as application/*+json, application/json, text/json

Responses

200OK — WalletProviderTrustAnchorDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

WellKnown

GET/.well-known/credentials/jwks.json

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`instanceId`	query	`string (uuid)`	no	—

Request body

No request body.

Responses

200OK — JwksDto

404Not Found — ProblemDetails

503Service Unavailable — ProblemDetails

GET/.well-known/did.json

Authentication:oauth2 (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
`instanceId`	query	`string (uuid)`	no	—

Request body

No request body.

Responses

200OK — DidDocumentDto

404Not Found — ProblemDetails

WorkforceProvisioning

GET/api/v1/workforce/provisioning-status

Authentication:oauth2 (the document-wide requirement)

Parameters

Takes no parameters.

Request body

No request body.

Responses

200OK — ProvisioningStatusDto

400Bad Request — ProblemDetails

Schemas

AccountLinkResult

Property	Type	Required	Description
`confidence`	`integer (int32)`	no	—
`errorMessage`	`string \| null`	no	—
`linkId`	`string (uuid) \| null`	no	—
`linkingAttributes`	`map<string, unspecified> \| null`	no	—
`requiresManualReview`	`boolean`	no	—
`success`	`boolean`	no	—

AccreditationRecordDto

Property	Type	Required	Description
`accreditationSchemeId`	`string \| null`	no	—
`asOf`	`string \| null`	no	—
`bodyId`	`string \| null`	no	—
`designatedRoutes`	`string[] \| null`	no	—
`registeredKeyIds`	`string[] \| null`	no	—
`status`	`string \| null`	no	—

AccreditationStatusChangeRequest

Property	Type	Required	Description
`reason`	`string \| null`	no	—

AccreditBodyRequest

Property	Type	Required	Description
`accreditationSchemeId`	`string \| null`	no	—
`bodyId`	`string \| null`	no	—
`bodyName`	`string \| null`	no	—
`designatedRoutes`	`string[] \| null`	no	—
`reason`	`string \| null`	no	—
`registeredKeyIds`	`string[] \| null`	no	—

AccreditedIssuerDesignationDto

Property	Type	Required	Description
`designatedAt`	`string (date-time)`	no	—
`route`	`string \| null`	no	—
`withdrawnAt`	`string (date-time) \| null`	no	—

AccreditedIssuerDto

Property	Type	Required	Description
`accreditationSchemeId`	`string \| null`	no	—
`bodyId`	`string \| null`	no	—
`bodyName`	`string \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`designatedRoutes`	`string[] \| null`	no	—
`id`	`string (uuid)`	no	—
`registeredKeyIds`	`string[] \| null`	no	—
`retiredKeys`	`AccreditedIssuerKeyDto[] \| null`	no	—
`status`	`string \| null`	no	—
`statusChangedAt`	`string (date-time)`	no	—
`statusReason`	`string \| null`	no	—
`updatedAt`	`string (date-time) \| null`	no	—
`withdrawnRoutes`	`AccreditedIssuerDesignationDto[] \| null`	no	—

AccreditedIssuerKeyDto

Property	Type	Required	Description
`keyId`	`string \| null`	no	—
`registeredAt`	`string (date-time)`	no	—
`retiredAt`	`string (date-time) \| null`	no	—
`retirementReason`	`string \| null`	no	—

AddClientSecretRequest

Property	Type	Required	Description
`description`	`string \| null`	no	—
`expiresInDays`	`integer (int32) \| null`	no	—

AddWalletProviderTrustAnchorKeyRequest

Property	Type	Required	Description
`keyId`	`string \| null`	no	—
`publicJwkJson`	`string \| null`	no	—

AttestMappingsRequest

Property	Type	Required	Description
`claimSetHash`	`string \| null`	no	—

AttributeMappingDto

Property	Type	Required	Description
`id`	`string (uuid) \| null`	no	—
`required`	`boolean`	no	—
`sourceAttribute`	`string \| null`	no	—
`targetAttribute`	`string \| null`	no	—
`transform`	`string \| null`	no	—

BatchCredentialIssuanceDto

Property	Type	Required	Description
`batch_size`	`integer (int32)`	no	—

BindableTenantDto

Property	Type	Required	Description
`isPrimary`	`boolean`	no	—
`name`	`string \| null`	no	—
`tenantId`	`string (uuid)`	no	—

BindIdpToTenantRequest

Property	Type	Required	Description
`tenantId`	`string (uuid)`	no	—

BindingHealthDto

Property	Type	Required	Description
`bindingsByState`	`map<string, integer (int32)> \| null`	no	—
`deadLetteredActionCount`	`integer (int32)`	no	—
`oldestPendingDecidedAt`	`string (date-time) \| null`	no	—
`oldestSourceStaleSince`	`string (date-time) \| null`	no	—
`organizationId`	`string (uuid)`	no	—
`pendingActionCount`	`integer (int32)`	no	—
`policyGaps`	`PolicyGapDto[] \| null`	no	—
`sourceStaleCount`	`integer (int32)`	no	—

BoundAttributeDto

Property	Type	Required	Description
`attributePath`	`string \| null`	no	—
`claimName`	`string \| null`	no	—

ClientDto

Property	Type	Required	Description
`accessTokenLifetime`	`integer (int32)`	no	—
`allowOfflineAccess`	`boolean`	no	—
`allowedGrantTypes`	`string[] \| null`	no	—
`allowedScopes`	`string[] \| null`	no	—
`clientId`	`string \| null`	no	—
`clientName`	`string \| null`	no	—
`clientType`	`string \| null`	no	—
`clientUri`	`string \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`description`	`string \| null`	no	—
`enabled`	`boolean`	no	—
`id`	`string (uuid)`	no	—
`isOid4VcClient`	`boolean`	no	—
`logoUri`	`string \| null`	no	—
`oid4VcClassAssignedAt`	`string (date-time) \| null`	no	—
`postLogoutRedirectUris`	`string[] \| null`	no	—
`redirectUris`	`string[] \| null`	no	—
`refreshTokenLifetime`	`integer (int32)`	no	—
`requireClientSecret`	`boolean`	no	—
`requireConsent`	`boolean`	no	—
`requirePkce`	`boolean`	no	—
`tokenEndpointAuthMethod`	`string \| null`	no	—
`updatedAt`	`string (date-time)`	no	—

ClientSecretResponse

Property	Type	Required	Description
`createdAt`	`string (date-time)`	no	—
`description`	`string \| null`	no	—
`expiresAt`	`string (date-time) \| null`	no	—
`id`	`string (uuid)`	no	—
`secretValue`	`string \| null`	no	—

CompactProofDependentsDto

Property	Type	Required	Description
`asOf`	`string (date-time)`	no	—
`byType`	`CompactProofDependentTypeDto[] \| null`	no	—
`issuedBefore`	`string (date-time)`	no	—
`latestExpiresAt`	`string (date-time) \| null`	no	—
`unlapsed`	`integer (int32)`	no	—
`verdict`	`string \| null`	no	—
`withoutExpiry`	`integer (int32)`	no	—

CompactProofDependentTypeDto

Property	Type	Required	Description
`credentialType`	`string \| null`	no	—
`earliestIssuedAt`	`string (date-time)`	no	—
`latestExpiresAt`	`string (date-time) \| null`	no	—
`unlapsed`	`integer (int32)`	no	—
`withoutExpiry`	`integer (int32)`	no	—

ConsentDto

Property	Type	Required	Description
`clientId`	`string \| null`	no	—
`clientName`	`string \| null`	no	—
`consentType`	`string \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`expiresAt`	`string (date-time) \| null`	no	—
`id`	`string (uuid)`	no	—
`isRevoked`	`boolean`	no	—
`scopes`	`string[] \| null`	no	—
`updatedAt`	`string (date-time)`	no	—
`userId`	`string (uuid)`	no	—

CreateClientRequest

Property	Type	Required	Description
`accessTokenLifetime`	`integer (int32) \| null`	no	—
`allowedGrantTypes`	`string[] \| null`	no	—
`allowedScopes`	`string[] \| null`	no	—
`clientId`	`string \| null`	no	—
`clientName`	`string \| null`	no	—
`clientType`	`string \| null`	no	—
`clientUri`	`string \| null`	no	—
`description`	`string \| null`	no	—
`logoUri`	`string \| null`	no	—
`postLogoutRedirectUris`	`string[] \| null`	no	—
`redirectUris`	`string[] \| null`	no	—
`refreshTokenLifetime`	`integer (int32) \| null`	no	—
`relyingPartyOrganizationId`	`string (uuid) \| null`	no	—
`requireConsent`	`boolean`	no	—
`requirePkce`	`boolean`	no	—

CreateDcqlQueryTemplateRequest

Property	Type	Required	Description
`changeNote`	`string \| null`	no	—
`dcqlJson`	`string \| null`	no	—
`displayName`	`string \| null`	no	—
`origin`	`string \| null`	no	—
`purpose`	`string \| null`	no	—
`templateId`	`string \| null`	no	—

CreateIdpConnectionRequest

Property	Type	Required	Description
`attributeMappings`	`AttributeMappingDto[] \| null`	no	—
`configuration`	`string \| null`	no	—
`connectorType`	`string \| null`	no	—
`description`	`string \| null`	no	—
`enabled`	`boolean`	no	—
`name`	`string \| null`	no	—

CreateMaterialChangePolicyRequestDto

Property	Type	Required	Description
`credentialType`	`string \| null`	no	—
`entries`	`PolicyEntryDto[] \| null`	no	—
`previewToken`	`string \| null`	no	—
`reissueWindow`	`string \| null`	no	—

CreateNominatedWatchRequest

Property	Type	Required	Description
`credentialType`	`string \| null`	no	—
`expiresAt`	`string (date-time) \| null`	no	—
`purpose`	`string \| null`	no	—
`relyingOrganizationId`	`string (uuid) \| null`	no	—
`subjectUserId`	`string (uuid) \| null`	no	—

CreateOid4VcCredentialConfigurationRequest

Property	Type	Required	Description
`batchSize`	`integer (int32) \| null`	no	—
`configurationId`	`string \| null`	no	—
`credentialTypeIdentifier`	`string \| null`	no	—
`display`	`Oid4VcCredentialDisplayDto[] \| null`	no	—
`format`	`string \| null`	no	—
`issuanceCeilingInstances`	`integer (int32) \| null`	no	—
`issuanceCeilingWindowHours`	`integer (int32) \| null`	no	—
`supportsHolderInitiatedRevocation`	`boolean`	no	—
`supportsReissuance`	`boolean`	no	—

CreatePresentationRequestDto

Property	Type	Required	Description
`dcql_query`	`unspecified`	no	—
`purpose`	`string \| null`	no	—

CredentialBatchPoolDto

Property	Type	Required	Description
`credentialConfigurationId`	`string (uuid)`	no	—
`instanceCount`	`integer (int32)`	no	—
`isRevoked`	`boolean`	no	—
`poolId`	`string (uuid)`	no	—
`revokedAt`	`string (date-time) \| null`	no	—
`subjectLinkageErased`	`boolean`	no	—
`validInstanceCount`	`integer (int32)`	no	—

CredentialBatchPoolDtoCursorResult

Property	Type	Required	Description
`hasMore`	`boolean`	no	—
`items`	`CredentialBatchPoolDto[] \| null`	no	—
`nextCursor`	`string \| null`	no	—
`pageSize`	`integer (int32)`	no	—
`previousCursor`	`string \| null`	no	—

CredentialClaimDescriptionDto

Property	Type	Required	Description
`mandatory`	`boolean`	no	—
`path`	`string[] \| null`	no	—

CredentialConfigurationMetadataDto

Property	Type	Required	Description
`batch_credential_issuance`	`BatchCredentialIssuanceDto`	no	—
`claims`	`CredentialClaimDescriptionDto[] \| null`	no	—
`credential_signing_alg_values_supported`	`string[] \| null`	no	—
`cryptographic_binding_methods_supported`	`string[] \| null`	no	—
`display`	`CredentialDisplayDto[] \| null`	no	—
`format`	`string \| null`	no	—
`holder_initiated_revocation_supported`	`boolean`	no	—
`reissuance`	`ReissuanceAdvertisementDto`	no	—
`reissuance_supported`	`boolean`	no	—
`vct`	`string \| null`	no	—

CredentialDisplayDto

Property	Type	Required	Description
`locale`	`string \| null`	no	—
`name`	`string \| null`	no	—

CredentialIssuanceResponse

Property	Type	Required	Description
`credentials`	`IssuedCredentialEnvelope[] \| null`	no	—
`notification_id`	`string \| null`	no	—

CredentialIssuerMetadataDto

Property	Type	Required	Description
`authorization_servers`	`string[] \| null`	no	—
`credential_configurations_supported`	`map<string, CredentialConfigurationMetadataDto> \| null`	no	—
`credential_endpoint`	`string \| null`	no	—
`credential_issuer`	`string \| null`	no	—
`deferred_credential_endpoint`	`string \| null`	no	—
`nonce_endpoint`	`string \| null`	no	—
`notification_endpoint`	`string \| null`	no	—

CredentialNotificationRequest

Property	Type	Required	Description
`event`	`string \| null`	no	—
`event_description`	`string \| null`	no	—
`notification_id`	`string \| null`	no	—

CredentialOfferDocument

Property	Type	Required	Description
`credential_configuration_ids`	`string[] \| null`	no	—
`credential_issuer`	`string \| null`	no	—
`grants`	`CredentialOfferGrants`	no	—

CredentialOfferGrants

Property	Type	Required	Description
`urn:ietf:params:oauth:grant-type:pre-authorized_code`	`PreAuthorizedCodeGrant`	no	—

CredentialRequest

Property	Type	Required	Description
`credential_configuration_id`	`string \| null`	no	—
`proofs`	`CredentialRequestProofs`	no	—

CredentialRequestProof

Property	Type	Required	Description
`jwt`	`string \| null`	no	—
`proof_type`	`string \| null`	no	—

CredentialRequestProofs

Property	Type	Required	Description
`jwt`	`string[] \| null`	no	—

DcqlDisclosurePreviewDto

Property	Type	Required	Description
`credentials`	`DcqlPreviewCredentialDto[] \| null`	no	—
`hasOverRequest`	`boolean`	no	—
`warnings`	`DcqlPreviewWarningDto[] \| null`	no	—

DcqlPreviewClaimDto

Property	Type	Required	Description
`disclosedClaim`	`string \| null`	no	—
`disclosesMoreThanRequested`	`boolean`	no	—
`requestedPaths`	`string[] \| null`	no	—
`valueConstrained`	`boolean`	no	—

DcqlPreviewCredentialDto

Property	Type	Required	Description
`acceptedCredentialTypes`	`string[] \| null`	no	—
`disclosedClaims`	`DcqlPreviewClaimDto[] \| null`	no	—
`disclosesEveryClaim`	`boolean`	no	—
`mayReturnMultiple`	`boolean`	no	—
`purpose`	`string \| null`	no	—
`queryId`	`string \| null`	no	—
`requirement`	`string \| null`	no	—

DcqlPreviewWarningDto

Property	Type	Required	Description
`claimName`	`string \| null`	no	—
`code`	`string \| null`	no	—
`credentialQueryId`	`string \| null`	no	—
`message`	`string \| null`	no	—
`severity`	`string \| null`	no	—

DcqlQueryPreviewResponse

Property	Type	Required	Description
`error`	`string \| null`	no	—
`isValid`	`boolean`	no	—
`preview`	`DcqlDisclosurePreviewDto`	no	—

DcqlQueryTemplateDto

Property	Type	Required	Description
`activePreview`	`DcqlDisclosurePreviewDto`	no	—
`activePreviewError`	`string \| null`	no	—
`activeVersionNumber`	`integer (int32)`	no	—
`displayName`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`isRetired`	`boolean`	no	—
`retiredAt`	`string (date-time) \| null`	no	—
`templateId`	`string \| null`	no	—
`tenantId`	`string (uuid)`	no	—
`versions`	`DcqlQueryTemplateVersionDto[] \| null`	no	—

DcqlQueryTemplateVersionDto

Property	Type	Required	Description
`changeNote`	`string \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`dcqlJson`	`string \| null`	no	—
`isActive`	`boolean`	no	—
`origin`	`string \| null`	no	—
`purpose`	`string \| null`	no	—
`supersededAt`	`string (date-time) \| null`	no	—
`versionNumber`	`integer (int32)`	no	—

DesignateRouteRequest

Property	Type	Required	Description
`route`	`string \| null`	no	—

DidDocumentDto

Property	Type	Required	Description
`@context`	`string[] \| null`	no	—
`assertionMethod`	`string[] \| null`	no	—
`authentication`	`string[] \| null`	no	—
`id`	`string \| null`	no	—
`verificationMethod`	`VerificationMethodDto[] \| null`	no	—

DomainOwnershipChallengeDto

Property	Type	Required	Description
`checkCount`	`integer (int32)`	no	—
`clientId`	`string \| null`	no	—
`dnsTxtName`	`string \| null`	no	—
`dnsTxtValue`	`string \| null`	no	—
`domain`	`string \| null`	no	—
`expiresAt`	`string (date-time)`	no	—
`id`	`string (uuid)`	no	—
`lastCheckedAt`	`string (date-time) \| null`	no	—
`method`	`string \| null`	no	—
`proofExpiresAt`	`string (date-time) \| null`	no	—
`proofReference`	`string \| null`	no	—
`proofValid`	`boolean`	no	—
`provenAt`	`string (date-time) \| null`	no	—
`revokedAt`	`string (date-time) \| null`	no	—
`revokedReason`	`string \| null`	no	—
`status`	`string \| null`	no	—

DomainOwnershipProofDto

Property	Type	Required	Description
`domain`	`string \| null`	no	—
`expiresAt`	`string (date-time)`	no	—
`method`	`string \| null`	no	—
`provenAt`	`string (date-time)`	no	—
`reference`	`string \| null`	no	—

EnforcementPolicyDto

Property	Type	Required	Description
`affectedMemberCount`	`integer (int32) \| null`	no	—
`allowedDomains`	`string[] \| null`	no	—
`breakGlassUserIds`	`string[] \| null`	no	—
`enforced`	`boolean`	no	—
`enforcedAt`	`string (date-time) \| null`	no	—
`passwordFallback`	`string \| null`	no	—
`pilotGroup`	`string \| null`	no	—
`pilotGroupRemovedFromDirectoryAt`	`string (date-time) \| null`	no	—
`scope`	`string \| null`	no	—
`suspendedAt`	`string (date-time) \| null`	no	—

EnforcementPolicyInput

Property	Type	Required	Description
`allowedDomains`	`string[] \| null`	no	—
`breakGlassUserIds`	`string[] \| null`	no	—
`passwordFallback`	`string \| null`	no	—
`pilotGroup`	`string \| null`	no	—
`scope`	`string \| null`	no	—

EnforceSsoRequest

Property	Type	Required	Description
`acknowledged`	`boolean`	no	—
`allowedDomains`	`string[] \| null`	no	—
`breakGlassUserIds`	`string[] \| null`	no	—
`passwordFallback`	`string \| null`	no	—
`pilotGroup`	`string \| null`	no	—
`scope`	`string \| null`	no	—

GrantConsentRequest

Property	Type	Required	Description
`clientId`	`string \| null`	no	—
`expirationDays`	`integer (int32) \| null`	no	—
`rememberConsent`	`boolean`	no	—
`scopes`	`string[] \| null`	no	—
`userId`	`string (uuid)`	no	—

HaipConformanceClauseDto

Property	Type	Required	Description
`evidence`	`string \| null`	no	—
`requirement`	`string \| null`	no	—
`satisfied`	`boolean`	no	—
`scopedToClient`	`boolean`	no	—
`title`	`string \| null`	no	—

IdentityBindingDto

Property	Type	Required	Description
`boundAttributes`	`BoundAttributeDto[] \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`credentialRef`	`string \| null`	no	—
`didRef`	`string \| null`	no	—
`enterpriseSubjectExternalId`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`lifecycleState`	`string \| null`	no	—
`materialChangePolicyId`	`string (uuid) \| null`	no	—
`ordering`	`string \| null`	no	—
`organizationId`	`string (uuid)`	no	—
`sourceLastSeenAt`	`string (date-time)`	no	—
`sourceStaleSince`	`string (date-time) \| null`	no	—

IdentityBindingDtoCursorResult

Property	Type	Required	Description
`hasMore`	`boolean`	no	—
`items`	`IdentityBindingDto[] \| null`	no	—
`nextCursor`	`string \| null`	no	—
`pageSize`	`integer (int32)`	no	—
`previousCursor`	`string \| null`	no	—

IdpConnectionDto

Property	Type	Required	Description
`attributeMappings`	`AttributeMappingDto[] \| null`	no	—
`configuration`	`string \| null`	no	—
`connectorType`	`string \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`description`	`string \| null`	no	—
`directoryReturnWindowDays`	`integer (int32) \| null`	no	—
`enabled`	`boolean`	no	—
`id`	`string (uuid)`	no	—
`isDefault`	`boolean`	no	—
`lastSyncCompletedAt`	`string (date-time) \| null`	no	—
`lastSyncStatus`	`string \| null`	no	—
`name`	`string \| null`	no	—
`nextSyncScheduledAt`	`string (date-time) \| null`	no	—
`signingCertificateExpiresAt`	`string (date-time) \| null`	no	—
`signingCertificateSubject`	`string \| null`	no	—
`syncFrequencyMinutes`	`integer (int32) \| null`	no	—
`updatedAt`	`string (date-time) \| null`	no	—

IdpEntitlementDto

Property	Type	Required	Description
`scimEntitled`	`boolean`	no	—
`ssoEntitled`	`boolean`	no	—
`tier`	`string \| null`	no	—
`upgradeUrl`	`string \| null`	no	—

IdpTenantBindingDto

Property	Type	Required	Description
`boundTenantId`	`string (uuid) \| null`	no	—
`boundTenantName`	`string \| null`	no	—
`connectionId`	`string (uuid)`	no	—

ImportPresentationExchangeRequest

Property	Type	Required	Description
`changeNote`	`string \| null`	no	—
`displayName`	`string \| null`	no	—
`presentationDefinitionJson`	`string \| null`	no	—
`purpose`	`string \| null`	no	—
`templateId`	`string \| null`	no	—

IssueCredentialRequest

Property	Type	Required	Description
`credentialHash`	`string \| null`	no	—
`credentialSubject`	`map<string, unspecified> \| null`	no	—
`credentialType`	`string \| null`	no	—
`expiresAt`	`string (date-time) \| null`	no	—
`instanceId`	`string (uuid)`	no	—
`subjectDid`	`string \| null`	no	—
`subjectUserId`	`string (uuid)`	no	—
`vaultDocumentId`	`string (uuid) \| null`	no	—

IssuedCredentialDto

Property	Type	Required	Description
`credentialHash`	`string \| null`	no	—
`credentialJson`	`string \| null`	no	—
`credentialType`	`string \| null`	no	—
`expiresAt`	`string (date-time) \| null`	no	—
`id`	`string (uuid)`	no	—
`isExpired`	`boolean`	no	—
`isRevoked`	`boolean`	no	—
`issuedAt`	`string (date-time)`	no	—
`issuerId`	`string (uuid)`	no	—
`notStoredReason`	`string \| null`	no	—
`revocationReason`	`string \| null`	no	—
`revokedAt`	`string (date-time) \| null`	no	—
`statusListIndex`	`integer (int32)`	no	—
`storage`	`string \| null`	no	—
`subjectUserId`	`string (uuid)`	no	—
`vaultDocumentId`	`string (uuid) \| null`	no	—

IssuedCredentialDtoCursorResult

Property	Type	Required	Description
`hasMore`	`boolean`	no	—
`items`	`IssuedCredentialDto[] \| null`	no	—
`nextCursor`	`string \| null`	no	—
`pageSize`	`integer (int32)`	no	—
`previousCursor`	`string \| null`	no	—

IssuedCredentialEnvelope

Property	Type	Required	Description
`credential`	`string \| null`	no	—

JwksDto

Property	Type	Required	Description
`keys`	`unspecified[] \| null`	no	—

LifecycleActionDto

Property	Type	Required	Description
`actionId`	`string (uuid)`	no	—
`actor`	`string \| null`	no	—
`affectedClaimNames`	`string[] \| null`	no	—
`attempts`	`integer (int32)`	no	—
`attributePath`	`string \| null`	no	—
`bindingId`	`string (uuid)`	no	—
`decidedAt`	`string (date-time)`	no	—
`executedAt`	`string (date-time) \| null`	no	—
`idempotencyKey`	`string \| null`	no	—
`lastErrorCode`	`string \| null`	no	—
`newDigest`	`string \| null`	no	—
`outcome`	`string \| null`	no	—
`policyVersion`	`string \| null`	no	—
`priorDigest`	`string \| null`	no	—
`provenance`	`string \| null`	no	—
`sequence`	`integer (int64)`	no	—
`sourcePushRef`	`string \| null`	no	—
`status`	`string \| null`	no	—

LifecycleActionDtoCursorResult

Property	Type	Required	Description
`hasMore`	`boolean`	no	—
`items`	`LifecycleActionDto[] \| null`	no	—
`nextCursor`	`string \| null`	no	—
`pageSize`	`integer (int32)`	no	—
`previousCursor`	`string \| null`	no	—

LinkAccountRequest

Property	Type	Required	Description
`connectionId`	`string (uuid)`	no	—
`externalUserId`	`string \| null`	yes	—
`linkType`	`string \| null`	no	—
`linkedBy`	`string (uuid) \| null`	no	—
`linkingAttributes`	`map<string, unspecified> \| null`	no	—
`manualConfidence`	`integer (int32) \| null`	no	—
`userId`	`string (uuid)`	no	—

LinkedAccountDto

Property	Type	Required	Description
`confidence`	`integer (int32)`	no	—
`connectionId`	`string (uuid)`	no	—
`connectionName`	`string \| null`	no	—
`connectorType`	`string \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`directoryRemovedAt`	`string (date-time) \| null`	no	—
`externalUserId`	`string \| null`	no	—
`isVerified`	`boolean`	no	—
`lastUsedAt`	`string (date-time) \| null`	no	—
`linkId`	`string (uuid)`	no	—
`linkType`	`string \| null`	no	—
`linkingAttributes`	`map<string, unspecified> \| null`	no	—
`useCount`	`integer (int32)`	no	—
`userId`	`string (uuid)`	no	—
`verifiedAt`	`string (date-time) \| null`	no	—

MappingAttestationDto

Property	Type	Required	Description
`attested`	`boolean`	no	—
`attestedAt`	`string (date-time) \| null`	no	—
`attestedBy`	`string \| null`	no	—
`attestedByName`	`string \| null`	no	—
`attestedClaimSetHash`	`string \| null`	no	—
`currentClaimSetHash`	`string \| null`	no	—

MaterialChangePolicyDto

Property	Type	Required	Description
`createdAt`	`string (date-time)`	no	—
`credentialType`	`string \| null`	no	—
`entries`	`PolicyEntryDto[] \| null`	no	—
`id`	`string (uuid)`	no	—
`organizationId`	`string (uuid)`	no	—
`reissueWindow`	`string \| null`	no	—
`updatedAt`	`string (date-time) \| null`	no	—
`version`	`string \| null`	no	—

MintCredentialOfferRequest

Property	Type	Required	Description
`byReference`	`boolean`	no	—
`credentialConfigurationId`	`string (uuid)`	no	—
`lifetimeSeconds`	`integer (int32)`	no	—
`requireTransactionCode`	`boolean`	no	—
`subjectPseudonym`	`string \| null`	no	—
`transactionCodeDescription`	`string \| null`	no	—
`transactionCodeLength`	`integer (int32) \| null`	no	—

MintCredentialOfferResponse

Property	Type	Required	Description
`byReference`	`boolean`	no	—
`expiresAt`	`string (date-time)`	no	—
`offerId`	`string (uuid)`	no	—
`preAuthorizedCode`	`string \| null`	no	—
`transactionCode`	`string \| null`	no	—
`transactionCodeEntropy`	`TransactionCodeEntropyDto`	no	—

NominatedCredentialWatchDto

Property	Type	Required	Description
`createdAt`	`string (date-time)`	no	—
`credentialType`	`string \| null`	no	—
`endReason`	`string \| null`	no	—
`expiresAt`	`string (date-time) \| null`	no	—
`id`	`string (uuid)`	no	—
`lastNotifiedAt`	`string (date-time) \| null`	no	—
`lastNotifiedStatus`	`string \| null`	no	—
`permissionEndedAt`	`string (date-time) \| null`	no	—
`permissionGrantedAt`	`string (date-time) \| null`	no	—
`purpose`	`string \| null`	no	—
`relyingOrganizationId`	`string (uuid)`	no	—
`status`	`string \| null`	no	—
`subjectHoldsWatchedCredential`	`boolean \| null`	no	—
`subjectUserId`	`string (uuid)`	no	—

NonceResponse

Property	Type	Required	Description
`c_nonce`	`string \| null`	no	—

Oid4VcClientPostureDto

Property	Type	Required	Description
`clientId`	`string \| null`	no	—
`clientName`	`string \| null`	no	—
`clientType`	`string \| null`	no	—
`createdAt`	`string (date-time)`	no	—
`enabled`	`boolean`	no	—
`haipClauses`	`HaipConformanceClauseDto[] \| null`	no	—
`haipConformance`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`isOid4VcClient`	`boolean`	no	—
`oid4VcClassAssignedAt`	`string (date-time) \| null`	no	—
`requirePkce`	`boolean`	no	—
`tokenEndpointAuthMethod`	`string \| null`	no	—

Oid4VcClientPostureDtoPagedResult

Property	Type	Required	Description
`hasNextPage`	`boolean`	no	—
`hasPreviousPage`	`boolean`	no	—
`items`	`Oid4VcClientPostureDto[] \| null`	no	—
`pageNumber`	`integer (int32)`	no	—
`pageSize`	`integer (int32)`	no	—
`totalCount`	`integer (int32)`	no	—
`totalPages`	`integer (int32)`	no	—

Oid4VcCredentialConfigurationDto

Property	Type	Required	Description
`batchSize`	`integer (int32)`	no	—
`configurationId`	`string \| null`	no	—
`credentialTypeIdentifier`	`string \| null`	no	—
`display`	`Oid4VcCredentialDisplayDto[] \| null`	no	—
`format`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`isPublished`	`boolean`	no	—
`issuanceCeilingInstances`	`integer (int32)`	no	—
`issuanceCeilingWindowHours`	`integer (int32)`	no	—
`supportsHolderInitiatedRevocation`	`boolean`	no	—
`supportsReissuance`	`boolean`	no	—
`tenantId`	`string (uuid)`	no	—

Oid4VcCredentialDisplayDto

Property	Type	Required	Description
`locale`	`string \| null`	no	—
`name`	`string \| null`	no	—

Oid4VciAuthorizationDetail

Property	Type	Required	Description
`credential_configuration_id`	`string \| null`	no	—
`type`	`string \| null`	no	—

Oid4VciReissuanceRequest

Property	Type	Required	Description
`credential_configuration_id`	`string \| null`	no	—
`prior_credential`	`string \| null`	no	—
`prior_key_proof`	`CredentialRequestProof`	no	—
`proofs`	`CredentialRequestProofs`	no	—

Oid4VciReissuanceResponse

Property	Type	Required	Description
`credentials`	`IssuedCredentialEnvelope[] \| null`	no	—

Oid4VciTokenResponse

Property	Type	Required	Description
`access_token`	`string \| null`	no	—
`authorization_details`	`Oid4VciAuthorizationDetail[] \| null`	no	—
`expires_in`	`integer (int32)`	no	—
`token_type`	`string \| null`	no	—

Oid4VcProtocolErrorResponse

Property	Type	Required	Description
`c_nonce`	`string \| null`	no	—
`error`	`string \| null`	no	—
`error_description`	`string \| null`	no	—

Oid4VcStatusListHealthDto

Property	Type	Required	Description
`degradedIssuerCount`	`integer (int32)`	no	—
`issuers`	`Oid4VcStatusListIssuerHealthDto[] \| null`	no	—
`issuersOmitted`	`integer (int32)`	no	—
`observedAt`	`string (date-time)`	no	—
`observedBy`	`string \| null`	no	—

Oid4VcStatusListIssuerHealthDto

Property	Type	Required	Description
`circuitOpenCount`	`integer (int32)`	no	—
`circuitOpenedAt`	`string (date-time) \| null`	no	—
`circuitState`	`string \| null`	no	—
`concurrentFetchLimit`	`integer (int32)`	no	—
`degraded`	`boolean`	no	—
`issuerOrigin`	`string \| null`	no	—
`lastOutcome`	`string \| null`	no	—
`lastOutcomeAt`	`string (date-time) \| null`	no	—
`lastReason`	`string \| null`	no	—
`outcomes`	`map<string, integer (int64)> \| null`	no	—
`probeEligibleAt`	`string (date-time) \| null`	no	—

Oid4VpRequestBehaviourDto

Property	Type	Required	Description
`authorizationRequestScheme`	`string \| null`	no	—
`channels`	`Oid4VpRequestChannelDto[] \| null`	no	—
`clientId`	`string \| null`	no	—
`configured`	`boolean`	no	—
`limitations`	`string[] \| null`	no	—
`requestLifetimeSeconds`	`integer (int32)`	no	—
`requestObjectMediaType`	`string \| null`	no	—
`requestPassing`	`string \| null`	no	—
`responseMode`	`string \| null`	no	—

Oid4VpRequestChannelDto

Property	Type	Required	Description
`channel`	`string \| null`	no	—
`handsBack`	`boolean`	no	—
`outcomeDelivery`	`string \| null`	no	—
`requestDelivery`	`string \| null`	no	—

Oid4VpResponseEncryptionKeyDto

Property	Type	Required	Description
`algorithm`	`string \| null`	no	—
`curve`	`string \| null`	no	—
`keyId`	`string \| null`	no	—
`role`	`string \| null`	no	—

Oid4VpResponseEncryptionKeysDto

Property	Type	Required	Description
`activeKeyId`	`string \| null`	no	—
`configured`	`boolean`	no	—
`contentEncryptionAlgorithm`	`string \| null`	no	—
`keyManagementAlgorithm`	`string \| null`	no	—
`keys`	`Oid4VpResponseEncryptionKeyDto[] \| null`	no	—
`problems`	`string[] \| null`	no	—
`requestLifetimeSeconds`	`integer (int32)`	no	—
`responseMode`	`string \| null`	no	—

Oid4VpVerifierCertificateDto

Property	Type	Required	Description
`canMintRequests`	`boolean`	no	—
`clientId`	`string \| null`	no	—
`configured`	`boolean`	no	—
`daysUntilExpiry`	`integer (int32)`	no	—
`dnsNames`	`string[] \| null`	no	—
`expiringSoon`	`boolean`	no	—
`hostCovered`	`boolean`	no	—
`issuer`	`string \| null`	no	—
`notAfter`	`string (date-time) \| null`	no	—
`notBefore`	`string (date-time) \| null`	no	—
`refusalReasons`	`string[] \| null`	no	—
`responseHost`	`string \| null`	no	—
`subject`	`string \| null`	no	—
`thumbprint`	`string \| null`	no	—
`validity`	`string \| null`	no	—

PolicyEntryDto

Property	Type	Required	Description
`attributePath`	`string \| null`	no	—
`outcome`	`string \| null`	no	—

PolicyGapDto

Property	Type	Required	Description
`acknowledgedAt`	`string (date-time) \| null`	no	—
`acknowledgedBy`	`string \| null`	no	—
`attributePath`	`string \| null`	no	—
`bindingId`	`string (uuid)`	no	—
`firstSeenAt`	`string (date-time)`	no	—
`id`	`string (uuid)`	no	—
`lastSeenAt`	`string (date-time)`	no	—
`occurrenceCount`	`integer (int32)`	no	—
`organizationId`	`string (uuid)`	no	—

PolicyPreviewLineDto

Property	Type	Required	Description
`affectedClaimNames`	`string[] \| null`	no	—
`attributePath`	`string \| null`	no	—
`effect`	`string \| null`	no	—
`outcome`	`string \| null`	no	—
`supportedByCredentialType`	`boolean`	no	—

PolicyPreviewResultDto

Property	Type	Required	Description
`credentialType`	`string \| null`	no	—
`lines`	`PolicyPreviewLineDto[] \| null`	no	—
`previewToken`	`string \| null`	no	—

PreAuthorizedCodeGrant

Property	Type	Required	Description
`pre-authorized_code`	`string \| null`	no	—
`tx_code`	`TransactionCodeMetadata`	no	—

PresentationCredentialOutcomeDto

Property	Type	Required	Description
`claims`	`map<string, unspecified[]> \| null`	no	—
`id`	`string \| null`	no	—
`reason`	`string \| null`	no	—
`satisfied`	`boolean`	no	—
`unsatisfiedClaims`	`string[] \| null`	no	—

PresentationRequestDto

Property	Type	Required	Description
`authorizationRequestUri`	`string \| null`	no	—
`clientId`	`string \| null`	no	—
`expiresAt`	`string (date-time)`	no	—
`requestUri`	`string \| null`	no	—
`transactionId`	`string \| null`	no	—

PresentationResultDto

Property	Type	Required	Description
`completedAt`	`string (date-time) \| null`	no	—
`credentials`	`PresentationCredentialOutcomeDto[] \| null`	no	—
`expiresAt`	`string (date-time)`	no	—
`reason`	`string \| null`	no	—
`status`	`string \| null`	no	—
`transactionId`	`string \| null`	no	—

PreviewDcqlQueryRequest

Property	Type	Required	Description
`dcqlJson`	`string \| null`	no	—
`purpose`	`string \| null`	no	—

PreviewMaterialChangePolicyRequestDto

Property	Type	Required	Description
`credentialType`	`string \| null`	no	—
`entries`	`PolicyEntryDto[] \| null`	no	—
`reissueWindow`	`string \| null`	no	—

PrivacyDegradationEpisodeDto

Property	Type	Required	Description
`cause`	`string \| null`	no	—
`credentialConfigurationId`	`string (uuid)`	no	—
`credentialConfigurationIdentifier`	`string \| null`	no	—
`durationSeconds`	`integer (int64)`	no	—
`id`	`string (uuid)`	no	—
`lastRefusedAt`	`string (date-time)`	no	—
`refusedAttemptCount`	`integer (int32)`	no	—
`remedyRequirement`	`string \| null`	no	—
`startedAt`	`string (date-time)`	no	—

PrivacyDegradationExportDto

Property	Type	Required	Description
`episodes`	`PrivacyDegradationEpisodeDto[] \| null`	no	—
`generatedAt`	`string (date-time)`	no	—
`lapseIntervalHours`	`number (double)`	no	—
`measure`	`string \| null`	no	—
`notMeasured`	`string \| null`	no	—
`requirement`	`string \| null`	no	—
`sinceUtc`	`string (date-time) \| null`	no	—
`tenantId`	`string (uuid)`	no	—

PrivacyDegradationRegisterDto

Property	Type	Required	Description
`episodes`	`PrivacyDegradationEpisodeDto[] \| null`	no	—
`generatedAt`	`string (date-time)`	no	—
`lapseIntervalHours`	`number (double)`	no	—
`measure`	`string \| null`	no	—
`sinceUtc`	`string (date-time) \| null`	no	—
`tenantId`	`string (uuid)`	no	—

ProblemDetails

Property	Type	Required	Description
`detail`	`string \| null`	no	—
`instance`	`string \| null`	no	—
`status`	`integer (int32) \| null`	no	—
`title`	`string \| null`	no	—
`type`	`string \| null`	no	—

ProvisioningStatusDto

Property	Type	Required	Description
`adminContactEmail`	`string \| null`	no	—
`idpName`	`string \| null`	no	—
`organizationName`	`string \| null`	no	—
`state`	`string \| null`	no	—
`subjectEmailMasked`	`string \| null`	no	—
`workspaceUrl`	`string \| null`	no	—

RaiseIssuanceCeilingOutcomeDto

Property	Type	Required	Description
`credentialConfigurationId`	`string (uuid)`	no	—
`credentialConfigurationIdentifier`	`string \| null`	no	—
`detail`	`string \| null`	no	—
`previousCeilingInstances`	`integer (int32) \| null`	no	—
`raised`	`boolean`	no	—

RaiseIssuanceCeilingsRequest

Property	Type	Required	Description
`credentialConfigurationIds`	`(string (uuid))[] \| null`	no	—
`issuanceCeilingInstances`	`integer (int32)`	no	—

RaiseIssuanceCeilingsResponse

Property	Type	Required	Description
`issuanceCeilingInstances`	`integer (int32)`	no	—
`outcomes`	`RaiseIssuanceCeilingOutcomeDto[] \| null`	no	—
`raisedCount`	`integer (int32)`	no	—

RecordCredentialVaultDocumentRequest

Property	Type	Required	Description
`vaultDocumentId`	`string (uuid)`	no	—

RegisterIssuerKeyRequest

Property	Type	Required	Description
`keyId`	`string \| null`	no	—

RegisterRelyingPartyRequest

Property	Type	Required	Description
`legalName`	`string \| null`	no	—
`organizationId`	`string (uuid)`	no	—
`purposes`	`RelyingPartyPurposeRequest[] \| null`	no	—
`termsAcceptance`	`RelyingPartyTermsAcceptanceRequest`	no	—

RegisterWalletProviderTrustAnchorRequest

Property	Type	Required	Description
`displayName`	`string \| null`	no	—
`keyId`	`string \| null`	no	—
`notAfter`	`string (date-time) \| null`	no	—
`notBefore`	`string (date-time) \| null`	no	—
`providerIdentifier`	`string \| null`	no	—
`publicJwkJson`	`string \| null`	no	—

ReinstateBindingRequestDto

Property	Type	Required	Description
`reasonToken`	`string \| null`	no	—

ReissuanceAdvertisementDto

Property	Type	Required	Description
`endpoint`	`string \| null`	no	—
`mechanism`	`string \| null`	no	—
`supported`	`boolean`	no	—

RelyingPartyDto

Property	Type	Required	Description
`clientIds`	`string[] \| null`	no	—
`currentTermsVersions`	`string[] \| null`	no	—
`hasAcceptedCurrentTerms`	`boolean`	no	—
`id`	`string (uuid)`	no	—
`legalName`	`string \| null`	no	—
`organizationId`	`string (uuid)`	no	—
`purposes`	`RelyingPartyPurposeDto[] \| null`	no	—
`termsAcceptances`	`RelyingPartyTermsAcceptanceDto[] \| null`	no	—

RelyingPartyPurposeDto

Property	Type	Required	Description
`code`	`string \| null`	no	—
`declaredAt`	`string (date-time)`	no	—
`declaredBy`	`string \| null`	no	—
`description`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`lawfulBasis`	`string \| null`	no	—

RelyingPartyPurposeRequest

Property	Type	Required	Description
`code`	`string \| null`	no	—
`description`	`string \| null`	no	—
`lawfulBasis`	`string \| null`	no	—

RelyingPartyTermsAcceptanceDto

Property	Type	Required	Description
`acceptedAt`	`string (date-time)`	no	—
`acceptedByName`	`string \| null`	no	—
`acceptedByRole`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`organizationId`	`string (uuid)`	no	—
`recordedAt`	`string (date-time)`	no	—
`recordedBy`	`string \| null`	no	—
`termsVersion`	`string \| null`	no	—

RelyingPartyTermsAcceptanceRequest

Property	Type	Required	Description
`acceptedAt`	`string (date-time) \| null`	no	—
`acceptedByName`	`string \| null`	no	—
`acceptedByRole`	`string \| null`	no	—
`termsVersion`	`string \| null`	no	—

RenameDcqlQueryTemplateRequest

Property	Type	Required	Description
`displayName`	`string \| null`	no	—

RetireIssuerKeyRequest

Property	Type	Required	Description
`reason`	`string \| null`	no	—

ReviseDcqlQueryTemplateRequest

Property	Type	Required	Description
`changeNote`	`string \| null`	no	—
`dcqlJson`	`string \| null`	no	—
`origin`	`string \| null`	no	—
`purpose`	`string \| null`	no	—

RevokeCredentialPoolRequest

Property	Type	Required	Description
`reason`	`string \| null`	no	—

RevokeCredentialRequest

Property	Type	Required	Description
`reason`	`string \| null`	no	—

RevokeDomainOwnershipRequest

Property	Type	Required	Description
`reason`	`string \| null`	no	—

RevokeWalletProviderTrustAnchorRequest

Property	Type	Required	Description
`keyId`	`string \| null`	no	—
`reason`	`string \| null`	no	—

RotateIssuerKeyRequest

Property	Type	Required	Description
`incomingKeyId`	`string \| null`	no	—
`outgoingKeyId`	`string \| null`	no	—
`reason`	`string \| null`	no	—

RotateVcIssuerKeyRequest

Property	Type	Required	Description
`expectedThumbprint`	`string \| null`	no	—

ScimAddress

Property	Type	Required	Description
`country`	`string \| null`	no	—
`formatted`	`string \| null`	no	—
`locality`	`string \| null`	no	—
`postalCode`	`string \| null`	no	—
`primary`	`boolean`	no	—
`region`	`string \| null`	no	—
`streetAddress`	`string \| null`	no	—
`type`	`string \| null`	no	—

ScimAuthenticationScheme

Property	Type	Required	Description
`description`	`string \| null`	yes	—
`documentationUri`	`string \| null`	no	—
`name`	`string \| null`	yes	—
`specUri`	`string \| null`	no	—
`type`	`string \| null`	yes	—

ScimBoundAttributeWire

Property	Type	Required	Description
`attributePath`	`string \| null`	no	—
`claimName`	`string \| null`	no	—

ScimBulkConfig

Property	Type	Required	Description
`maxOperations`	`integer (int32)`	no	—
`maxPayloadSize`	`integer (int32)`	no	—
`supported`	`boolean`	no	—

ScimConfigDto

Property	Type	Required	Description
`autoDeprovision`	`boolean`	no	—
`autoProvision`	`boolean`	no	—
`baseUrl`	`string \| null`	no	—
`connectionStatus`	`string \| null`	no	—
`enabled`	`boolean`	no	—
`lastSyncAt`	`string (date-time) \| null`	no	—
`lawfulBasis`	`string \| null`	no	—
`lawfulBasisAcknowledgedAt`	`string (date-time) \| null`	no	—
`lawfulBasisAcknowledgedBy`	`string \| null`	no	—
`provisionedAttributes`	`string[] \| null`	no	—
`tokenLastFour`	`string \| null`	no	—
`tokenLastIssuedAt`	`string (date-time) \| null`	no	—

ScimConfigInputDto

Property	Type	Required	Description
`autoDeprovision`	`boolean`	no	—
`autoProvision`	`boolean`	no	—
`enabled`	`boolean`	no	—
`lawfulBasis`	`string \| null`	no	—
`lawfulBasisAcknowledged`	`boolean`	no	—

ScimEmail

Property	Type	Required	Description
`primary`	`boolean`	no	—
`type`	`string \| null`	no	—
`value`	`string \| null`	yes	—

ScimEnterpriseSubjectRefWire

Property	Type	Required	Description
`externalId`	`string \| null`	no	—
`organizationId`	`string (uuid)`	no	—

ScimEnterpriseUser

Property	Type	Required	Description
`costCenter`	`string \| null`	no	—
`department`	`string \| null`	no	—
`division`	`string \| null`	no	—
`employeeNumber`	`string \| null`	no	—
`manager`	`ScimManager`	no	—
`organization`	`string \| null`	no	—

ScimEntitlement

Property	Type	Required	Description
`primary`	`boolean`	no	—
`type`	`string \| null`	no	—
`value`	`string \| null`	yes	—

ScimErrorResponse

Property	Type	Required	Description
`detail`	`string \| null`	no	—
`schemas`	`string[] \| null`	no	—
`scimType`	`string \| null`	no	—
`status`	`integer (int32)`	yes	—

ScimFeatureConfig

Property	Type	Required	Description
`supported`	`boolean`	no	—

ScimFilterConfig

Property	Type	Required	Description
`maxResults`	`integer (int32)`	no	—
`supported`	`boolean`	no	—

ScimGroupReference

Property	Type	Required	Description
`$ref`	`string \| null`	no	—
`display`	`string \| null`	no	—
`type`	`string \| null`	no	—
`value`	`string \| null`	yes	—

ScimIdentityBindingCreateRequest

Property	Type	Required	Description
`boundSourceAttributes`	`ScimBoundAttributeWire[] \| null`	no	—
`credentialRef`	`string \| null`	no	—
`didRef`	`string \| null`	no	—
`externalId`	`string \| null`	no	—
`materialChangePolicyRef`	`string \| null`	no	—
`schemas`	`string[] \| null`	no	—

ScimIdentityBindingDeleteResponse

Property	Type	Required	Description
`detail`	`string \| null`	no	—
`id`	`string \| null`	no	—

ScimIdentityBindingListResponse

Property	Type	Required	Description
`Resources`	`ScimIdentityBindingResource[] \| null`	no	—
`itemsPerPage`	`integer (int32)`	no	—
`schemas`	`string[] \| null`	no	—
`startIndex`	`integer (int32)`	no	—
`totalResults`	`integer (int32)`	no	—

ScimIdentityBindingMetaWire

Property	Type	Required	Description
`created`	`string (date-time)`	no	—
`lastModified`	`string (date-time)`	no	—
`resourceType`	`string \| null`	no	—

ScimIdentityBindingResource

Property	Type	Required	Description
`boundSourceAttributes`	`ScimBoundAttributeWire[] \| null`	no	—
`credentialRef`	`string \| null`	no	—
`didRef`	`string \| null`	no	—
`enterpriseSubjectRef`	`ScimEnterpriseSubjectRefWire`	no	—
`id`	`string \| null`	no	—
`lifecycleState`	`string \| null`	no	—
`materialChangePolicyRef`	`string \| null`	no	—
`meta`	`ScimIdentityBindingMetaWire`	no	—
`schemas`	`string[] \| null`	no	—

ScimIm

Property	Type	Required	Description
`primary`	`boolean`	no	—
`type`	`string \| null`	no	—
`value`	`string \| null`	yes	—

ScimManager

Property	Type	Required	Description
`$ref`	`string \| null`	no	—
`displayName`	`string \| null`	no	—
`value`	`string \| null`	no	—

ScimMeta

Property	Type	Required	Description
`created`	`string (date-time) \| null`	no	—
`lastModified`	`string (date-time) \| null`	no	—
`location`	`string \| null`	no	—
`resourceType`	`string \| null`	no	—
`version`	`string \| null`	no	—

ScimName

Property	Type	Required	Description
`familyName`	`string \| null`	no	—
`formatted`	`string \| null`	no	—
`givenName`	`string \| null`	no	—
`honorificPrefix`	`string \| null`	no	—
`honorificSuffix`	`string \| null`	no	—
`middleName`	`string \| null`	no	—

ScimPatchOperation

Property	Type	Required	Description
`op`	`string \| null`	yes	—
`path`	`string \| null`	no	—
`value`	`unspecified \| null`	no	—

ScimPatchRequest

Property	Type	Required	Description
`Operations`	`ScimPatchOperation[] \| null`	yes	—
`schemas`	`string[] \| null`	no	—

ScimPhoneNumber

Property	Type	Required	Description
`primary`	`boolean`	no	—
`type`	`string \| null`	no	—
`value`	`string \| null`	yes	—

ScimPhoto

Property	Type	Required	Description
`primary`	`boolean`	no	—
`type`	`string \| null`	no	—
`value`	`string \| null`	yes	—

ScimResourceType

Property	Type	Required	Description
`description`	`string \| null`	no	—
`endpoint`	`string \| null`	yes	—
`id`	`string \| null`	no	—
`meta`	`ScimMeta`	no	—
`name`	`string \| null`	yes	—
`schema`	`string \| null`	yes	—
`schemaExtensions`	`ScimSchemaExtension[] \| null`	no	—
`schemas`	`string[] \| null`	no	—

ScimRole

Property	Type	Required	Description
`primary`	`boolean`	no	—
`type`	`string \| null`	no	—
`value`	`string \| null`	yes	—

ScimSchemaExtension

Property	Type	Required	Description
`required`	`boolean`	no	—
`schema`	`string \| null`	yes	—

ScimServiceProviderConfig

Property	Type	Required	Description
`authenticationSchemes`	`ScimAuthenticationScheme[] \| null`	no	—
`bulk`	`ScimBulkConfig`	yes	—
`changePassword`	`ScimFeatureConfig`	yes	—
`documentationUri`	`string \| null`	no	—
`etag`	`ScimFeatureConfig`	yes	—
`filter`	`ScimFilterConfig`	yes	—
`meta`	`ScimMeta`	no	—
`patch`	`ScimFeatureConfig`	yes	—
`schemas`	`string[] \| null`	no	—
`sort`	`ScimFeatureConfig`	yes	—

ScimTokenIssuedDto

Property	Type	Required	Description
`expiresAt`	`string (date-time)`	no	—
`token`	`string \| null`	no	—
`tokenLastFour`	`string \| null`	no	—

ScimUser

Property	Type	Required	Description
`active`	`boolean`	no	—
`addresses`	`ScimAddress[] \| null`	no	—
`displayName`	`string \| null`	no	—
`emails`	`ScimEmail[] \| null`	no	—
`entitlements`	`ScimEntitlement[] \| null`	no	—
`externalId`	`string \| null`	no	—
`groups`	`ScimGroupReference[] \| null`	no	—
`id`	`string \| null`	no	—
`ims`	`ScimIm[] \| null`	no	—
`locale`	`string \| null`	no	—
`meta`	`ScimMeta`	no	—
`name`	`ScimName`	no	—
`nickName`	`string \| null`	no	—
`password`	`string \| null`	no	—
`phoneNumbers`	`ScimPhoneNumber[] \| null`	no	—
`photos`	`ScimPhoto[] \| null`	no	—
`preferredLanguage`	`string \| null`	no	—
`profileUrl`	`string \| null`	no	—
`roles`	`ScimRole[] \| null`	no	—
`schemas`	`string[] \| null`	no	—
`timezone`	`string \| null`	no	—
`title`	`string \| null`	no	—
`urn:ietf:params:scim:schemas:extension:enterprise:2.0:User`	`ScimEnterpriseUser`	no	—
`userName`	`string \| null`	yes	—
`userType`	`string \| null`	no	—
`x509Certificates`	`ScimX509Certificate[] \| null`	no	—

ScimUserScimListResponse

Property	Type	Required	Description
`Resources`	`ScimUser[] \| null`	no	—
`itemsPerPage`	`integer (int32) \| null`	no	—
`schemas`	`string[] \| null`	no	—
`startIndex`	`integer (int32) \| null`	no	—
`totalResults`	`integer (int32)`	no	—

ScimX509Certificate

Property	Type	Required	Description
`primary`	`boolean`	no	—
`type`	`string \| null`	no	—
`value`	`string \| null`	yes	—

StartDomainOwnershipChallengeRequest

Property	Type	Required	Description
`domain`	`string \| null`	no	—

TestIdpConnectionResponse

Property	Type	Required	Description
`error`	`string \| null`	no	—
`ok`	`boolean`	no	—
`rttMs`	`integer (int64)`	no	—

TokenIntrospectionResponse

Property	Type	Required	Description
`active`	`boolean`	no	—
`audience`	`string \| null`	no	—
`clientId`	`string \| null`	no	—
`expiresAt`	`integer (int64) \| null`	no	—
`issuedAt`	`integer (int64) \| null`	no	—
`issuer`	`string \| null`	no	—
`jwtId`	`string \| null`	no	—
`notBefore`	`integer (int64) \| null`	no	—
`scope`	`string \| null`	no	—
`subject`	`string \| null`	no	—
`tokenType`	`string \| null`	no	—
`username`	`string \| null`	no	—

TransactionCodeEntropyDto

Property	Type	Required	Description
`entropyBits`	`number (double)`	no	—
`guessSpace`	`integer (int64)`	no	—
`length`	`integer (int32)`	no	—
`maximumAttempts`	`integer (int32)`	no	—
`residualGuessRiskOneIn`	`integer (int64)`	no	—

TransactionCodeMetadata

Property	Type	Required	Description
`description`	`string \| null`	no	—
`input_mode`	`string \| null`	no	—
`length`	`integer (int32)`	no	—

TransactionCodePolicyDto

Property	Type	Required	Description
`lengths`	`TransactionCodeEntropyDto[] \| null`	no	—
`maximumAttempts`	`integer (int32)`	no	—
`maximumLength`	`integer (int32)`	no	—
`minimumLength`	`integer (int32)`	no	—
`minimumResidualGuessRiskOneIn`	`integer (int32)`	no	—

UpdateIdpConnectionRequest

Property	Type	Required	Description
`attributeMappings`	`AttributeMappingDto[] \| null`	no	—
`configuration`	`string \| null`	no	—
`description`	`string \| null`	no	—
`directoryReturnWindowDays`	`integer (int32) \| null`	no	—
`enabled`	`boolean \| null`	no	—
`name`	`string \| null`	no	—
`resetDirectoryReturnWindow`	`boolean \| null`	no	—
`syncFrequencyMinutes`	`integer (int32) \| null`	no	—

UpdateMaterialChangePolicyRequestDto

Property	Type	Required	Description
`entries`	`PolicyEntryDto[] \| null`	no	—
`previewToken`	`string \| null`	no	—
`reissueWindow`	`string \| null`	no	—

UserProvisioningStatusDto

Property	Type	Required	Description
`detail`	`string \| null`	no	—
`email`	`string \| null`	no	—
`lastAttemptAt`	`string (date-time) \| null`	no	—
`state`	`string \| null`	no	—
`userRef`	`string \| null`	no	—

VcIssuerKeyRotationDto

Property	Type	Required	Description
`activeKeyId`	`string \| null`	no	—
`did`	`string \| null`	no	—
`issuerId`	`string (uuid)`	no	—
`publishedKeyIds`	`string[] \| null`	no	—
`rotated`	`boolean`	no	—
`rotatedAt`	`string (date-time) \| null`	no	—

VerificationMethodDto

Property	Type	Required	Description
`controller`	`string \| null`	no	—
`id`	`string \| null`	no	—
`publicKeyJwk`	`unspecified`	no	—
`publicKeyMultibase`	`string \| null`	no	—
`type`	`string \| null`	no	—

VerifyCredentialRequest

Property	Type	Required	Description
`credentialJson`	`string \| null`	no	—
`verifierContext`	`string \| null`	no	—

VerifyCredentialResultDto

Property	Type	Required	Description
`credentialType`	`string \| null`	no	—
`expiresAt`	`string (date-time) \| null`	no	—
`isValid`	`boolean`	no	—
`issuedAt`	`string (date-time) \| null`	no	—
`issuedByThisInstance`	`boolean`	no	—
`notExpired`	`boolean`	no	—
`notRevoked`	`boolean`	no	—
`signatureValid`	`boolean`	no	—
`verificationDetail`	`string \| null`	no	—

WalletAttestationBatchRequest

Property	Type	Required	Description
`keyProofs`	`string[] \| null`	no	—

WalletAttestationBatchResponse

Property	Type	Required	Description
`attestations`	`string[] \| null`	no	—

WalletAttestationMetadataResponse

Property	Type	Required	Description
`clientId`	`string \| null`	no	—
`issuer`	`string \| null`	no	—
`jwks`	`unspecified`	no	—
`lifetimeSeconds`	`integer (int64)`	no	—
`maxBatchSize`	`integer (int32)`	no	—
`walletName`	`string \| null`	no	—

WalletProviderTrustAnchorDto

Property	Type	Required	Description
`displayName`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`keys`	`WalletProviderTrustAnchorKeyDto[] \| null`	no	—
`notAfter`	`string (date-time) \| null`	no	—
`notBefore`	`string (date-time)`	no	—
`providerIdentifier`	`string \| null`	no	—
`revocationReason`	`string \| null`	no	—
`revokedAt`	`string (date-time) \| null`	no	—
`status`	`string \| null`	no	—

WalletProviderTrustAnchorKeyDto

Property	Type	Required	Description
`addedAt`	`string (date-time)`	no	—
`keyId`	`string \| null`	no	—
`publicJwkJson`	`string \| null`	no	—
`revocationReason`	`string \| null`	no	—
`revokedAt`	`string (date-time) \| null`	no	—

Essence Identity Provider API ​

AccountLinks

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

AccreditedIssuers

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Authorization

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Clients

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Essence Identity Provider API