APIs.io Engineering Platform Zero Trust Seats 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 Zero Trust Seats API
  version: 4.0.0
tags:
- name: Zero Trust Seats
paths:
  /accounts/{account_id}/access/seats:
    patch:
      description: Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false.
      operationId: zero-trust-seats-update-a-user-seat
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_seats_definition'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update a user seat response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_seats_components-schemas-response_collection'
          description: Update a user seat response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a user seat
      tags:
      - Zero Trust Seats
      x-api-token-group:
      - 'Zero Trust: Seats Write'
components:
  schemas:
    access_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
    access_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/access_messages'
        messages:
          $ref: '#/components/schemas/access_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    access_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    access_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/access_result_info'
      type: object
    access_access_seat:
      description: True if the seat is part of Access.
      example: false
      type: boolean
    access_schemas-identifier:
      allOf:
      - $ref: '#/components/schemas/access_identifier'
      - example: 699d98642c564d2e855e9661899b7252
    access_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    access_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/access_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/access_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
    access_seats_definition:
      items:
        $ref: '#/components/schemas/access_seat'
      required:
      - seat_uid
      - gateway_seat
      - access_seat
      type: array
    access_seat:
      properties:
        access_seat:
          $ref: '#/components/schemas/access_access_seat'
        gateway_seat:
          $ref: '#/components/schemas/access_gateway_seat'
        seat_uid:
          $ref: '#/components/schemas/access_seat_uid'
      required:
      - seat_uid
      - gateway_seat
      - access_seat
      type: object
    access_seats:
      properties:
        access_seat:
          $ref: '#/components/schemas/access_access_seat'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        gateway_seat:
          $ref: '#/components/schemas/access_gateway_seat'
        seat_uid:
          $ref: '#/components/schemas/access_seat_uid'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_seats_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/access_seats'
            type: array
    access_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    access_seat_uid:
      description: The unique API identifier for the Zero Trust seat.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    access_gateway_seat:
      description: True if the seat is part of Gateway.
      example: false
      type: boolean
  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