Service Accounts

get

List Service Accounts

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Responses

200

ListServiceAccountsResponse contains a list of service accounts.

application/json

deletedbooleanOptional

Indicates if the service account has been marked for deletion.

emailstringOptional

The email address of the service account.

lastActivestring · date-timeOptional

Timestamp of the last activity detected for this service account.

namestringOptional

The name of the service account.

serviceAccountIdstringOptional

The UUID of the service account.

500

ErrorResponse defines a common error response structure.

application/json

get

/api/rbac/service-accounts/list

HTTPcURLJavaScriptPython

GET /api/rbac/service-accounts/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "deleted": true,
    "email": "text",
    "lastActive": "2026-03-28T10:03:25.194Z",
    "name": "text",
    "policies": [
      {
        "name": "text",
        "uuid": "text"
      }
    ],
    "serviceAccountId": "text"
  }
]

get

Get service account by ID

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

ID of the service account to retrieve

Responses

200

ServiceAccountsWithPolicyResponse defines the response structure for getting a single service account.

application/json

deletedbooleanOptional

Indicates if the service account has been marked for deletion.

emailstringOptional

The email address of the service account.

lastActivestring · date-timeOptional

Timestamp of the last activity detected for this service account.

namestringOptional

The name of the service account.

serviceAccountIdstringOptional

The UUID of the service account.

400

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

get

/api/rbac/service-account/{id}

HTTPcURLJavaScriptPython

GET /api/rbac/service-account/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "deleted": true,
  "email": "text",
  "lastActive": "2026-03-28T10:03:25.194Z",
  "name": "text",
  "policies": [
    {
      "name": "text",
      "uuid": "text"
    }
  ],
  "serviceAccountId": "text"
}

post

Create Service Account

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

emailstringRequired

The email address associated with the service account.

namestringRequired

The desired name for the service account.

policyUUIDsstring[]Required

A list of policy UUIDs to assign to the service account.

Responses

200Success

application/json

serviceAccountIdstringRequired

The UUID of the created service account.

400

ErrorResponse defines a common error response structure.

application/json

409

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

post

/api/rbac/service-account/create

HTTPcURLJavaScriptPython

POST /api/rbac/service-account/create HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "email": "text",
  "name": "text",
  "policyUUIDs": [
    "text"
  ]
}

{
  "serviceAccountId": "text"
}

delete

Delete Service Account

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

ID of the service account to delete

Responses

202

NoContentResponse indicates success but that no response body is expected or included.

400

ErrorResponse defines a common error response structure.

application/json

404

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

delete

/api/rbac/service-account/{id}

HTTPcURLJavaScriptPython

DELETE /api/rbac/service-account/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

put

Update Service Account

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

emailstringOptional

The new email address for the service account (optional).

overridePoliciesbooleanOptional

policyUUIDsstring[]Optional

A list of policy UUIDs to set for the service account (optional, replaces existing). Provide empty list to remove all.

serviceAccountIdstringRequired

The UUID of the service account to update.

Responses

200

UpdateServiceAccountResponseWrapper defines the response structure for updating a service account.

application/json

serviceAccountIdstringOptional

The UUID of the updated service account.

400

ErrorResponse defines a common error response structure.

application/json

404

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

put

/api/rbac/service-account/update

HTTPcURLJavaScriptPython

PUT /api/rbac/service-account/update HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "email": "text",
  "overridePolicies": true,
  "policyUUIDs": [
    "text"
  ],
  "serviceAccountId": "text"
}

{
  "serviceAccountId": "text"
}