List service accounts

GET

/v1/service-accounts

curl --request GET \
  --url 'https://example.com/v1/service-accounts?limit=25&includeUnregistered=true' \
  --header 'Authorization: Bearer <token>'

• Same-origin — path relative to the deployment root.

Oldest first; active only unless ?includeUnregistered=true. Tenant admins only.

Authorizations

• bearerAuth

Parameters

Query Parameters

cursor

string

Where the previous page ended: its nextCursor, as it came. A runtime that seals cursors takes one only for the same list, filters and caller, within a day; otherwise 400 bad-input, and the list starts again without it. Absent → first page.

limit

integer

default: 25 >= 1 <= 100

1..100. Default 25.

includeUnregistered

string

Allowed values: true false

true: unregistered accounts too.

Responses

200

A page of service accounts.

Media typeapplication/json

object

data

required

Array<object>

A named, non-human principal (service_account:<id>) for an app, a pipeline or a schedule. It acts through API keys minted for it.

object

serviceAccountId

required

string

name

required

Unique among the tenant’s active accounts.

string

description

string

grants

required

Array

One of: discriminator: kind

object

Tenant admin.

object

kind

required

string

Allowed values: tenant-admin

object

Tenant member: read the tenant’s settings (providers, policies, adapters, signing keys, deployments), not its projects. A service account has it only when granted; a person has it from being added.

object

kind

required

string

Allowed values: tenant-member

object

A role on one project; it replaces the account’s role there.

object

kind

required

string

Allowed values: project

projectId

required

string format: uuid

role

required

Role on a project, as read. member is only read, on a role given before it was retired: it grants what viewer does, and writes refuse it.

string

Allowed values: viewer editor owner admin member

createdBy

Who created it: user:<id> or service_account:<id>.

string

createdAt

required

string format: date-time

unregisteredAt

Set once unregistered: it has no grants, and its keys no longer work.

string format: date-time

hasMore

required

boolean

nextCursor

string

Example

{
  "data": [
    {
      "grants": [
        {
          "kind": "tenant-admin"
        }
      ]
    }
  ]
}

401

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Not a tenant admin.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}