APIs.io Engineering Platform User API

openapi: 3.2.0
info:
  title: Engineering Platform User API
  version: '1.0'
  description: 'Operations tagged User across 2 of this provider''s published API definitions: cloudflare-openapi-original.yml, postman-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getpostman.com
- url: https://api.eu.postman.com
tags:
- name: User
paths:
  /user:
    get:
      operationId: user-user-details
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: User Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_user_response'
          description: User Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform User Details
      tags:
      - User
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      description: Edit part of your user details.
      operationId: user-edit-user
      requestBody:
        content:
          application/json:
            schema:
              properties:
                country:
                  $ref: '#/components/schemas/iam_country'
                first_name:
                  $ref: '#/components/schemas/iam_first_name'
                last_name:
                  $ref: '#/components/schemas/iam_last_name'
                telephone:
                  $ref: '#/components/schemas/iam_telephone'
                zipcode:
                  $ref: '#/components/schemas/iam_zipcode'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_api-response-common-failure'
          description: Edit User response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_user_response'
          description: Edit User response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Edit User
      tags:
      - User
      x-cfPermissionsRequired:
        enum:
        - com.cloudflare.api.user.update
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /me:
    get:
      summary: APIs.io Engineering Platform Get authenticated user
      description: 'Gets information about the authenticated user.


        **Note:**


        - This API returns a different response for users with the [Guest and Partner roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).

        - The `flow_count` response only returns for users on [Free plans](https://www.postman.com/pricing/).

        '
      operationId: getAuthenticatedUser
      tags:
      - User
      responses:
        '200':
          $ref: '#/components/responses/getAuthenticatedUser'
        '401':
          $ref: '#/components/responses/common401Error'
        '500':
          $ref: '#/components/responses/common500ErrorServerError'
      security:
      - PostmanApiKey: []
      - scimApiKey: []
    servers:
    - url: https://api.getpostman.com
    - url: https://api.eu.postman.com
components:
  schemas:
    iam_telephone:
      description: User's telephone number
      example: +1 123-123-1234
      maxLength: 20
      type:
      - string
      - 'null'
    iam_single_user_response:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-single'
      - properties:
          result:
            type: object
        type: object
    iam_zipcode:
      description: The zipcode or postal code where the user lives.
      example: '12345'
      maxLength: 20
      type:
      - string
      - 'null'
    iam_last_name:
      description: User's last name
      example: Appleseed
      maxLength: 60
      type:
      - string
      - 'null'
    iam_first_name:
      description: User's first name
      example: John
      maxLength: 60
      type:
      - string
      - 'null'
    iam_country:
      description: The country in which the user lives.
      example: US
      maxLength: 30
      type:
      - string
      - 'null'
    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_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    iam_api-response-single:
      allOf:
      - $ref: '#/components/schemas/iam_api-response-common'
      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
    getAuthenticatedUser:
      title: Successful Response
      type: object
      properties:
        user:
          type: object
          description: Information about the authenticated user.
          properties:
            id:
              type: number
              description: The user's Postman ID.
              example: 12345678
            username:
              type: string
              description: The user's username.
              example: taylor-lee
            email:
              type: string
              format: email
              description: The user's email address.
              example: taylor.lee@example.com
            fullName:
              type: string
              description: The user's full name.
              example: Taylor Lee
            avatar:
              type:
              - string
              - 'null'
              format: url
              description: The user's avatar image URL.
              example: https://example.com/user/r5u9qpvmujfjf6lbqmga.jpg
            isPublic:
              type: boolean
              description: If true, the user's information is public and visible to all users.
              example: true
            teamId:
              type: integer
              description: The team ID the user is assigned to. This returns a `0` value if the user is not assigned to a team.
              example: 123
            teamName:
              type: string
              description: The name of the team the user is assigned to.
              example: Test Team
            teamDomain:
              type: string
              description: The team's Postman domain ID.
              example: test-team
            roles:
              type: array
              description: A list of the user's assigned [roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).
              items:
                type: string
                default: user
                example: user
        operations:
          type: array
          description: Information about operations and their usage limits. This object does not return for users with the [Guest and Partner role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).
          items:
            type: object
            properties:
              limit:
                type: number
                description: The operation's limit value.
                example: 1000000
              name:
                type: string
                description: The operation's name.
                example: mock_usage
              overage:
                type: number
                description: The operation's overage value.
                example: 0
              usage:
                type: number
                description: The operation's current usage value.
                example: 110276
  responses:
    getAuthenticatedUser:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/getAuthenticatedUser'
          example:
            user:
              id: 12345678
              username: taylor-lee
              email: taylor.lee@example.com
              fullName: Taylor Lee
              avatar: https://res.cloudinary.com/postman/image/upload/t_user_profile_300/v1/user/default-6
              isPublic: true
              teamId: 123
              teamName: Test Team
              teamDomain: test-team
              roles:
              - user
              - flow-editor
              - community-manager
            operations:
            - name: api_object_usage
              limit: 99999999
              usage: 8872
              overage: 0
            - name: collection_run_limit
              limit: 99999999
              usage: 226
              overage: 0
            - name: file_storage_limit
              limit: 1
              usage: 0.28
              overage: 0
            - name: flow_requests
              limit: 1000000
              usage: 1852
              overage: 0
            - name: performance_test_limit
              limit: 99999999
              usage: 10
              overage: 0
            - name: reusable_packages
              limit: 100
              usage: 48
              overage: 0
            - name: test_data_retrieval
              limit: 1000
              usage: 180
              overage: 0
            - name: test_data_storage
              limit: 10
              usage: 0.55
              overage: 0
            - name: postbot_calls
              limit: 2500
              usage: 0
              overage: 0
            - name: mock_usage
              limit: 1000000
              usage: 79948
              overage: 0
            - name: monitor_request_runs
              limit: 15000000
              usage: 4493710
              overage: 0
            - name: api_usage
              limit: 1000000
              usage: 10788
              overage: 0
    common401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: Unauthorized
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: Unauthorized
            status: 401
    common500ErrorServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  name:
                    type: string
                    description: The error name.
                    example: serverError
                  message:
                    type: string
                    description: The error message.
                    example: An error has occurred on the server.
          example:
            error:
              name: serverError
              message: An error has occurred on the server.
  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
    PostmanApiKey:
      type: apiKey
      in: header
      name: x-api-key
    scimApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
x-refined-from:
- cloudflare-openapi-original.yml
- postman-openapi-original.yml
x-hasEquivalentPaths: true