CommunitySupport PortalYouTubeStart a free trial

Credentials

Manage customer credentials.

Sending a request to update a customer's email address

post

Sends a request to change a customer's email address. As a result, the customer receives a unique token through email.

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

Required scopes

No specific scopes are required.

Request for changing login email token using current email id and password.

Requires scope customer.customerprofile_edit

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

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

Customer's email address currently used for logging in.

passwordstringOptional

Customer's account password.

newEmailstringOptional

Customer's new email address.

syncContactEmailbooleanOptional

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

Default: false
Responses
204
No Content
post
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": "[email protected]",
  "password": "password123",
  "newEmail": "[email protected]",
  "syncContactEmail": true
}
No content

Updating a customer's email address

post

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

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

Required scopes

No specific scopes are required.

Authorizations
Path parameters
tenantstringRequired

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

Body
tokenstringOptional

Token received by the customer through email.

Responses
204
No Content
post
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's password

post

Sends a request to reset a Customer's 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.

Required scopes

No specific scopes are required.

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

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

Customer's email address.

sitestringOptional

Site from which password reset request was sent

Responses
204
No Content
post
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": "[email protected]"
}
No content

Resetting a customer's password

post

Resets a customer's password using the token received through email and sets a new password.

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

Required scopes

No specific scopes are required.

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

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

Token received by the customer through email.

passwordstringRequired

Customer's new account password.

Responses
204
No Content
post
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's password

post

Changes a Customer's account password.

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

Required scopes

No specific scopes are required.

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

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

Customer's current account password.

newPasswordstringRequired

Customer's new account password.

Responses
204
No Content
post
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
PreviousAuthentication and authorizationNextDouble opt In

Was this helpful?