Credentials

Manage customer credentials.

Sending a request to update a customer email address

post

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.

Authorizations

CustomerAccessToken

AuthorizationstringRequired

To generate a customer access token, go to the Logging in a customer endpoint.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

application/json

emailstringOptional

Customer email address currently used for logging in.

passwordstringOptional

Customer account password.

newEmailstringOptional

Customer new email address.

syncContactEmailbooleanOptional

Flag indicating whether the contactEmail should be changed to the new email address.

Default: false

Responses

204

No Content

No content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

post/customer/{tenant}/me/accounts/internal/email/change

HTTPcURLJavaScriptPython

POST /customer/{tenant}/me/accounts/internal/email/change HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "email": "[e-mail]",
  "password": "password123",
  "newEmail": "[e-mail]",
  "syncContactEmail": true
}

No content

Updating a customer email address

post

Updates a customer email address using the token received through email.

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

Authorizations

AnonymousAccessToken

AuthorizationstringRequired

To generate an anonymous token, check out the Requesting an anonymous token endpoint.

Path parameters

tenantstringRequired

The tenant string is the project's Identifier from the Builder.

Body

application/json

tokenstringOptional

Token received by the customer through email.

Responses

204

No Content

No content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

post/customer/{tenant}/me/accounts/internal/email/change/confirm

HTTPcURLJavaScriptPython

POST /customer/{tenant}/me/accounts/internal/email/change/confirm HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "token": "beExUmshJC5gnuXk1kET5dCLyQWkrAfKRGFOxVXLcJI13R1fn5USjaWku5G71whM"
}

No content

Sending a request to reset a customer password

post

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.

Authorizations

AnonymousAccessToken

AuthorizationstringRequired

To generate an anonymous token, check out the Requesting an anonymous token endpoint.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

application/json

emailstringRequired

Customer email address.

sitestringOptional

Site from which password reset request was sent

Responses

204

No Content

No content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

post/customer/{tenant}/password/reset

HTTPcURLJavaScriptPython

POST /customer/{tenant}/password/reset HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "email": "[e-mail]"
}

No content

Resetting a customer password

post

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.

Authorizations

AnonymousAccessToken

AuthorizationstringRequired

To generate an anonymous token, check out the Requesting an anonymous token endpoint.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

application/json

tokenstringRequired

Token received by the customer through email.

passwordstringRequired

Customer new account password.

Responses

204

No Content

No content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

post/customer/{tenant}/password/reset/update

HTTPcURLJavaScriptPython

POST /customer/{tenant}/password/reset/update HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "token": "beExUmshJC5gnuXk1kET5dCLyQWkrAfKRGFOxVXLcJI13R1fn5USjaWku5G71whM",
  "password": "P@ssw0rd123"
}

No content

Changing a customer password

post

Changes a Customer account password.

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

Authorizations

CustomerAccessToken

AuthorizationstringRequired

To generate a customer access token, go to the Logging in a customer endpoint.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

application/json

currentPasswordstringRequired

Customer current account password.

newPasswordstringRequired

Customer new account password.

Responses

204

No Content

No content

400

Request was syntactically incorrect. Details will be provided in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match scopes required by the endpoint.

application/json

post/customer/{tenant}/password/change

HTTPcURLJavaScriptPython

POST /customer/{tenant}/password/change HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "currentPassword": "password123",
  "newPassword": "P@ssw0rd123"
}

No content