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

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

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/service_accounts HTTP/1.1
Host: 
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-04-26T17:10:41.993Z",
        "updated": "2025-04-26T17:10:41.993Z",
        "active": true
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Create Service Account

post

Creates a service account.

Args: service_account: Service account to create.

Returns: The created service account.

Authorizations

Body

Request model for service accounts.

namestring · max: 255Required

descriptionany ofOptional

string · max: 65535Optional

or

nullOptional

activebooleanRequired

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/service_accounts HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 50

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

{
  "body": {
    "created": "2025-04-26T17:10:41.993Z",
    "updated": "2025-04-26T17:10:41.993Z",
    "active": true
  },
  "metadata": {
    "description": "text"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "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

Path parameters

service_account_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Query parameters

hydratebooleanOptionalDefault: true

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/service_accounts/{service_account_name_or_id} HTTP/1.1
Host: 
Accept: */*

{
  "body": {
    "created": "2025-04-26T17:10:41.993Z",
    "updated": "2025-04-26T17:10:41.993Z",
    "active": true
  },
  "metadata": {
    "description": "text"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "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.

Authorizations

Path parameters

service_account_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Body

Update model for service accounts.

nameany ofOptional

string · max: 255Optional

or

nullOptional

descriptionany ofOptional

string · max: 65535Optional

or

nullOptional

activeany ofOptional

booleanOptional

or

nullOptional

Responses

put

HTTPcURLJavaScriptPython

PUT /api/v1/service_accounts/{service_account_name_or_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 50

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

{
  "body": {
    "created": "2025-04-26T17:10:41.993Z",
    "updated": "2025-04-26T17:10:41.993Z",
    "active": true
  },
  "metadata": {
    "description": "text"
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Delete Service Account

delete

Delete a specific service account.

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

Authorizations

Path parameters

service_account_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Responses

Responseany

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/service_accounts/{service_account_name_or_id} HTTP/1.1
Host: 
Accept: */*

No content