Service accounts

List Service Accounts

get

Returns a list of service accounts.

Args: filter_model: Model that takes care of filtering, sorting and pagination. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: A list of service accounts matching the filter.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Query parameters

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

activeany ofOptional

booleanOptional

or

stringOptional

or

nullOptional

external_user_idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

indexintegerRequired

max_sizeintegerRequired

total_pagesintegerRequired

totalintegerRequired

401

Unauthorized

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get

/api/v1/service_accounts

HTTPcURLJavaScriptPython

GET /api/v1/service_accounts HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2026-04-02T14:28:14.642Z",
        "updated": "2026-04-02T14:28:14.642Z",
        "full_name": "",
        "active": false,
        "avatar_url": "text"
      },
      "metadata": {
        "description": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    }
  ]
}

Create Service Account

post

Creates a service account.

Args: service_account: Service account to create.

Returns: The created service account.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Request model for service accounts.

namestring · max: 255Required

full_namestring · max: 255OptionalDefault: ""

descriptionany ofOptional

string · max: 65535Optional

or

nullOptional

activebooleanRequired

avatar_urlany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for service accounts.

bodyany ofOptional

or

nullOptional

metadataany ofOptional

or

nullOptional

resourcesany ofOptional

or

nullOptional

idstring · uuidRequired

permission_deniedbooleanOptionalDefault: false

namestring · max: 255Required

401

Unauthorized

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

post

/api/v1/service_accounts

HTTPcURLJavaScriptPython

POST /api/v1/service_accounts HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "name": "text",
  "full_name": "",
  "description": "text",
  "active": true,
  "avatar_url": "text"
}

{
  "body": {
    "created": "2026-04-02T14:28:14.642Z",
    "updated": "2026-04-02T14:28:14.642Z",
    "full_name": "",
    "active": false,
    "avatar_url": "text"
  },
  "metadata": {
    "description": "",
    "external_user_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Get Service Account

get

Returns a specific service account.

Args: service_account_name_or_id: Name or ID of the service account. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The service account matching the given name or ID.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

service_account_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Query parameters

hydratebooleanOptionalDefault: true

Responses

200

Successful Response

application/json

Response model for service accounts.

bodyany ofOptional

or

nullOptional

metadataany ofOptional

or

nullOptional

resourcesany ofOptional

or

nullOptional

idstring · uuidRequired

permission_deniedbooleanOptionalDefault: false

namestring · max: 255Required

401

Unauthorized

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get

/api/v1/service_accounts/{service_account_name_or_id}

HTTPcURLJavaScriptPython

GET /api/v1/service_accounts/{service_account_name_or_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "body": {
    "created": "2026-04-02T14:28:14.642Z",
    "updated": "2026-04-02T14:28:14.642Z",
    "full_name": "",
    "active": false,
    "avatar_url": "text"
  },
  "metadata": {
    "description": "",
    "external_user_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Update Service Account

put

Updates a specific service account.

Args: service_account_name_or_id: Name or ID of the service account. service_account_update: the service account to use for the update.

Returns: The updated service account.

Raises: IllegalOperationError: If the service account was created via external authentication.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

service_account_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Body

application/json

Update model for service accounts.

nameany ofOptional

string · max: 255Optional

or

nullOptional

full_nameany ofOptional

string · max: 255Optional

or

nullOptional

descriptionany ofOptional

string · max: 65535Optional

or

nullOptional

activeany ofOptional

booleanOptional

or

nullOptional

avatar_urlany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for service accounts.

bodyany ofOptional

or

nullOptional

metadataany ofOptional

or

nullOptional

resourcesany ofOptional

or

nullOptional

idstring · uuidRequired

permission_deniedbooleanOptionalDefault: false

namestring · max: 255Required

401

Unauthorized

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

put

/api/v1/service_accounts/{service_account_name_or_id}

HTTPcURLJavaScriptPython

PUT /api/v1/service_accounts/{service_account_name_or_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "name": "text",
  "full_name": "text",
  "description": "text",
  "active": true,
  "avatar_url": "text"
}

{
  "body": {
    "created": "2026-04-02T14:28:14.642Z",
    "updated": "2026-04-02T14:28:14.642Z",
    "full_name": "",
    "active": false,
    "avatar_url": "text"
  },
  "metadata": {
    "description": "",
    "external_user_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Delete Service Account

delete

Delete a specific service account.

Args: service_account_name_or_id: Name or ID of the service account.

Raises: IllegalOperationError: If the service account was created via external authentication.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

service_account_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Responses

200

Successful Response

application/json

anyOptional

401

Unauthorized

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

delete

/api/v1/service_accounts/{service_account_name_or_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/service_accounts/{service_account_name_or_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content