CM.com Authentication API

openapi: 3.2.0
info:
  title: Cm Com Authentication API
  contact: {}
  license:
    name: Proprietary
    url: https://www.cm.com
  version: '1.0'
  description: 'Operations tagged Authentication across 2 of this provider''s published API definitions: cm-com-live-entrance-management-v1-openapi.yml, cm-com-live-entrance-management-v2-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.cm.com
security:
- cookie: []
tags:
- name: Authentication
  description: User authentication and session management
paths:
  /entrance/v1.0/login:
    post:
      operationId: AuthController_login_v1.0
      parameters:
      - name: X-ENMA-APP-NAME
        required: true
        in: header
        schema:
          type: string
      - name: X-ENMA-DEVICE-ID
        required: true
        in: header
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginDto'
      responses:
        '200':
          description: Login to user account, provide optional organisationUuid or entrancePlanUuid to login directly to this entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDto'
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      summary: Login to user account
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v1.0/login/verify-username:
    post:
      operationId: AuthController_verifyUsername_v1.0
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUsernameDto'
      responses:
        '200':
          description: ''
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      summary: Verify username for login
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v1.0/switch-organisation-or-plan:
    post:
      operationId: AuthController_switchOrganisationOrEntrancePlan_v1.0
      parameters:
      - name: X-ENMA-APP-NAME
        required: true
        in: header
        schema:
          type: string
      - name: X-ENMA-DEVICE-ID
        required: true
        in: header
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginOrganisationEntrancePlanDto'
      responses:
        '200':
          description: Sign in to organisation or entrance plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDto'
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
      - cookie: []
      summary: Switch organisation or entrance plan
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v1.0/refresh:
    post:
      operationId: AuthController_refreshTokens_v1.0
      parameters:
      - name: X-ENMA-APP-NAME
        required: true
        in: header
        schema:
          type: string
      - name: X-ENMA-DEVICE-ID
        required: true
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Update refresh token, to prolong session after auth cookie expires. Token is valid for a week.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDto'
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
      - cookie: []
      summary: Refresh authentication tokens
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v1.0/logout:
    post:
      operationId: AuthController_logout_v1.0
      parameters:
      - name: X-ENMA-APP-NAME
        required: true
        in: header
        schema:
          type: string
      - name: X-ENMA-DEVICE-ID
        required: true
        in: header
        schema:
          type: string
      responses:
        '204':
          description: Logs out the current user
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
      - cookie: []
      summary: Logout current user
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v2.0/login:
    post:
      operationId: AuthController_login_v2.0
      parameters:
      - name: X-ENMA-APP-NAME
        required: true
        in: header
        schema:
          type: string
      - name: X-ENMA-DEVICE-ID
        required: true
        in: header
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginDto'
      responses:
        '200':
          description: Login to user account, provide optional organisationUuid or entrancePlanUuid to login directly to this entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDto'
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      summary: Login to user account
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v2.0/login/verify-username:
    post:
      operationId: AuthController_verifyUsername_v2.0
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUsernameDto'
      responses:
        '200':
          description: ''
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      summary: Verify username for login
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v2.0/switch-organisation-or-plan:
    post:
      operationId: AuthController_switchOrganisationOrEntrancePlan_v2.0
      parameters:
      - name: X-ENMA-APP-NAME
        required: true
        in: header
        schema:
          type: string
      - name: X-ENMA-DEVICE-ID
        required: true
        in: header
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginOrganisationEntrancePlanDto'
      responses:
        '200':
          description: Sign in to organisation or entrance plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDto'
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
      - cookie: []
      summary: Switch organisation or entrance plan
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v2.0/refresh:
    post:
      operationId: AuthController_refreshTokens_v2.0
      parameters:
      - name: X-ENMA-APP-NAME
        required: true
        in: header
        schema:
          type: string
      - name: X-ENMA-DEVICE-ID
        required: true
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Update refresh token, to prolong session after auth cookie expires. Token is valid for a week.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDto'
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
      - cookie: []
      summary: Refresh authentication tokens
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
  /entrance/v2.0/logout:
    post:
      operationId: AuthController_logout_v2.0
      parameters:
      - name: X-ENMA-APP-NAME
        required: true
        in: header
        schema:
          type: string
      - name: X-ENMA-DEVICE-ID
        required: true
        in: header
        schema:
          type: string
      responses:
        '204':
          description: Logs out the current user
        4XX:
          description: The request could not be processed. The body contains a standardized error object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
      - cookie: []
      summary: Logout current user
      tags:
      - Authentication
    servers:
    - url: https://api.cm.com
components:
  schemas:
    UserUsernameDto:
      type: object
      properties:
        username:
          type: string
          description: Username or e-mail address used to sign in
      required:
      - username
    ErrorDto:
      type: object
      properties:
        errorCode:
          type: number
          example: 400100
          description: Error code specific to the error, consisting of a three digit http status code and a digit application specific code.
        description:
          type: string
          maxLength: 255
          example: Description of the error.
        httpStatus:
          type: number
          enum:
          - 100
          - 101
          - 102
          - 103
          - 200
          - 201
          - 202
          - 203
          - 204
          - 205
          - 206
          - 207
          - 208
          - 210
          - 300
          - 301
          - 302
          - 303
          - 304
          - 307
          - 308
          - 400
          - 401
          - 402
          - 403
          - 404
          - 405
          - 406
          - 407
          - 408
          - 409
          - 410
          - 411
          - 412
          - 413
          - 414
          - 415
          - 416
          - 417
          - 418
          - 421
          - 422
          - 423
          - 424
          - 428
          - 429
          - 456
          - 500
          - 501
          - 502
          - 503
          - 504
          - 505
          - 507
          - 508
          example: 400
      required:
      - errorCode
      - description
      - httpStatus
    LoginOrganisationEntrancePlanDto:
      type: object
      properties:
        organisationUuid:
          type: string
          description: Providing organisationUuid instantly logs user into that organisation and skips step 2
          example: 00000000-0000-0000-0000-000000000000
        entrancePlanUuid:
          type: string
          description: Providing entrancePlanUuid instantly logs user into that entrancePlan and skips step 2
          example: 00000000-0000-0000-0000-000000000000
    LoginDto:
      type: object
      properties:
        username:
          type: string
          description: Can be a username, an e-mail, or both, depending on how the user was created
          example: john.doe@example.com
        password:
          type: string
          minLength: 12
          description: Password have a minimum length of 12 characters and should contain at least one lowercase, one uppercase, one symbol and one number.
          example: MyStrong3x4mpl3P4ssword!
        organisationUuid:
          type: string
          description: Providing organisationUuid instantly logs user into that organisation and skips step 2
          example: 00000000-0000-0000-0000-000000000000
        entrancePlanUuid:
          type: string
          description: Providing entrancePlanUuid instantly logs user into that entrancePlan and skips step 2
          example: 00000000-0000-0000-0000-000000000000
      required:
      - username
      - password
    UserDto:
      type: object
      properties:
        uuid:
          type: string
          readOnly: true
        cmPersonGuid:
          type: string
          readOnly: true
        firstName:
          type: string
          readOnly: true
        lastName:
          type: string
          readOnly: true
        username:
          type: string
          readOnly: true
        email:
          type: string
          readOnly: true
        entrancePlanClaims:
          type: array
          items:
            type: string
            enum:
            - OBSERVER
            - EDITOR
            - OWNER
            - ADMIN
            - SCAN_USER
            - SCAN_CHECKIN
            - SCAN_CHECKOUT
            - SCAN_CLICKER_CHECKIN
            - SCAN_CLICKER_CHECKOUT
            - SCAN_SEARCH
            - SCAN_VALIDATE
            - SCAN_ANALYTICS
      required:
      - uuid
      - cmPersonGuid
      - firstName
      - lastName
      - username
      - email
      - entrancePlanClaims
  securitySchemes:
    cookie:
      type: apiKey
      in: cookie
      name: connect.sid
x-refined-from:
- cm-com-live-entrance-management-v1-openapi.yml
- cm-com-live-entrance-management-v2-openapi.yml