Log in|Playground

Service Accounts

get

List Service Accounts

Authorizations
Responses
200

ListServiceAccountsResponse contains a list of service accounts.

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

No content
get

Get service account by ID

Authorizations
Path parameters
idstringRequired

ID of the service account to retrieve

Responses
200

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

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

No content
post

Create Service Account

Authorizations
Body
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
post
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"
  ]
}
No content
delete

Delete Service Account

Authorizations
Path parameters
idstringRequired

ID of the service account to delete

Responses
202

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

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

No content
put

Update Service Account

Authorizations
Body
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.

put
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"
}
No content

Last updated