APIs.io Engineering Platform Account Permission Groups API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Account Permission Groups API
  version: 4.0.0
tags:
- name: Account Permission Groups
paths:
  /accounts/{account_id}/iam/permission_groups:
    get:
      description: List all the permissions groups for an account.
      operationId: account-permission-group-list
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_account_identifier'
      - in: query
        name: id
        schema:
          description: ID of the permission group to be fetched.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          maxLength: 32
          minLength: 32
          type: string
      - in: query
        name: name
        schema:
          description: Name of the permission group to be fetched.
          example: NameOfThePermissionGroup
          type: string
      - in: query
        name: label
        schema:
          description: Label of the permission group to be fetched.
          example: labelOfThePermissionGroup
          type: string
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      - in: query
        name: per_page
        schema:
          default: 20
          description: Maximum number of results per page.
          maximum: 50
          minimum: 5
          type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Permission Groups response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_permission_groups_response'
          description: List Permission Groups response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Account Permission Groups
      tags:
      - Account Permission Groups
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - DDoS Botnet Feed Write
      - DDoS Botnet Feed Read
      - Workers R2 Storage Write
      - Workers R2 Storage Read
      - DDoS Protection Write
      - DDoS Protection Read
      - Workers Tail Read
      - Workers KV Storage Write
      - Workers KV Storage Read
      - Workers Scripts Write
      - Workers Scripts Read
      - 'Load Balancing: Monitors and Pools Write'
      - 'Load Balancing: Monitors and Pools Read'
      - Account Firewall Access Rules Write
      - Account Firewall Access Rules Read
      - DNS Firewall Write
      - DNS Firewall Read
      - Billing Write
      - Billing Read
      - Account Settings Write
      - Account Settings Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.iam.permission-group.list
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/iam/permission_groups/{permission_group_id}:
    get:
      description: Get information about a specific permission group in an account.
      operationId: account-permission-group-details
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_account_identifier'
      - in: path
        name: permission_group_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_permission_group_components-schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Permission Group Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_permission_group'
          description: Permission Group Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Permission Group Details
      tags:
      - Account Permission Groups
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - DDoS Botnet Feed Write
      - DDoS Botnet Feed Read
      - Workers R2 Storage Write
      - Workers R2 Storage Read
      - DDoS Protection Write
      - DDoS Protection Read
      - Workers Tail Read
      - Workers KV Storage Write
      - Workers KV Storage Read
      - Workers Scripts Write
      - Workers Scripts Read
      - 'Load Balancing: Monitors and Pools Write'
      - 'Load Balancing: Monitors and Pools Read'
      - Account Firewall Access Rules Write
      - Account Firewall Access Rules Read
      - DNS Firewall Write
      - DNS Firewall Read
      - Billing Write
      - Billing Read
      - Account Settings Write
      - Account Settings Read
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.iam.permission-group.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  schemas:
    iam_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      - properties:
          result:
            items: {}
            type:
            - array
            - 'null'
          result_info:
            $ref: '#/components/schemas/iam_result_info'
      type: object
    iam_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    iam_account_identifier:
      description: Account identifier tag.
      example: eb78d65290b24279ba6f44721b3ea3c4
      maxLength: 32
      readOnly: true
      type: string
    iam_permission_groups:
      description: A set of permission groups that are specified to the policy.
      example:
      - id: c8fed203ed3043cba015a93ad1616f1f
        meta:
          label: load_balancer_admin
          scopes: com.cloudflare.api.account
        name: Zone Read
      - id: 82e64a83756745bbbb1c9c2701bf816b
        meta:
          label: fbm_user
          scopes: com.cloudflare.api.account
        name: Magic Network Monitoring
      items:
        $ref: '#/components/schemas/iam_permission_group'
      type: array
    iam_permission_group_components-schemas-identifier:
      description: Permission Group identifier tag.
      example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
      maxLength: 32
      readOnly: true
      type: string
    iam_permission_group:
      description: A named group of permissions that map to a group of operations against resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
          type: string
        meta:
          description: Attributes associated to the permission group.
          example:
            label: load_balancer_admin
            scopes: com.cloudflare.api.account
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        name:
          description: Name of the group.
          example: Load Balancer
          readOnly: true
          type: string
      required:
      - id
      type: object
    iam_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/iam_messages'
        messages:
          $ref: '#/components/schemas/iam_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    iam_collection_permission_groups_response:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-collection'
      - properties:
          result:
            $ref: '#/components/schemas/iam_permission_groups'
        type: object
      title: List of Resource groups
    iam_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    iam_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/iam_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/iam_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey