Akamai Permission groups API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Permission groups API'
  version: '2'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{hostname}/api-definitions/v2
tags:
- name: Permission groups
paths:
  /auth/groups:
    get:
      description: View a list of access groups and your associated permission capabilities, such as create a namespace or read data from a namespace.
      operationId: get-groups
      summary: Akamai List Permission Groups
      tags:
      - Permission groups
      externalDocs:
        description: See documentation for this operation in Akamai's EdgeKV API
        url: https://techdocs.akamai.com/edgekv/reference/get-groups
      responses:
        '200':
          description: Describes a list of Akamai access groups with EdgeKV capabilities.
          content:
            application/json:
              example:
                groups:
                - groupId: 4284
                  groupName: 'Group #42'
                  capabilities:
                  - READ_DATA
                  - WRITE_DATA
                  - DELETE_DATA
                  - READ_STAGING_DATA
                  - WRITE_STAGING_DATA
                  - DELETE_STAGING_DATA
                  - VIEW_NAMESPACE
                  - CREATE_NAMESPACE
                  - MODIFY_NAMESPACE
                  - DELETE_NAMESPACE
                  - AUTHORIZE_NAMESPACE
                  - VIEW_STAGING_NAMESPACE
                  - CREATE_STAGING_NAMESPACE
                  - MODIFY_STAGING_NAMESPACE
                  - DELETE_STAGING_NAMESPACE
                  - AUTHORIZE_STAGING_NAMESPACE
                  - VIEW_TOKEN
                  - CREATE_TOKEN
                  - REVOKE_TOKEN
                  - VIEW_STAGING_TOKEN
                  - CREATE_STAGING_TOKEN
                  - REVOKE_STAGING_TOKEN
                - groupId: 109795
                  groupName: ESSL Behavior Tests
                  capabilities:
                  - READ_STAGING_DATA
                  - WRITE_STAGING_DATA
                  - DELETE_STAGING_DATA
                  - VIEW_NAMESPACE
                  - VIEW_STAGING_NAMESPACE
                  - CREATE_STAGING_NAMESPACE
                  - MODIFY_STAGING_NAMESPACE
                  - DELETE_STAGING_NAMESPACE
                  - AUTHORIZE_STAGING_NAMESPACE
                  - VIEW_STAGING_TOKEN
                  - CREATE_STAGING_TOKEN
                  - REVOKE_STAGING_TOKEN
              schema:
                additionalProperties: false
                type: object
                required:
                - groups
                properties:
                  groups:
                    description: List of Akamai access groups with EdgeKV capabilities.
                    minItems: 1
                    type: array
                    items:
                      additionalProperties: false
                      type: object
                      required:
                      - groupId
                      - groupName
                      - capabilities
                      properties:
                        capabilities:
                          description: Lists EdgeKV permissions available within the Akamai access group.
                          minItems: 1
                          type: array
                          uniqueItems: true
                          items:
                            type: string
                            enum:
                            - READ_DATA
                            - WRITE_DATA
                            - DELETE_DATA
                            - READ_STAGING_DATA
                            - WRITE_STAGING_DATA
                            - DELETE_STAGING_DATA
                            - VIEW_NAMESPACE
                            - CREATE_NAMESPACE
                            - MODIFY_NAMESPACE
                            - DELETE_NAMESPACE
                            - AUTHORIZE_NAMESPACE
                            - VIEW_STAGING_NAMESPACE
                            - CREATE_STAGING_NAMESPACE
                            - MODIFY_STAGING_NAMESPACE
                            - DELETE_STAGING_NAMESPACE
                            - AUTHORIZE_STAGING_NAMESPACE
                            - VIEW_TOKEN
                            - CREATE_TOKEN
                            - REVOKE_TOKEN
                            - VIEW_STAGING_TOKEN
                            - CREATE_STAGING_TOKEN
                            - REVOKE_STAGING_TOKEN
                        groupId:
                          description: Identifies the Akamai access group specified when the namespace was created.
                          minimum: 0
                          type: integer
                        groupName:
                          description: Name of an Akamai access group you assign to a new namespace.
                          type: string
                      x-akamai:
                        file-path: schemas/auth-group-200.yaml
                x-akamai:
                  file-path: schemas/auth-groups-200.yaml
        '500':
          description: Internal error.
          content:
            application/problem+json:
              example:
                detail: An internal error occurred.
                errorCode: EKV_0000
                instance: /edgekv/error-instances/cdb7767c-817e-4805-9f28-0816eefa0ba8
                status: 500
                title: Internal Server Error
                type: /edgekv/error-types/edgekv-internal-server-error
                additionalDetail:
                  requestId: cd9b61e08148009b
              schema:
                additionalProperties: false
                description: Error messaging.
                type: object
                properties:
                  additionalDetail:
                    additionalProperties: false
                    type: object
                    properties:
                      requestId:
                        description: Request identifier.
                        type: string
                  detail:
                    description: A description of the error.
                    type: string
                  errorCode:
                    description: Internal error code used to assist with troubleshooting by Akamai employees.
                    type: string
                  instance:
                    description: Reference to unique instance of the error.
                    type: string
                  status:
                    description: The HTTP code for the error.
                    type: integer
                  title:
                    description: Text representation of the HTTP error code.
                    type: string
                  type:
                    description: Reference to additional documentation.
                    type: string
                x-akamai:
                  file-path: schemas/error.yaml
      parameters:
      - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
        example: '{{accountSwitchKey}}'
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
  /auth/groups/{groupId}:
    parameters:
    - description: Unique identifier for an EdgeKV access group.
      example: '{{groupId}}'
      in: path
      name: groupId
      required: true
      schema:
        example: 4284
        minimum: 0
        type: integer
      x-akamai:
        file-path: parameters/auth-groupId-path.yaml
    get:
      description: View details permissions available within the specified access group, such as create a namespace or read data from a namespace.
      operationId: get-group
      summary: Akamai Get a Permission Group
      tags:
      - Permission groups
      externalDocs:
        description: See documentation for this operation in Akamai's EdgeKV API
        url: https://techdocs.akamai.com/edgekv/reference/get-group
      responses:
        '200':
          description: The response shows the EdgeKV permissions available to you within the Akamai access group.
          content:
            application/json:
              example:
                groupId: 0
                groupName: Account Group
                capabilities:
                - READ_DATA
                - WRITE_DATA
                - DELETE_DATA
                - READ_STAGING_DATA
                - WRITE_STAGING_DATA
                - DELETE_STAGING_DATA
                - VIEW_NAMESPACE
                - CREATE_NAMESPACE
                - MODIFY_NAMESPACE
                - DELETE_NAMESPACE
                - AUTHORIZE_NAMESPACE
                - VIEW_STAGING_NAMESPACE
                - CREATE_STAGING_NAMESPACE
                - MODIFY_STAGING_NAMESPACE
                - DELETE_STAGING_NAMESPACE
                - AUTHORIZE_STAGING_NAMESPACE
                - VIEW_TOKEN
                - CREATE_TOKEN
                - REVOKE_TOKEN
                - VIEW_STAGING_TOKEN
                - CREATE_STAGING_TOKEN
                - REVOKE_STAGING_TOKEN
              schema:
                additionalProperties: false
                type: object
                required:
                - groupId
                - groupName
                - capabilities
                properties:
                  capabilities:
                    description: Lists EdgeKV permissions available within the Akamai access group.
                    minItems: 1
                    type: array
                    uniqueItems: true
                    items:
                      type: string
                      enum:
                      - READ_DATA
                      - WRITE_DATA
                      - DELETE_DATA
                      - READ_STAGING_DATA
                      - WRITE_STAGING_DATA
                      - DELETE_STAGING_DATA
                      - VIEW_NAMESPACE
                      - CREATE_NAMESPACE
                      - MODIFY_NAMESPACE
                      - DELETE_NAMESPACE
                      - AUTHORIZE_NAMESPACE
                      - VIEW_STAGING_NAMESPACE
                      - CREATE_STAGING_NAMESPACE
                      - MODIFY_STAGING_NAMESPACE
                      - DELETE_STAGING_NAMESPACE
                      - AUTHORIZE_STAGING_NAMESPACE
                      - VIEW_TOKEN
                      - CREATE_TOKEN
                      - REVOKE_TOKEN
                      - VIEW_STAGING_TOKEN
                      - CREATE_STAGING_TOKEN
                      - REVOKE_STAGING_TOKEN
                  groupId:
                    description: Identifies the Akamai access group specified when the namespace was created.
                    minimum: 0
                    type: integer
                  groupName:
                    description: Name of an Akamai access group you assign to a new namespace.
                    type: string
                x-akamai:
                  file-path: schemas/auth-group-200.yaml
        '403':
          description: The user does not have capabilities for the Akamai group.
          content:
            application/problem+json:
              example:
                detail: You do not have access to group 100.
                errorCode: EKV_1000
                instance: /edgeKV/error-instances/2c82be29-f909-4d42-b775-de404e264fd9
                status: 403
                title: Forbidden
                type: /edgekv/error-types/edgekv-forbidden
                additionalDetail:
                  requestId: cd9b61e08148009b
              schema:
                additionalProperties: false
                description: Error messaging.
                type: object
                properties:
                  additionalDetail:
                    additionalProperties: false
                    type: object
                    properties:
                      requestId:
                        description: Request identifier.
                        type: string
                  detail:
                    description: A description of the error.
                    type: string
                  errorCode:
                    description: Internal error code used to assist with troubleshooting by Akamai employees.
                    type: string
                  instance:
                    description: Reference to unique instance of the error.
                    type: string
                  status:
                    description: The HTTP code for the error.
                    type: integer
                  title:
                    description: Text representation of the HTTP error code.
                    type: string
                  type:
                    description: Reference to additional documentation.
                    type: string
                x-akamai:
                  file-path: schemas/error.yaml
        '500':
          description: Internal error.
          content:
            application/problem+json:
              example:
                detail: An internal error occurred.
                errorCode: EKV_0000
                instance: /edgekv/error-instances/cdb7767c-817e-4805-9f28-0816eefa0ba8
                status: 500
                title: Internal Server Error
                type: /edgekv/error-types/edgekv-internal-server-error
                additionalDetail:
                  requestId: cd9b61e08148009b
              schema:
                additionalProperties: false
                description: Error messaging.
                type: object
                properties:
                  additionalDetail:
                    additionalProperties: false
                    type: object
                    properties:
                      requestId:
                        description: Request identifier.
                        type: string
                  detail:
                    description: A description of the error.
                    type: string
                  errorCode:
                    description: Internal error code used to assist with troubleshooting by Akamai employees.
                    type: string
                  instance:
                    description: Reference to unique instance of the error.
                    type: string
                  status:
                    description: The HTTP code for the error.
                    type: integer
                  title:
                    description: Text representation of the HTTP error code.
                    type: string
                  type:
                    description: Reference to additional documentation.
                    type: string
                x-akamai:
                  file-path: schemas/error.yaml
      parameters:
      - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
        example: '{{accountSwitchKey}}'
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
  /groups:
    get:
      description: 'View a list of groups and the associated permission capabilities, for example: activate a version or fetch an EdgeWorker ID.'
      operationId: get-groups
      summary: Akamai List Permission Groups
      tags:
      - Permission groups
      externalDocs:
        description: See documentation for this operation in Akamai's EdgeWorkers API
        url: https://techdocs.akamai.com/edgeworkers/reference/get-groups
      responses:
        '200':
          description: Describes a list of EdgeWorker Groups.
          content:
            application/json:
              example:
                groups:
                - groupId: 4284
                  groupName: 'Group #42'
                  capabilities:
                  - VIEW
                  - VIEW_VERSION
                  - VIEW_ACTIVATION
                  - ACTIVATE
                - groupId: 109795
                  groupName: ESSL Behavior Tests
                  capabilities:
                  - VIEW
                  - EDIT
                  - VIEW_VERSION
                  - CREATE_VERSION
                  - VIEW_ACTIVATION
                  - ACTIVATE
              schema:
                additionalProperties: false
                type: object
                required:
                - groups
                properties:
                  groups:
                    description: List of EdgeWorker groups.
                    minItems: 1
                    type: array
                    items:
                      additionalProperties: false
                      type: object
                      required:
                      - groupId
                      - groupName
                      - capabilities
                      properties:
                        capabilities:
                          description: List of EdgeWorker capabilities allowed within the group, including `VIEW`, `EDIT`, `VIEW_VERSION`, `CREATE_VERSION`, `VIEW_ACTIVATION`, and `ACTIVATE`.
                          minItems: 1
                          type: array
                          uniqueItems: true
                          items:
                            type: string
                            enum:
                            - VIEW
                            - EDIT
                            - VIEW_VERSION
                            - CREATE_VERSION
                            - VIEW_ACTIVATION
                            - ACTIVATE
                        groupId:
                          description: Unique identifier of the Akamai group specified when the EdgeWorker was created.
                          minimum: 1
                          type: integer
                        groupName:
                          description: Name of the Akamai group specified when the EdgeWorker was created.
                          minLength: 1
                          type: string
                      x-akamai:
                        file-path: schemas/group-get-200.yaml
                x-akamai:
                  file-path: schemas/groups-get-200.yaml
      parameters:
      - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
        example: '{{accountSwitchKey}}'
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
  /groups/{groupId}:
    parameters:
    - description: Unique identifier for an EdgeWorker group. You can pass in plain integer IDs, or add a `grp_` prefix. The Property Manager API supports both formats. See [ID prefixes](https://techdocs.akamai.com/property-mgr/reference/api/id-prefixes) for details.
      example: '{{groupId}}'
      in: path
      name: groupId
      required: true
      schema:
        example: 72297
        type: number
      x-akamai:
        file-path: parameters/groupId-path.yaml
    get:
      description: 'View details on the capabilities enabled within a specified group, for example: activate a version or fetch an EdgeWorker ID.'
      operationId: get-group
      summary: Akamai Get a Permission Group
      tags:
      - Permission groups
      externalDocs:
        description: See documentation for this operation in Akamai's EdgeWorkers API
        url: https://techdocs.akamai.com/edgeworkers/reference/get-group
      responses:
        '200':
          description: This section describes EdgeWorker capabilities allowed within the Akamai group.
          content:
            application/json:
              example:
                groupId: 109795
                groupName: ESSL Behavior Tests
                capabilities:
                - VIEW
                - VIEW_VERSION
                - VIEW_ACTIVATION
              schema:
                additionalProperties: false
                type: object
                required:
                - groupId
                - groupName
                - capabilities
                properties:
                  capabilities:
                    description: List of EdgeWorker capabilities allowed within the group, including `VIEW`, `EDIT`, `VIEW_VERSION`, `CREATE_VERSION`, `VIEW_ACTIVATION`, and `ACTIVATE`.
                    minItems: 1
                    type: array
                    uniqueItems: true
                    items:
                      type: string
                      enum:
                      - VIEW
                      - EDIT
                      - VIEW_VERSION
                      - CREATE_VERSION
                      - VIEW_ACTIVATION
                      - ACTIVATE
                  groupId:
                    description: Unique identifier of the Akamai group specified when the EdgeWorker was created.
                    minimum: 1
                    type: integer
                  groupName:
                    description: Name of the Akamai group specified when the EdgeWorker was created.
                    minLength: 1
                    type: string
                x-akamai:
                  file-path: schemas/group-get-200.yaml
      parameters:
      - description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
        example: '{{accountSwitchKey}}'
        in: query
        name: accountSwitchKey
        required: false
        schema:
          example: 1-5C0YLB:1-8BYUX
          type: string
externalDocs:
  description: See documentation for Akamai's API Endpoint Definition API
  url: https://techdocs.akamai.com/api-definitions/reference
x-readme:
  samples-languages:
  - curl
  - python
  - node