APIs.io Engineering Platform Zero Trust Users 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 Users API
  version: 4.0.0
tags:
- name: Zero Trust Users
paths:
  /accounts/{account_id}/access/users:
    get:
      description: Gets a list of users for an account.
      operationId: zero-trust-users-get-users
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get users response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_users_components-schemas-response_collection'
          description: Get users response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get users
      tags:
      - Zero Trust Users
      x-api-token-group:
      - 'Access: Audit Logs Read'
  /accounts/{account_id}/access/users/{user_id}/active_sessions:
    get:
      description: Get active sessions for a single user.
      operationId: zero-trust-users-get-active-sessions
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get active sessions response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_active_sessions_response'
          description: Get active sessions response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get active sessions
      tags:
      - Zero Trust Users
  /accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce}:
    get:
      description: Get an active session for a single user.
      operationId: zero-trust-users-get-active-session
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      - in: path
        name: nonce
        required: true
        schema:
          $ref: '#/components/schemas/access_nonce'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get active session response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_active_session_response'
          description: Get active session response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get single active session
      tags:
      - Zero Trust Users
  /accounts/{account_id}/access/users/{user_id}/failed_logins:
    get:
      description: Get all failed login attempts for a single user.
      operationId: zero-trust-users-get-failed-logins
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get failed logins response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_failed_login_response'
          description: Get failed logins response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get failed logins
      tags:
      - Zero Trust Users
      x-api-token-group:
      - 'Access: Audit Logs Read'
  /accounts/{account_id}/access/users/{user_id}/last_seen_identity:
    get:
      description: Get last seen identity for a single user.
      operationId: zero-trust-users-get-last-seen-identity
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get active session response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_last_seen_identity_response'
          description: Get active session response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get last seen identity
      tags:
      - Zero Trust Users
components:
  schemas:
    access_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    access_last_successful_login:
      description: The time at which the user last successfully logged in.
      example: '2020-07-01T05:20:00Z'
      format: date-time
      type: string
    access_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      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_last_seen_identity_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/access_identity'
            type: object
    access_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    access_uid:
      description: The unique API identifier for the user.
      type: string
    access_active_sessions_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            items:
              properties:
                expiration:
                  example: 1694813506.0
                  type: integer
                metadata:
                  properties:
                    apps:
                      additionalProperties:
                        properties:
                          hostname:
                            example: test.example.com
                            type: string
                          name:
                            example: app name
                            type: string
                          type:
                            example: self_hosted
                            type: string
                          uid:
                            example: cc2a8145-0128-4429-87f3-872c4d380c4e
                            type: string
                        type: object
                      type: object
                    expires:
                      example: 1694813506.0
                      type: integer
                    iat:
                      example: 1694791905.0
                      type: integer
                    nonce:
                      example: X1aXj1lFVcqqyoXF
                      type: string
                    ttl:
                      example: 21600
                      type: integer
                  type: object
                name:
                  type: string
              type: object
            type: array
    access_users_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result_info:
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 100
              total_count:
                example: 1
            type: object
      - properties:
          result:
            items:
              $ref: '#/components/schemas/access_users'
            type: array
    access_string_key_map_device_session:
      additionalProperties:
        $ref: '#/components/schemas/access_device_session'
      type: object
    access_schemas-access_seat:
      description: True if the user has authenticated with Cloudflare Access.
      example: false
      type: boolean
    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_device_session:
      example:
        last_authenticated: 1638832687.0
      properties:
        last_authenticated:
          type: number
      type: object
    access_active_session_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/access_identity'
            - properties:
                isActive:
                  example: true
                  type: boolean
              type: object
            type: object
    access_nonce:
      example: X1aXj1lFVcqqyoXF
      type: string
    access_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    access_schemas-seat_uid:
      description: The unique API identifier for the Zero Trust seat.
      type: string
    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_identity:
      properties:
        account_id:
          example: '1234567890'
          type: string
        auth_status:
          example: NONE
          type: string
        common_name:
          example: ''
          type: string
        device_id:
          example: ''
          type: string
        device_sessions:
          $ref: '#/components/schemas/access_string_key_map_device_session'
        devicePosture:
          additionalProperties:
            $ref: '#/components/schemas/access_schemas-device_posture_rule'
          type: object
        email:
          example: test@cloudflare.com
          type: string
        geo:
          $ref: '#/components/schemas/access_geo'
        iat:
          example: 1694791905.0
          type: number
        idp:
          properties:
            id:
              type: string
            type:
              type: string
          type: object
        ip:
          example: 127.0.0.0
          type: string
        is_gateway:
          example: false
          type: boolean
        is_warp:
          example: false
          type: boolean
        mtls_auth:
          properties:
            auth_status:
              type: string
            cert_issuer_dn:
              type: string
            cert_issuer_ski:
              type: string
            cert_presented:
              type: boolean
            cert_serial:
              type: string
          type: object
        service_token_id:
          example: ''
          type: string
        service_token_status:
          example: false
          type: boolean
        user_uuid:
          example: 57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4
          type: string
        version:
          example: 2
          type: number
      type: object
    access_users:
      properties:
        access_seat:
          $ref: '#/components/schemas/access_schemas-access_seat'
        active_device_count:
          $ref: '#/components/schemas/access_active_device_count'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        email:
          $ref: '#/components/schemas/access_email'
        gateway_seat:
          $ref: '#/components/schemas/access_schemas-gateway_seat'
        id:
          $ref: '#/components/schemas/access_uuid'
        last_successful_login:
          $ref: '#/components/schemas/access_last_successful_login'
        name:
          $ref: '#/components/schemas/access_users_components-schemas-name'
        seat_uid:
          $ref: '#/components/schemas/access_schemas-seat_uid'
        uid:
          $ref: '#/components/schemas/access_uid'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_active_device_count:
      description: The number of active devices registered to the user.
      example: 2
      type: number
    access_schemas-device_posture_rule:
      properties:
        check:
          $ref: '#/components/schemas/access_device_posture_check'
        data:
          type: object
        description:
          type: string
        error:
          type: string
        id:
          type: string
        rule_name:
          type: string
        success:
          type: boolean
        timestamp:
          type: string
        type:
          type: string
      type: object
    access_schemas-gateway_seat:
      description: True if the user has logged into the WARP client.
      example: false
      type: boolean
    access_email:
      description: The email of the user.
      example: jdoe@example.com
      format: email
      type: string
    access_failed_login_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            items:
              properties:
                expiration:
                  type: integer
                metadata:
                  example:
                    app_name: Test App
                    aud: 39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04
                    datetime: '2022-02-02T21:54:34.914Z'
                    ray_id: 6d76a8a42ead4133
                    user_email: test@cloudflare.com
                    user_uuid: 57171132-e453-4ee8-b2a5-8cbaad333207
                  type: object
              type: object
            type: array
    access_users_components-schemas-name:
      description: The name of the user.
      example: Jane Doe
      type: string
    access_device_posture_check:
      properties:
        exists:
          type: boolean
        path:
          type: string
      type: object
    access_geo:
      example:
        country: US
      properties:
        country:
          type: string
      type: object
    access_api-response-single:
      allOf:
      - $ref: '#/components/schemas/access_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