Update a service account

patch

https://api.doit.com/iam/v1/service-accounts/{id}

Partially updates a service account with an application/merge-patch+json body (RFC 7396). Omitted or null fields stay unchanged; an explicit empty string clears description. permissions replaces the whole list, and [] removes every permission. With dryRun=true the request goes through the same checks as a real update (If-Match, name bounds and uniqueness, permission names, caller scope) and returns the service account as it would look after the patch, without changing anything. Requires the serviceAccountManager permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length ≥ 1

Service account ID, as returned in the id field by the list and create operations.

Query Params

dryRun

boolean

Defaults to false

If true, validates the request and returns the would-be result without applying it. The response then carries the X-Dry-Run header.

Body Params

The fields to change.

Fields to change on a service account, as a JSON Merge Patch document.

name

string

length between 1 and 100

New name, unique among the customer's service accounts. Leading or trailing whitespace returns 400.

description

string | null

New free-text description. null leaves it unchanged; an explicit empty string clears it.

permissions

array of strings | null

Replaces the whole permission list. An unknown name returns 422.

permissions

Headers

If-Match

string

required

The ETag of the current version, from a get, create or update response. A stale value returns 412; re-read the resource and retry with the new ETag.

Idempotency-Key

string

required

length between 1 and 255

Client-generated key (UUID v4 or ULID recommended). Retrying with the same key and request returns the stored response instead of repeating the operation; the key is kept for 24 hours.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK - Service account updated, or previewed when dryRun=true (the body is the merged result, and etag is still the current one).

400Syntactically malformed request, missing required parameter, or unsupported parameter value.

401Unauthorized - Invalid API key.

403Forbidden - The client is not authorized to perform the request.

404The requested resource does not exist.

409The request conflicts with the current state of the resource.

412The If-Match value no longer matches the current version of the resource.

415The request Content-Type is not accepted by this operation.

422The request is well-formed but a value is not accepted, such as an unknown permission name.

428The request is missing the required If-Match header.

500Unexpected server error.