find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-managed-grafana:amazon-managed-grafana-serviceaccounts-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Managed Grafana Serviceaccounts API
  version: '2020-08-18'
  description: Generated from AWS's published Smithy model for Amazon Managed Grafana. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://grafana.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Serviceaccounts
paths:
  /workspaces/{workspaceId}/serviceaccounts:
    post:
      operationId: CreateWorkspaceServiceAccount
      summary: Create Workspace Service Account
      description: Creates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct GrafanaRole for your use case, use CreateWorkspaceServiceAccountToken to create a token that can be used to authenticate and authorize Grafana HTTP API calls. You can only create service accounts for workspaces that are compatible with Grafana version 9 and above. For more information about service accounts, see Service accounts in the Amazon Managed Grafana User Guide. For more information about the Grafana HTTP APIs, see Using Grafana HTTP APIs in the Amazon Managed Grafana User Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceServiceAccountResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceServiceAccountRequest'
      tags:
      - Serviceaccounts
    get:
      operationId: ListWorkspaceServiceAccounts
      summary: List Workspace Service Accounts
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkspaceServiceAccountsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListWorkspaceServiceAccountsRequest'
      tags:
      - Serviceaccounts
  /workspaces/{workspaceId}/serviceaccounts/{serviceAccountId}:
    delete:
      operationId: DeleteWorkspaceServiceAccount
      summary: Delete Workspace Service Account
      description: Deletes a workspace service account from the workspace. This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted. Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspaceServiceAccountResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteWorkspaceServiceAccountRequest'
      tags:
      - Serviceaccounts
components:
  schemas:
    CreateWorkspaceServiceAccountResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the service account.
        name:
          type: string
          description: The name of the service account.
        grafanaRole:
          type: string
          description: The permission level given to the service account.
        workspaceId:
          type: string
          description: The workspace with which the service account is associated.
      required:
      - id
      - name
      - grafanaRole
      - workspaceId
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field that caused the validation error.
        message:
          type: string
          description: A message describing why this field couldn't be validated.
      required:
      - name
      - message
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalServerException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
        retryAfterSeconds:
          type: integer
          description: How long to wait before you retry this operation.
      required:
      - message
    DeleteWorkspaceServiceAccountRequest:
      type: object
      properties:
        serviceAccountId:
          type: string
          description: The ID of the service account to delete.
        workspaceId:
          type: string
          description: The ID of the workspace where the service account resides.
      required:
      - serviceAccountId
      - workspaceId
    DeleteWorkspaceServiceAccountResponse:
      type: object
      properties:
        serviceAccountId:
          type: string
          description: The ID of the service account deleted.
        workspaceId:
          type: string
          description: The ID of the workspace where the service account was deleted.
      required:
      - serviceAccountId
      - workspaceId
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
        reason:
          type: string
          description: The reason that the operation failed.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: A list of fields that might be associated with the error.
      required:
      - message
      - reason
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The value of a parameter in the request caused an error.
        resourceId:
          type: string
          description: The ID of the resource that is associated with the error.
        resourceType:
          type: string
          description: The type of the resource that is associated with the error.
      required:
      - message
      - resourceId
      - resourceType
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
        serviceCode:
          type: string
          description: The ID of the service that is associated with the error.
        quotaCode:
          type: string
          description: The ID of the service quota that was exceeded.
        retryAfterSeconds:
          type: integer
          description: The value of a parameter in the request caused an error.
      required:
      - message
    ListWorkspaceServiceAccountsResponse:
      type: object
      properties:
        nextToken:
          type: string
          description: The token to use when requesting the next set of service accounts.
        serviceAccounts:
          type: array
          items:
            $ref: '#/components/schemas/ServiceAccountSummary'
          description: An array of structures containing information about the service accounts.
        workspaceId:
          type: string
          description: The workspace to which the service accounts are associated.
      required:
      - serviceAccounts
      - workspaceId
    ListWorkspaceServiceAccountsRequest:
      type: object
      properties:
        maxResults:
          type: integer
          description: The maximum number of service accounts to include in the results.
        nextToken:
          type: string
          description: The token for the next set of service accounts to return. (You receive this token from a previous ListWorkspaceServiceAccounts operation.)
        workspaceId:
          type: string
          description: The workspace for which to list service accounts.
      required:
      - workspaceId
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
        resourceId:
          type: string
          description: The ID of the resource that is associated with the error.
        resourceType:
          type: string
          description: The type of the resource that is associated with the error.
        serviceCode:
          type: string
          description: The value of a parameter in the request caused an error.
        quotaCode:
          type: string
          description: The ID of the service quota that was exceeded.
      required:
      - message
      - resourceId
      - resourceType
      - serviceCode
      - quotaCode
    ServiceAccountSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the service account.
        name:
          type: string
          description: The name of the service account.
        isDisabled:
          type: string
          description: Returns true if the service account is disabled. Service accounts can be disabled and enabled in the Amazon Managed Grafana console.
        grafanaRole:
          type: string
          description: The role of the service account, which sets the permission level used when calling Grafana APIs.
      required:
      - id
      - name
      - isDisabled
      - grafanaRole
    CreateWorkspaceServiceAccountRequest:
      type: object
      properties:
        name:
          type: string
          description: A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account.
        grafanaRole:
          type: string
          description: The permission level to use for this service account. For more information about the roles and the permissions each has, see User roles in the Amazon Managed Grafana User Guide.
        workspaceId:
          type: string
          description: The ID of the workspace within which to create the service account.
      required:
      - name
      - grafanaRole
      - workspaceId
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
        resourceId:
          type: string
          description: The ID of the resource that is associated with the error.
        resourceType:
          type: string
          description: The type of the resource that is associated with the error.
      required:
      - message
      - resourceId
      - resourceType
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: grafana
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/grafana/service/2020-08-18/grafana-2020-08-18.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)