Creates a provider account: the server builds its home on this node in two phases and registers the account that owns it, under the given name or a generated one.

POST

/v1/m/sessions/provider-accounts

curl --request POST \
  --url https://example.com/v1/m/sessions/provider-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "driver": "example", "idempotency_key": "example", "name": "example" }'

• this engine

Creates a provider account: the server builds its home on this node in two phases and registers the account that owns it, under the given name or a generated one.

Authorizations

• bearerAuth
• browserSession

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

driver

required

Provider driver key, lower-cased ([a-z0-9][a-z0-9._-]*). The account’s home is built for this driver on the node that serves this execution environment.

string

>= 1 characters

idempotency_key

Any of:

string

Stable account creation intention: 1 to 128 ASCII letters, digits, hyphens or underscores. Reuse it after an uncertain result with the same driver and name. Empty or null starts a new intention. This key does not grant authority.

string

null

null

name

Any of:

string

The account’s name: lowercase ASCII, a letter first, then letters, digits or ‘-’, at most 32 characters. It is unique in the execution environment across every driver, archived accounts included, and a taken name is refused rather than replaced by another. Empty or null asks the server to generate one: the bare driver name first, then -b, -c and so on.

string

null

null

Example ^generated

{
  "driver": "example",
  "idempotency_key": "example",
  "name": "example"
}

Responses

201

The provider account, and the home the engine built for it

Media type application/json

object

Example ^generated

{}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

422

Invalid account name, retry key or execution environment

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}

503

Account home service unavailable or outcome unresolved; retry the same idempotency key

Media type application/json

object

Example ^generated

{}