Register an engine

Adding an engine is a configuration operation, not a software delivery. credentialSubject is the engine’s first credential; bind one per further calling product with bindEngineCredentialSubject. A credential subject binds at most one engine. Admin only (engines credential-subjects:write): a bound credential acts as the engine.

POST /v1/engines

Register an engine

cURL

curl --request POST \
  --url https://api.example.com/v1/engines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "credentialSubject": "<string>",
  "engineId": "<string>",
  "displayName": "<string>",
  "participants": [
    "<string>"
  ]
}
'

201

{
  "createdAt": "2023-11-07T05:31:56Z",
  "credentialSubjects": [
    "<string>"
  ],
  "displayName": "<string>",
  "enabled": true,
  "engineId": "<string>",
  "participants": [
    "<string>"
  ],
  "disabledAt": "2023-11-07T05:31:56Z",
  "pixDelivery": {
    "baseUrl": "<string>",
    "credentialRef": "<string>"
  },
  "tedDelivery": {
    "baseUrl": "<string>",
    "credentialRef": "<string>"
  }
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency · string · obrigatório

Idempotency key; a retry with the same key and body replays the first answer.

Corpo

application/json

credentialSubject · string · obrigatório

The engine's first Access Manager credential subject; bind more with POST /v1/engines/{engineId}/credential-subjects. A subject binds at most one engine, disabled ones included.

Required string length: 1 - 256

engineId · string · obrigatório

Pattern: ^[a-z0-9-]{1,32}$

displayName · string

Maximum string length: 128

participants · string[] | null

The direct-participant ISPBs this engine acts as. Omitted or empty is legal, and an ISPB another engine already declares is accepted: a shared ISPB across two cores is the coexistence case itself.

Pattern: ^[0-9]{8}$

pixDelivery · object

Where the Courier delivers the Pix messages the ownership map gives this engine; https in production, and setting it needs the admin grant (engines pix-delivery:write). Omitted: the engine takes none, and such a message is retained.

Show child attributes

tedDelivery · object

Where the Courier relays the cross-core TED the ownership map gives this engine; https in production, and setting it needs the admin grant (engines ted-delivery:write). Omitted: the engine takes none, and a relay to it is refused.

Show child attributes

Resposta

201

application/json

Created

createdAt · string<date-time> · obrigatório

credentialSubjects · string[] · obrigatório

Every Access Manager credential subject that authenticates as this engine, one per calling product, sorted.

Maximum string length: 256

displayName · string · obrigatório

Maximum string length: 128

enabled · boolean · obrigatório

engineId · string · obrigatório

Pattern: ^[a-z0-9-]{1,32}$

participants · string[] · obrigatório

Pattern: ^[0-9]{8}$

disabledAt · string<date-time> | null

pixDelivery · object

Show child attributes

tedDelivery · object

Show child attributes