Skip to content

List wallet keys that fit a credential

GET
/api/v1/channels/credentials/{realmName}/{credentialId}/candidates
curl --request GET \
--url http://localhost:11044/api/v1/channels/credentials/example/example/candidates \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

The names of the owner’s wallet keys a bind would accept for this credential, sorted. Never a secret.

realmName
required
string

Name of the captured realm installed in the signed-in owner’s world; non-blank, at most 256 UTF-8 bytes, no control characters and not all * (400 otherwise). 404 when it has no live installation

credentialId
required
string

Id of a credential the realm declares, as declared.id in the credential list; same text rules as the realm name. 404 when the installation declares no such credential

OK

Media type*/*

The owner’s wallet keys a bind would accept for one declared credential; answered by GET …/{credentialId}/candidates

object
credentialId
required

Id of the declared credential the keys fit

string
installation
required

The installation this was read from

object
digest
required

Digest of the realm snapshot the installation admitted, 64 lowercase hex characters

string
installationId
required

The live installation’s id; send it back as installationId on a change

string
realmName
required

Name of the installed realm

string
revision
required

The installation’s revision; send it back as expectedRevision on a change. Every bind or revoke moves it

integer format: int64
keys
required

Names of the wallet items that fit, sorted; never a secret. Empty when none fit, and always empty for an oauth2 credential

Array<string>