Bind a secret to a declared credential
const url = 'http://localhost:11044/api/v1/channels/credentials/example/example/bind';const options = {method: 'POST', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:11044/api/v1/channels/credentials/example/example/bind \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'JSON fields: installationId, expectedRevision, and exactly one of walletKey or value. A pasted value is filed in the wallet and never returned, logged or recorded in the grant.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”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). 409 when its live installation is not the one named by the body’s installationId and expectedRevision
Id of a credential the realm declares, as declared.id in the credential list; same text rules as the realm name. Whatever it was bound to is replaced. 404 when the installation declares no such credential, 501 for an oauth2 credential
Responses
Section titled “Responses”OK
One credential a captured realm declares, and whether a wallet item is bound to it; never carries a secret. Answered by the /channels/credentials/{realmName} list, bind and revoke routes
object
Whether a wallet item is bound to the credential
The credential exactly as the realm declares it: id, kind, description, provider, docs, scopes, scheme
object
What the realm says the credential is for, verbatim
An https link to the provider’s own instructions for getting one; null when none is given
The credential’s id within its realm, the {credentialId} the bind and revoke routes take. Lower-case kebab, or an environment variable’s name kept from a migrated token-env
The kind of secret: api-key, basic, bearer, oauth2 or public-key
Who issues the credential, e.g. a provider’s name; null when the realm does not say
The word a bearer token is sent after in the Authorization header, when it is not Bearer. Only a bearer credential may declare one; null means Bearer
The OAuth scopes the grant must carry. Non-empty for oauth2, and empty for every other kind
API operation keys that sent the previously bound secret and are no longer approved, because the secret bound now differs; sorted. Filled only on the credential a bind just changed, otherwise empty
The installation this was read from
object
Digest of the realm snapshot the installation admitted, 64 lowercase hex characters
The live installation’s id; send it back as installationId on a change
Name of the installed realm
The installation’s revision; send it back as expectedRevision on a change. Every bind or revoke moves it
Whether the bound item holds a secret the host can send for this owner. False when nothing is bound, the item was deleted or is the wrong type, or the wallet has not been loaded since a restart
Name of the bound wallet item, never its value; null when nothing is bound

