Edits the account's name, display label and/or color; a rename changes only the name, never the reference, home or launch configuration, and an empty display label or color clears that field.

PATCH

/v1/m/sessions/provider-accounts/{ref}

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

• this engine

Edits the account’s name, display label and/or color; a rename changes only the name, never the reference, home or launch configuration, and an empty display label or color clears that field.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

ref

required

string

Path parameter ref.

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

>= 1 properties

accent

Display-only accent color. Omit to preserve it; empty clears it; null is refused. Color carries no state or authority.

string

Allowed values: "" orange green amber red blue

display_name

Display label only. Omit to preserve the label; explicit null is refused. Surrounding whitespace is trimmed; the normalized label is at most 200 UTF-8 bytes and contains no control characters. Empty clears it. The reference, homes and launch configuration do not change. Repeating the current normalized label is a no-op.

string

name

Renames the account. Omit to keep the name; null is refused. The name is checked exactly as given: lowercase ASCII, a letter first, then letters, digits or ‘-’, at most 32 characters (422 otherwise). A name already used by another account of the same environment, of any driver or state, answers 409 and is never replaced. The reference, homes and launch configuration do not change. Repeating the current name is a no-op.

string

Responses

200

OK

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

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}