openapi: 3.2.0
info:
  contact:
    name: IXON B.V.
    url: https://www.ixon.cloud/
    email: support@ixon.cloud
  description: API for the IXON Cloud Platform
  license:
    name: All Rights Reserved
    url: https://www.ixon.cloud/
  title: IXON My User API
  version: 0.1.294
servers:
- description: IXON Cloud platform server
  url: https://portal.ixon.cloud:443/api/
tags:
- name: My User
paths:
  /users/me:
    get:
      tags:
      - My User
      summary: MyUser
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - type
                - data
                properties:
                  status:
                    type: string
                    default: success
                  type:
                    type: string
                  data:
                    type: object
                    properties:
                      publicId:
                        maxLength: 12
                        minLength: 12
                        type: string
                      type:
                        enum:
                        - person
                        - service_account
                        type: string
                      name:
                        maxLength: 255
                        minLength: 1
                        type: string
                      emailAddress:
                        maxLength: 254
                        minLength: 6
                        pattern: ^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                        type:
                        - string
                        - 'null'
                      support:
                        type: boolean
                      custom:
                        type: object
                      hasPassword:
                        type: boolean
                      externallyManaged:
                        type: boolean
                      language:
                        maxLength: 2
                        minLength: 2
                        type: string
                      localisation:
                        maxLength: 10
                        minLength: 1
                        type:
                        - string
                        - 'null'
                      timeZone:
                        maxLength: 255
                        minLength: 1
                        type:
                        - string
                        - 'null'
                      registeredOn:
                        type: string
                        format: date-time
                      lastSeenOn:
                        type: string
                        format: date-time
                      registeredBy:
                        type:
                        - object
                        - 'null'
                        properties:
                          publicId:
                            maxLength: 12
                            minLength: 12
                            type: string
                          name:
                            maxLength: 255
                            minLength: 1
                            type: string
                      emailAddressChanges:
                        type: array
                        items:
                          type: object
                          properties:
                            publicId:
                              maxLength: 12
                              minLength: 12
                              type: string
                            oldEmailAddress:
                              maxLength: 254
                              minLength: 6
                              pattern: ^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                              type: string
                            newEmailAddress:
                              maxLength: 254
                              minLength: 6
                              pattern: ^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                              type: string
                            expiresOn:
                              type: string
                              format: date-time
                      invites:
                        type: array
                        items:
                          type: object
                          properties:
                            publicId:
                              maxLength: 12
                              minLength: 12
                              type: string
                            emailAddress:
                              maxLength: 254
                              minLength: 6
                              pattern: ^(?=.{1,254}$)(?=.{1,64}@)[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+(?:\.[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                              type: string
                            expiresOn:
                              type: string
                              format: date-time
                            memberships:
                              type: array
                              items:
                                type: object
                                properties:
                                  publicId:
                                    maxLength: 12
                                    minLength: 12
                                    type: string
                                  user:
                                    type:
                                    - object
                                    - 'null'
                                    properties:
                                      publicId:
                                        type: string
                                  invite:
                                    type:
                                    - object
                                    - 'null'
                                    properties:
                                      publicId:
                                        type: string
                                  group:
                                    type: object
                                    properties:
                                      publicId:
                                        type: string
                                  role:
                                    type:
                                    - object
                                    - 'null'
                                    properties:
                                      publicId:
                                        type: string
                                  expiresOn:
                                    type:
                                    - string
                                    - 'null'
                                    format: date-time
                      unreadMessagesCount:
                        maximum: 2147483647
                        minimum: -2147483648
                        type: integer
                        format: int32
                      otpAuth:
                        type: object
                        properties:
                          required:
                            type: boolean
                          deviceName:
                            maxLength: 255
                            minLength: 0
                            type:
                            - string
                            - 'null'
                          registeredOn:
                            type:
                            - string
                            - 'null'
                            format: date-time
                          tokenExpiresOn:
                            type:
                            - string
                            - 'null'
                            format: date-time
                          type:
                            enum:
                            - app
                            - sms
                            type:
                            - string
                            - 'null'
                      apiApplications:
                        type: array
                        items:
                          type: object
                          properties:
                            publicId:
                              maxLength: 12
                              minLength: 12
                              type: string
                            name:
                              maxLength: 255
                              minLength: 1
                              type: string
                            custom:
                              type: object
                      phoneNumber:
                        maxLength: 16
                        minLength: 3
                        pattern: \+[0-9]{2,15}
                        type:
                        - string
                        - 'null'
                      acceptedTermsOfUsePolicies:
                        type: array
                        items:
                          type: object
                          properties:
                            publicId:
                              maxLength: 12
                              minLength: 12
                              type: string
                            policy:
                              type: object
                              properties:
                                publicId:
                                  maxLength: 12
                                  minLength: 12
                                  type: string
                                company:
                                  type:
                                  - object
                                  - 'null'
                                  properties:
                                    publicId:
                                      type: string
                                latest:
                                  type:
                                  - boolean
                                  - 'null'
                                version:
                                  maxLength: 5
                                  minLength: 1
                                  type:
                                  - string
                                  - 'null'
                                publishedOn:
                                  type:
                                  - string
                                  - 'null'
                                  format: date-time
                                downloadUrl:
                                  maxLength: 255
                                  minLength: 0
                                  type:
                                  - string
                                  - 'null'
                                type:
                                  enum:
                                  - termsofuse
                                  - privacystatement
                                  type: string
                                languages:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      publicId:
                                        maxLength: 12
                                        minLength: 12
                                        type: string
                                      languageCode:
                                        maxLength: 2
                                        minLength: 2
                                        type: string
                                      body:
                                        maxLength: 65535
                                        minLength: 0
                                        type: string
                                      updateSummary:
                                        maxLength: 65535
                                        minLength: 0
                                        type:
                                        - string
                                        - 'null'
                                      policy:
                                        type: object
                                        properties:
                                          publicId:
                                            type: string
                            company:
                              type: object
                              properties:
                                publicId:
                                  type: string
                            acceptedOn:
                              type: string
                              format: date-time
        4XX:
          $ref: '#/components/responses/4XXErrorResponse'
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/apiApplication'
      - $ref: '#/components/parameters/apiBrandingOptional'
      - $ref: '#/components/parameters/fieldsParameter'
      - $ref: '#/components/parameters/filtersParameter'
      security:
      - bearerToken: []
      operationId: getUsersMe
      x-operation-id-source: derived
    patch:
      tags:
      - My User
      summary: MyUser
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - type
                - data
                properties:
                  status:
                    type: string
                    default: success
                  type:
                    type: string
                  data:
                    type:
                    - object
                    - 'null'
        4XX:
          $ref: '#/components/responses/4XXErrorResponse'
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/apiApplication'
      - $ref: '#/components/parameters/apiBrandingOptional'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  maxLength: 255
                  minLength: 1
                  type: string
                language:
                  maxLength: 2
                  minLength: 2
                  type: string
                localisation:
                  maxLength: 10
                  minLength: 1
                  type:
                  - string
                  - 'null'
                timeZone:
                  maxLength: 255
                  minLength: 1
                  type:
                  - string
                  - 'null'
                custom:
                  type: object
                phoneNumber:
                  maxLength: 16
                  minLength: 3
                  pattern: \+[0-9]{2,15}
                  type:
                  - string
                  - 'null'
      security:
      - bearerToken: []
      operationId: patchUsersMe
      x-operation-id-source: derived
    delete:
      tags:
      - My User
      summary: MyUser
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - type
                - data
                properties:
                  status:
                    type: string
                    default: success
                  type:
                    type: string
                  data:
                    type:
                    - object
                    - 'null'
        4XX:
          $ref: '#/components/responses/4XXErrorResponse'
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/apiApplication'
      - $ref: '#/components/parameters/apiBrandingOptional'
      security:
      - bearerToken: []
      operationId: deleteUsersMe
      x-operation-id-source: derived
components:
  parameters:
    filtersParameter:
      required: false
      description: 'Filter the returned item(s). Format: operator(column,val)


        Possible operators are: lt, less, lte, lessorequal, eq, equals, ne, differs, gt, greater, gte, greaterorequal, in, ni, isnull, isnotnull, between, contains.


        Example: eq(publicId,"publicId_val")'
      name: filters
      in: query
      schema:
        type: array
        items:
          type: string
    apiVersion:
      required: true
      description: Version of the API to use
      name: Api-Version
      in: header
      schema:
        type: integer
        format: int32
        enum:
        - 2
    fieldsParameter:
      required: false
      description: 'Fields to select. Use "*" for all the top-level fields. Or check the "Success response" below for other fields.


        To get the fields of a subresource do subresource.field or for multiple fields of one subresource do subresource(field,field)'
      name: fields
      in: query
      schema:
        type: array
        items:
          type: string
    apiApplication:
      required: true
      description: Get your Application ID via support@ixon.cloud
      name: Api-Application
      in: header
      schema:
        type: string
        pattern: ^[0-9a-zA-Z]{12}$
    apiBrandingOptional:
      required: false
      description: Domain that provides the branding
      name: Api-Branding
      in: header
      schema:
        type: string
        pattern: .+(\..[^.]+)
  responses:
    4XXErrorResponse:
      description: 4XX error response
      content:
        application/json:
          schema:
            type: object
            required:
            - status
            - type
            - data
            properties:
              status:
                type: string
                default: error
              type:
                type: string
                default: Error
              data:
                type: array
                items:
                  $ref: '#/components/schemas/4XXErrorSchema'
  schemas:
    4XXErrorSchema:
      type: object
      properties:
        message:
          type: string
        propertyName:
          type:
          - string
          - 'null'
        listIndex:
          type:
          - integer
          - 'null'
          format: int32
      required:
      - message
  securitySchemes:
    bearerToken:
      type: http
      description: Bearer token created by the endpoint "POST AccessTokenList"
      scheme: bearer
x-samples-languages:
- curl
- ruby
- javascript
- python
- powershell