Emporix Credentials API

openapi: 3.2.0
info:
  title: Emporix Credentials API
  version: ''
  contact:
    name: Emporix
    url: https://emporix.com
    email: documentation@emporix.com
  description: 'Operations tagged Credentials across 2 of this provider''s published API definitions: emporix-customer-management-openapi.yml, emporix-customer-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.emporix.io
tags:
- name: Credentials
  description: Manage customer credentials.
paths:
  /customer/{tenant}/me/accounts/internal/email/change:
    parameters:
    - $ref: '#/components/parameters/tenant'
    post:
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/400_bad_request'
        '401':
          $ref: '#/components/responses/401_unauthorized'
        '403':
          $ref: '#/components/responses/403_forbidden'
      description: 'Sends a request to change a customer email address. As a result, the customer receives a unique token through email.


        **Note**: The request needs to be authorized with a customer access token.


        Request for changing login email token using current email id and password requires the `customer.customerprofile_edit` scope assigned with the customer access token.'
      operationId: POST-customer-change-customer-login-email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeEmailRequestDto'
            examples:
              Request example:
                value:
                  email: example@customer.com
                  password: password123
                  newEmail: example@emporix.com
                  syncContactEmail: true
        required: false
      security:
      - CustomerAccessToken: []
      summary: Sending a request to update a customer email address
      tags:
      - Credentials
    servers:
    - url: https://api.emporix.io
  /customer/{tenant}/me/accounts/internal/email/change/confirm:
    parameters:
    - name: tenant
      in: path
      required: true
      schema:
        type: string
      description: The tenant string is the project's Identifier from the Builder.
    post:
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/400_bad_request'
        '401':
          $ref: '#/components/responses/401_unauthorized'
        '403':
          $ref: '#/components/responses/403_forbidden'
      description: 'Updates a customer email address using the token received through email.


        **Note**: The request needs to be authorized with a anonymous access token.'
      operationId: POST-customer-confirm-customer-login-email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmail'
            examples:
              Request example:
                value:
                  token: beExUmshJC5gnuXk1kET5dCLyQWkrAfKRGFOxVXLcJI13R1fn5USjaWku5G71whM
        required: false
      security:
      - AnonymousAccessToken: []
      tags:
      - Credentials
      summary: Updating a customer email address
    servers:
    - url: https://api.emporix.io
  /customer/{tenant}/password/reset:
    parameters:
    - $ref: '#/components/parameters/tenant'
    post:
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/400_bad_request'
        '401':
          $ref: '#/components/responses/401_unauthorized'
        '403':
          $ref: '#/components/responses/403_forbidden'
      description: 'Sends a request to reset a Customer account password. As a result, the customer receives a unique token through email.


        **Note**: The request needs to be authorized with a anonymous access token.'
      operationId: POST-customer-request-reset-password
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordResetRequestDto'
            examples:
              Request example:
                value:
                  email: example@customer.com
        required: false
      security:
      - AnonymousAccessToken: []
      summary: Sending a request to reset a customer password
      tags:
      - Credentials
    servers:
    - url: https://api.emporix.io
  /customer/{tenant}/password/reset/update:
    parameters:
    - $ref: '#/components/parameters/tenant'
    post:
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/400_bad_request'
        '401':
          $ref: '#/components/responses/401_unauthorized'
        '403':
          $ref: '#/components/responses/403_forbidden'
      description: 'Resets a customer password using the token received through email and sets a new password.


        **Note**: The request needs to be authorized with a anonymous access token.'
      operationId: POST-customer-reset-password
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordUpdate'
            examples:
              Request example:
                value:
                  token: beExUmshJC5gnuXk1kET5dCLyQWkrAfKRGFOxVXLcJI13R1fn5USjaWku5G71whM
                  password: P@ssw0rd123
        required: false
      security:
      - AnonymousAccessToken: []
      tags:
      - Credentials
      summary: Resetting a customer password
    servers:
    - url: https://api.emporix.io
  /customer/{tenant}/password/change:
    parameters:
    - $ref: '#/components/parameters/tenant'
    post:
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/400_bad_request'
        '401':
          $ref: '#/components/responses/401_unauthorized'
        '403':
          $ref: '#/components/responses/403_forbidden'
      description: 'Changes a Customer account password.


        **Note**: The request needs to be authorized with a customer access token.'
      operationId: POST-customer-change-account-password
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordChangeDto'
            examples:
              Request example:
                value:
                  currentPassword: password123
                  newPassword: P@ssw0rd123
        required: false
      security:
      - CustomerAccessToken: []
      tags:
      - Credentials
      summary: Changing a customer password
    servers:
    - url: https://api.emporix.io
components:
  schemas:
    ErrorMessage:
      title: ''
      description: Schema for API-specific errors.
      type: object
      properties:
        status:
          minimum: 100
          maximum: 599
          description: Original HTTP error code. It should be consistent with the HTTP response code.
          type: integer
        type:
          pattern: '[a-z]+[a-z_]*[a-z]+'
          description: 'Classification of the error type.

            **Note:** The error type should be written in lowercase and include underscores, for example `validation_failure`.'
          type: string
        message:
          description: Descriptive error message for debugging purposes.
          type: string
        moreInfo:
          type: string
          description: More information (such as a link to the documentation) for investigating further and getting support.
        details:
          description: List of problems causing the error.
          type: array
          items:
            title: errorDetail
            description: Specific error cause.
            type: object
            properties:
              field:
                description: 'Element in request data which is causing the error, for example `category.name`.

                  If the violation was not field-specific, this field will be empty.'
                type: string
              type:
                pattern: '[a-z]+[a-z_]*[a-z]+'
                description: 'Classification of the specific error cause. This value should always be interpreted within the context of the general error type.

                  **Note:** The error type should be written in lowercase and include underscores, for example `missing_value`.'
                type: string
              message:
                description: Descriptive error message for debugging purposes.
                type: string
              moreInfo:
                type: string
                description: More information (such as a link to the documentation) for investigating further and getting support.
    PasswordUpdate:
      type: object
      properties:
        token:
          type: string
          description: Token received by the customer through email.
        password:
          type: string
          description: Customer new account password.
      required:
      - token
      - password
    ChangeEmailRequestDto:
      title: ChangeEmailRequestDto
      type: object
      properties:
        email:
          type: string
          description: Customer email address currently used for logging in.
        password:
          type: string
          description: Customer account password.
        newEmail:
          type: string
          description: Customer new email address.
        syncContactEmail:
          type: boolean
          default: false
          description: Flag indicating whether the `contactEmail` should be changed to the new email address.
    UpdateEmail:
      title: UpdateEmail
      type: object
      properties:
        token:
          type: string
          description: Token received by the customer through email.
    PasswordResetRequestDto:
      type: object
      properties:
        email:
          type: string
          description: Customer email address.
        site:
          type: string
          description: Site from which password reset request was sent
      required:
      - email
    PasswordChangeDto:
      type: object
      properties:
        currentPassword:
          type: string
          description: Customer current account password.
        newPassword:
          type: string
          description: Customer new account password.
      required:
      - currentPassword
      - newPassword
  responses:
    400_bad_request:
      description: Request was syntactically incorrect. Details will be provided in the response payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          examples:
            Invalid tenant:
              value:
                type: bad_request
                status: 400
                message: The tenant information provided with the request is not valid.
    401_unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              fault:
                type: object
                properties:
                  faultstring:
                    type: string
                  detail:
                    type: object
                    properties:
                      errorcode:
                        type: string
          examples:
            Invalid access token:
              value:
                fault:
                  faultstring: Invalid access token
                  detail:
                    errorcode: oauth.v2.InvalidAccessToken
            Access token expired:
              value:
                fault:
                  faultstring: Access Token expired
                  detail:
                    errorcode: keymanagement.service.access_token_expired
    403_forbidden:
      description: 'Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
          example:
            Missing required scopes:
              type: Forbidden
              status: 403
              message: User not authorized.
  parameters:
    tenant:
      name: tenant
      in: path
      required: true
      description: 'Your Emporix tenant name.


        **Note**: The tenant should always be written in lowercase.

        '
      schema:
        pattern: ^[a-z][a-z0-9]+$
        minLength: 3
        maxLength: 16
        type: string
  securitySchemes:
    CustomerAccessToken:
      type: http
      scheme: bearer
      description: To generate a customer access token, go to the [Logging in a customer](https://developer.emporix.io/api-documentation/api-guides/companies-and-customers/customer-management/api-reference/authentication-and-authorization#post-customer-tenant-login) endpoint.
    AnonymousAccessToken:
      type: http
      scheme: bearer
      description: To generate an anonymous token, check out the [Requesting an anonymous token](https://developer.emporix.io/api-documentation/api-guides/companies-and-customers/customer-management/api-reference/authentication-and-authorization#get-customerlogin-auth-anonymous-login) endpoint.
x-refined-from:
- emporix-customer-management-openapi.yml
- emporix-customer-management-openapi.yml