APIs.io Engineering Platform Account Members 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 Members API
  version: 4.0.0
tags:
- name: Account Members
paths:
  /accounts/{account_id}/members:
    get:
      description: List all members of an account.
      operationId: account-members-list-members
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_account_identifier'
      - in: query
        name: order
        schema:
          description: Field to order results by.
          enum:
          - user.first_name
          - user.last_name
          - user.email
          - status
          example: status
      - in: query
        name: status
        schema:
          description: A member's status in the account.
          enum:
          - accepted
          - pending
          - rejected
          example: accepted
          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
      - in: query
        name: direction
        schema:
          description: Direction to order results.
          enum:
          - asc
          - desc
          example: desc
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: List Members response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_collection_member_response_with_policies'
          description: List Members response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Members
      tags:
      - Account Members
      x-api-token-group:
      - Account Settings Write
      - Account Settings Read
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Add a user to the list of members for this account.
      operationId: account-members-add-member
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/iam_create-member-with-roles'
              - $ref: '#/components/schemas/iam_create-member-with-policies'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Add Member response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_member_response_with_policies'
          description: Add Member response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Add Member
      tags:
      - Account Members
      x-api-token-group:
      - Account Settings Write
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/members/{member_id}:
    delete:
      description: Remove a member from an account.
      operationId: account-members-remove-member
      parameters:
      - in: path
        name: member_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Remove Member response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-single-id'
          description: Remove Member response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Remove Member
      tags:
      - Account Members
      x-api-token-group:
      - Account Settings Write
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Get information about a specific member of an account.
      operationId: account-members-member-details
      parameters:
      - in: path
        name: member_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Member Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_member_response_with_policies'
          description: Member Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Member Details
      tags:
      - Account Members
      x-api-token-group:
      - Account Settings Write
      - Account Settings Read
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Modify an account member.
      operationId: account-members-update-member
      parameters:
      - in: path
        name: member_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/iam_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/iam_update-member-with-roles'
              - $ref: '#/components/schemas/iam_update-member-with-policies'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Update Member response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_member_response_with_policies'
          description: Update Member response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Member
      tags:
      - Account Members
      x-api-token-group:
      - Account Settings Write
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  schemas:
    iam_common_components-schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    iam_create_member_policy:
      properties:
        access:
          $ref: '#/components/schemas/iam_access'
        id:
          $ref: '#/components/schemas/iam_identifier'
        permission_groups:
          $ref: '#/components/schemas/iam_member_permission_groups'
        resource_groups:
          $ref: '#/components/schemas/iam_member_resource_groups'
      required:
      - id
      - access
      - permission_groups
      - resource_groups
      title: create_member_policy
    iam_permissions:
      example:
        analytics:
          read: true
          write: false
        zones:
          read: true
          write: true
      properties:
        analytics:
          $ref: '#/components/schemas/iam_grants'
        billing:
          $ref: '#/components/schemas/iam_grants'
        cache_purge:
          $ref: '#/components/schemas/iam_grants'
        dns:
          $ref: '#/components/schemas/iam_grants'
        dns_records:
          $ref: '#/components/schemas/iam_grants'
        lb:
          $ref: '#/components/schemas/iam_grants'
        logs:
          $ref: '#/components/schemas/iam_grants'
        organization:
          $ref: '#/components/schemas/iam_grants'
        ssl:
          $ref: '#/components/schemas/iam_grants'
        waf:
          $ref: '#/components/schemas/iam_grants'
        zone_settings:
          $ref: '#/components/schemas/iam_grants'
        zones:
          $ref: '#/components/schemas/iam_grants'
      type: object
    iam_grants:
      example:
        read: true
        write: false
      properties:
        read:
          example: true
          type: boolean
        write:
          example: true
          type: boolean
      type: object
    iam_schemas-permissions:
      description: Access permissions for this User.
      items:
        example: '#zones:read'
        maxLength: 160
        type: string
      readOnly: true
      type: array
    iam_identifier:
      description: Policy identifier.
      example: f267e341f3dd4697bd3b9f71dd96247f
      readOnly: true
      type: string
    iam_create-member-with-roles:
      properties:
        email:
          $ref: '#/components/schemas/iam_email'
        roles:
          description: Array of roles associated with this member.
          items:
            $ref: '#/components/schemas/iam_role_components-schemas-identifier'
          type: array
        status:
          default: pending
          enum:
          - accepted
          - pending
      required:
      - email
      - roles
      title: Add Member with Account Roles
      type: object
    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_collection_member_response_with_policies:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/iam_member_with_policies'
            type: array
        type: object
      title: Members with Policies
    iam_description:
      description: Description of role's permissions.
      example: Administrative access to the entire Organization
      readOnly: true
      type: string
    iam_member_resource_groups:
      description: A list of resource groups that the policy applies to.
      items:
        $ref: '#/components/schemas/iam_member_resource_group'
      type: array
    iam_api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/iam_common_components-schemas-identifier'
            required:
            - id
            type:
            - object
            - 'null'
      type: object
    iam_last_name:
      description: User's last name
      example: Appleseed
      maxLength: 60
      type:
      - string
      - 'null'
    iam_email:
      description: The contact email address of the user.
      example: user@example.com
      maxLength: 90
      type: string
    iam_member_permission_groups:
      description: A set of permission groups that are specified to the policy.
      example:
      - id: c8fed203ed3043cba015a93ad1616f1f
      - id: 82e64a83756745bbbb1c9c2701bf816b
      items:
        $ref: '#/components/schemas/iam_member_permission_group'
      type: array
    iam_single_member_response_with_policies:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/iam_member_with_policies'
        type: object
      title: Response with Policies
    iam_role:
      properties:
        description:
          description: Description of role's permissions.
          example: Administrative access to the entire Account
          readOnly: true
          type: string
        id:
          $ref: '#/components/schemas/iam_role_components-schemas-identifier'
        name:
          description: Role name.
          example: Account Administrator
          maxLength: 120
          readOnly: true
          type: string
        permissions:
          allOf:
          - $ref: '#/components/schemas/iam_permissions'
          - readOnly: true
      required:
      - id
      - name
      - description
      - permissions
      type: object
    iam_resource_group:
      description: A group of scoped resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
          type: string
        meta:
          description: Attributes associated to the resource group.
          example:
            editable: 'false'
          properties:
            key:
              type: string
            value:
              type: string
          type: object
        name:
          description: Name of the resource group.
          example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4
          readOnly: true
          type: string
        scope:
          description: The scope associated to the resource group
          items:
            $ref: '#/components/schemas/iam_scope'
          type: array
      required:
      - id
      - scope
      type: object
    iam_scope_object:
      description: A scope object represents any resource that can have actions applied against invite.
      properties:
        key:
          $ref: '#/components/schemas/iam_scope_object_key'
      required:
      - key
      type: object
    iam_member_resource_group:
      description: A group of scoped resources.
      properties:
        id:
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          type: string
      required:
      - id
      type: object
    iam_components-schemas-name:
      description: Role Name.
      example: Organization Admin
      maxLength: 120
      readOnly: true
      type: string
    iam_account_identifier:
      description: Account identifier tag.
      example: eb78d65290b24279ba6f44721b3ea3c4
      maxLength: 32
      readOnly: true
      type: string
    iam_member_with_policies:
      properties:
        id:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        policies:
          description: Access policy for the membership
          items:
            $ref: '#/components/schemas/iam_list_member_policy'
          type: array
        roles:
          description: Roles assigned to this Member.
          items:
            $ref: '#/components/schemas/iam_schemas-role'
          type: array
        status:
          description: A member's status in the account.
          enum:
          - accepted
          - pending
          example: accepted
          readOnly: true
        user:
          description: Details of the user associated to the membership.
          properties:
            email:
              $ref: '#/components/schemas/iam_email'
            first_name:
              $ref: '#/components/schemas/iam_first_name'
            id:
              $ref: '#/components/schemas/iam_common_components-schemas-identifier'
            last_name:
              $ref: '#/components/schemas/iam_last_name'
            two_factor_authentication_enabled:
              $ref: '#/components/schemas/iam_two_factor_authentication_enabled'
          readOnly: true
          required:
          - email
          type: object
      type: object
    iam_resource_groups:
      description: A list of resource groups that the policy applies to.
      items:
        $ref: '#/components/schemas/iam_resource_group'
      type: array
    iam_scope_key:
      description: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
      example: com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4
      readOnly: true
    iam_create-member-with-policies:
      properties:
        email:
          $ref: '#/components/schemas/iam_email'
        policies:
          description: Array of policies associated with this member.
          items:
            $ref: '#/components/schemas/iam_create_member_policy'
          type: array
        status:
          default: pending
          enum:
          - accepted
          - pending
      required:
      - email
      - policies
      title: Add Member with Policies
      type: object
    iam_schemas-role:
      properties:
        description:
          $ref: '#/components/schemas/iam_description'
        id:
          $ref: '#/components/schemas/iam_role_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/iam_components-schemas-name'
        permissions:
          $ref: '#/components/schemas/iam_schemas-permissions'
      required:
      - id
      - name
      - description
      - permissions
      type: object
    iam_scope_object_key:
      description: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
      example: com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5
      readOnly: true
    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_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    iam_member_permission_group:
      description: A group of permissions.
      properties:
        id:
          description: Identifier of the group.
          example: c8fed203ed3043cba015a93ad1616f1f
          type: string
      required:
      - id
      type: object
    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
    iam_membership_components-schemas-identifier:
      description: Membership identifier tag.
      example: 4536bcfad5faccb111b47003c79917fa
      maxLength: 32
      readOnly: true
      type: string
    iam_list_member_policy:
      properties:
        access:
          $ref: '#/components/schemas/iam_access'
        id:
          $ref: '#/components/schemas/iam_identifier'
        permission_groups:
          $ref: '#/components/schemas/iam_permission_groups'
        resource_groups:
          $ref: '#/components/schemas/iam_resource_groups'
      title: list_member_policy
    iam_scope:
      description: A scope is a combination of scope objects which provides additional context.
      properties:
        key:
          $ref: '#/components/schemas/iam_scope_key'
        objects:
          description: A list of scope objects for additional context.
          items:
            $ref: '#/components/schemas/iam_scope_object'
          type: array
      required:
      - key
      - objects
      type: object
    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_update-member-with-roles:
      allOf:
      - $ref: '#/components/schemas/iam_member'
      title: Update Member with Account Roles
    iam_update-member-with-policies:
      properties:
        policies:
          description: Array of policies associated with this member.
          items:
            $ref: '#/components/schemas/iam_create_member_policy'
          type: array
      required:
      - policies
      title: Update Member with Policies
      type: object
    iam_access:
      description: Allow or deny operations against the resources.
      enum:
      - allow
      - deny
      example: allow
      type: string
    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_two_factor_authentication_enabled:
      default: false
      description: Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.
      readOnly: true
      type: boolean
    iam_first_name:
      description: User's first name
      example: John
      maxLength: 60
      type:
      - string
      - 'null'
    iam_role_components-schemas-identifier:
      description: Role identifier tag.
      example: 3536bcfad5faccb999b47003c79917fb
      maxLength: 32
      type: string
    iam_member:
      properties:
        id:
          $ref: '#/components/schemas/iam_membership_components-schemas-identifier'
        roles:
          description: Roles assigned to this member.
          items:
            $ref: '#/components/schemas/iam_role'
          type: array
        status:
          description: A member's status in the account.
          enum:
          - accepted
          - pending
          example: accepted
          readOnly: true
        user:
          description: Details of the user associated to the membership.
          properties:
            email:
              $ref: '#/components/schemas/iam_email'
            first_name:
              $ref: '#/components/schemas/iam_first_name'
            id:
              $ref: '#/components/schemas/iam_common_components-schemas-identifier'
            last_name:
              $ref: '#/components/schemas/iam_last_name'
            two_factor_authentication_enabled:
              $ref: '#/components/schemas/iam_two_factor_authentication_enabled'
          readOnly: true
          required:
          - email
          type: object
      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_api-response-single:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      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