Service Account

An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it.

Operations

Method	Endpoint	Description
GET	/service_account	List ServiceAccounts
GET	/service_account/{service_account_id}/key	List a service account's public keys
GET	/service_account/{service_account_id}	Get ServiceAccount
POST	/service_account	Create ServiceAccount
POST	/service_account/{service_account_id}/key	Register a public key for a service account
PATCH	/_service_account	Bulk patch multiple service accounts
PATCH	/service_account/{service_account_id}	Patch ServiceAccount
PUT	/service_account/{service_account_id}	Update ServiceAccount
DELETE	/_service_account	Bulk delete multiple service accounts
DELETE	/service_account/{service_account_id}	Delete ServiceAccount
DELETE	/service_account/{service_account_id}/key/{kid}	Remove a public key from a service account

---

List ServiceAccounts

GET /service_account

List ServiceAccounts

Operation ID: ListServiceAccounts

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of ServiceAccounts returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(FromLinkID) > 0. An attribute naming a list of other entities can be filtered on their attributes with a * segment, as in FromLink.*.Slug = 'upgrade-app', which holds when any element satisfies it. Without the * such a reference is an error, since it names no single value to compare. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the ServiceAccount list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (ServiceAccount). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains	string		Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include	string		Include clause for expanding related entities in the response for ServiceAccount. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for ServiceAccount are OrganizationID. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for ServiceAccount. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters, and fields named by order_by, are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.
include_hidden	string		Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. It is a comma-separated list of HiddenReasons, or * for all of them. A where clause naming the entities, by their Slug or ID with = or IN, or naming HiddenReason at all, also returns hidden entities it selects. ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason BackingUnit.
limit	integer		Maximum number of ServiceAccount entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request.
order_by	string		Comma-separated list of fields to sort ServiceAccount results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. Supported attributes for ordering ServiceAccount: CreatedAt, DisplayName, HiddenReason, OrgRole, OrganizationID, ServiceAccountID, Slug, UpdatedAt, UserID. Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. Results are ordered by the ServiceAccount's ID after the fields named, and by the ID alone if none are. The whole string must be query-encoded.
continue	string		The token from the ConfigHub-Continue header of the previous page, to return the ServiceAccount entities after it. The request's other parameters, except limit, must be the same as those of the request that returned the token. Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of ExtendedServiceAccount
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

List a service account's public keys

GET /service_account/{service_account_id}/key

List the public keys registered for a service account. Keys are returned unredacted, deliberately: they are public material, and an operator noticing a key nobody registered is how an injected one is caught. Requires View permission on the service account.

Operation ID: ListServiceAccountKeys

Parameters

Path Parameters

Parameter	Type	Required	Description
service_account_id	string	✓	UUID of the service account whose keys are being managed.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of UserKey
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Get ServiceAccount

GET /service_account/{service_account_id}

Get ServiceAccount

Operation ID: GetServiceAccount

Parameters

Path Parameters

Parameter	Type	Required	Description
service_account_id	string	✓	Unique identifier for a service_account_id

Query Parameters

Parameter	Type	Required	Description
include	string		Include clause for expanding related entities in the response for ServiceAccount. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for ServiceAccount are OrganizationID. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for ServiceAccount. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters, and fields named by order_by, are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	ExtendedServiceAccount
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Create ServiceAccount

POST /service_account

Create ServiceAccount

Operation ID: CreateServiceAccount

Parameters

Query Parameters

Parameter	Type	Required	Description
allow_exists	string		Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity
dry_run	boolean		If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse.

Request Body

Content-Type: application/json

Schema: ServiceAccount

Responses

Status	Description	Content-Type	Schema
200	An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it.	application/json	ServiceAccount
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
409	ServiceAccount data conflict. Data has changed since last read.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Register a public key for a service account

POST /service_account/{service_account_id}/key

Register a public key for a service account. The holder of the matching private key then authenticates as the service account by signing a short-lived assertion (RFC 7523 private_key_jwt), so no secret is exchanged and none is stored. Requires Impersonate permission on the service account, which Manage does not include; a service account cannot register a key for itself.

Operation ID: CreateServiceAccountKey

Parameters

Path Parameters

Parameter	Type	Required	Description
service_account_id	string	✓	UUID of the service account whose keys are being managed.

Query Parameters

Parameter	Type	Required	Description
dry_run	boolean		If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse.

Request Body

Content-Type: application/json

Schema: CreateUserKeyRequest

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	UserKey
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
409	ServiceAccount data conflict. Data has changed since last read.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Bulk patch multiple service accounts

PATCH /_service_account

Apply JSON merge patch to multiple service accounts selected by query parameters

Operation ID: BulkPatchServiceAccounts

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of ServiceAccounts returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(FromLinkID) > 0. An attribute naming a list of other entities can be filtered on their attributes with a * segment, as in FromLink.*.Slug = 'upgrade-app', which holds when any element satisfies it. Without the * such a reference is an error, since it names no single value to compare. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the ServiceAccount list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (ServiceAccount). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains	string		Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include_hidden	string		Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. It is a comma-separated list of HiddenReasons, or * for all of them. A where clause naming the entities, by their Slug or ID with = or IN, or naming HiddenReason at all, also returns hidden entities it selects. ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason BackingUnit.
include	string		Include clause for expanding related entities in the response for ServiceAccount. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for ServiceAccount are OrganizationID. The whole string must be query-encoded.
limit	integer		Maximum number of ServiceAccount entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity.
continue	string		The token from the ConfigHub-Continue header of the previous request, to act on the ServiceAccount entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token.
dry_run	boolean		If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse.

Request Body

Content-Type: application/merge-patch+json

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of ServiceAccountCreateOrUpdateResponse
207	Multi-Status: Mixed success and failure results	application/json	Array of ServiceAccountCreateOrUpdateResponse
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
409	ServiceAccount data conflict. Data has changed since last read.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Patch ServiceAccount

PATCH /service_account/{service_account_id}

Patch ServiceAccount

Operation ID: PatchServiceAccount

Parameters

Path Parameters

Parameter	Type	Required	Description
service_account_id	string	✓	Unique identifier for a service_account_id

Query Parameters

Parameter	Type	Required	Description
dry_run	boolean		If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse.

Request Body

Content-Type: application/merge-patch+json

Responses

Status	Description	Content-Type	Schema
200	An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it.	application/json	ServiceAccount
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
409	ServiceAccount data conflict. Data has changed since last read.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Update ServiceAccount

PUT /service_account/{service_account_id}

Update ServiceAccount

Operation ID: UpdateServiceAccount

Parameters

Path Parameters

Parameter	Type	Required	Description
service_account_id	string	✓	Unique identifier for a service_account_id

Query Parameters

Parameter	Type	Required	Description
dry_run	boolean		If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse.

Request Body

Content-Type: application/json

Schema: ServiceAccount

Responses

Status	Description	Content-Type	Schema
200	An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it.	application/json	ServiceAccount
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
409	ServiceAccount data conflict. Data has changed since last read.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Bulk delete multiple service accounts

DELETE /_service_account

Delete multiple service accounts selected by query parameters

Operation ID: BulkDeleteServiceAccounts

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of ServiceAccounts returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(FromLinkID) > 0. An attribute naming a list of other entities can be filtered on their attributes with a * segment, as in FromLink.*.Slug = 'upgrade-app', which holds when any element satisfies it. Without the * such a reference is an error, since it names no single value to compare. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the ServiceAccount list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (ServiceAccount). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains	string		Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include_hidden	string		Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. It is a comma-separated list of HiddenReasons, or * for all of them. A where clause naming the entities, by their Slug or ID with = or IN, or naming HiddenReason at all, also returns hidden entities it selects. ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason BackingUnit.
include	string		Include clause for expanding related entities in the response for ServiceAccount. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for ServiceAccount are OrganizationID. The whole string must be query-encoded.
limit	integer		Maximum number of ServiceAccount entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity.
continue	string		The token from the ConfigHub-Continue header of the previous request, to act on the ServiceAccount entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token.

Responses

Status	Description	Content-Type	Schema
200	OK	application/json	Array of DeleteResponse
207	Multi-Status: Mixed success and failure results	application/json	Array of DeleteResponse
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
409	ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read.	application/json	StandardErrorResponse
422	Unable to delete entity	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Delete ServiceAccount

DELETE /service_account/{service_account_id}

Delete ServiceAccount

Operation ID: DeleteServiceAccount

Parameters

Path Parameters

Parameter	Type	Required	Description
service_account_id	string	✓	Unique identifier for a service_account_id

Responses

Status	Description	Content-Type	Schema
200	Response for successful delete operation	application/json	DeleteResponse
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
409	ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read.	application/json	StandardErrorResponse
422	ServiceAccount could not be deleted.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Remove a public key from a service account

DELETE /service_account/{service_account_id}/key/{kid}

Remove one of a service account's public keys by its thumbprint. This is the second half of rotation, and the response to a compromised private key. Requires Impersonate permission on the service account.

Operation ID: DeleteServiceAccountKey

Parameters

Path Parameters

Parameter	Type	Required	Description
service_account_id	string	✓	UUID of the service account whose keys are being managed.
kid	string	✓	RFC 7638 thumbprint of the key to remove. The key names itself, so a holder can address it without asking what it was called.

Responses

Status	Description	Content-Type	Schema
200	Response for successful delete operation	application/json	DeleteResponse
400	ServiceAccount request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	ServiceAccount not found.	application/json	StandardErrorResponse
409	ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read.	application/json	StandardErrorResponse
422	ServiceAccount could not be deleted.	application/json	StandardErrorResponse
500	Something went wrong while processing ServiceAccount.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Schemas

CreateUserKeyRequest

Properties

Property	Type	Required	Description
Description	string
PublicJWK

DeleteResponse

Response for successful delete operation

Properties

Property	Type	Required	Description
Error			Error information if the delete operation failed.
Message	string		Response message.

ExtendedServiceAccount

Properties

Property	Type	Required	Description
Error	ResponseError
Organization	Organization
ServiceAccount	ServiceAccount

ServiceAccount

An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it.

Properties

Property	Type	Required	Description
Annotations	object		An optional map of Annotation key/value pairs for tools to attach information to entities.
CreatedAt	string (date-time)		The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
DeleteGates	object		An optional set of gates that, if any is present, will block deletion.
DisplayName	string		Friendly name for the entity.
EntityType	string		The type of entity.
HiddenReason	string		The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another.
Labels	object		An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
OrgRole	string		Organization-level role of the ServiceAccount's User. Defaults to none, which leaves the User with only the permissions granted to it. It cannot be set above the role of the caller setting it, and changing it requires Manage permission on the service account.
OrganizationID	string (uuid)		Unique identifier for an organization.
Permissions			Permissions to access this service account.
ServiceAccountID	string (uuid)		Unique identifier for a service account.
Slug	string	✓	Unique URL-safe identifier for the entity.
UpdatedAt	string (date-time)		The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
UserID	string (uuid)		The User the service account acts as. Grant the service account access to other entities by naming this User in their Permissions, or by adding it to a Group.
Version	integer (int64)		An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.

ServiceAccountCreateOrUpdateResponse

Properties

Property	Type	Required	Description
Error	ResponseError
ServiceAccount	ServiceAccount

StandardErrorResponse

Error response details.

Properties

Property	Type	Required	Description
Code	string		HTTP status code of the response.
Message	string		Message returned with the response.

UserKey

Properties

Property	Type	Required	Description
CreatedAt	string (date-time)
Description	string
ExpiresAt	string (date-time)
Kid	string
LastUsedAt	string (date-time)
PublicJWK
UserID	string (uuid)
UserKeyID	string (uuid)