ListWorkspaceServiceAccountTokens
Returns a list of tokens for a workspace service account.
Note
This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it.
Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
Request Syntax
GET /workspaces/workspaceId/serviceaccounts/serviceAccountId/tokens?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of tokens 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
ListWorkspaceServiceAccountTokensoperation.) - serviceAccountId
-
The ID of the service account for which to return tokens.
Required: Yes
- workspaceId
-
The ID of the workspace for which to return tokens.
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",
"serviceAccountId": "string",
"serviceAccountTokens": [
{
"createdAt": number,
"expiresAt": number,
"id": "string",
"lastUsedAt": number,
"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
- serviceAccountId
-
The ID of the service account where the tokens reside.
Type: String
- serviceAccountTokens
-
An array of structures containing information about the tokens.
Type: Array of ServiceAccountTokenSummary objects
- workspaceId
-
The ID of the workspace where the tokens reside.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
