Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListWorkspaceServiceAccounts

Returns a list of service accounts for a workspace.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

Request Syntax


GET /workspaces/workspaceId/serviceaccounts?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of service accounts to include in the results.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token for the next set of service accounts to return. (You receive this token from a previous ListWorkspaceServiceAccounts operation.)

workspaceId

The workspace for which to list service accounts.

Pattern: ^g-[0-9a-f]{10}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "serviceAccounts": [ 
      { 
         "grafanaRole": "string",
         "id": "string",
         "isDisabled": "string",
         "name": "string"
      }
   ],
   "workspaceId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The token to use when requesting the next set of service accounts.

Type: String

serviceAccounts

An array of structures containing information about the service accounts.

Type: Array of ServiceAccountSummary objects

workspaceId

The workspace to which the service accounts are associated.

Type: String

Pattern: ^g-[0-9a-f]{10}$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

A resource was in an inconsistent state during an update or a deletion.

HTTP Status Code: 409

InternalServerException

Unexpected error while processing the request. Retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because of request throttling. Retry the request.

HTTP Status Code: 429

ValidationException

The value of a parameter in the request caused an error.

HTTP Status Code: 400