/
[BSS] User accounts

[BSS] User accounts

Owned by Andy Beak (Unlicensed)
Last updated: Dec 23, 2019 by Tung Hoang (Unlicensed)

Introduction

This page summarizes the user management API.

Details of calls

Create user account

This API is used to add a new user account. Following rules apply:

  • Email address or customer-id should not belong to any customer that is not in DELETED state; otherwise API will return an error.
  • If the user with that email exists in DELETED state and his grace period is not expired, his previous registration state is restored.
  • A new user is created in UNREGISTERED state.

Flow diagram

title Create new user account

Customer->Move API: POST https://domain.tld/api/management/user
Move API->Customer: 200 OK

Technical details

Request

Method TypeURLAuthorization
POSThttps://domain.tld/api/management/userIP

Query Strings

Please note that M is for Mandatory and O for Optional.

ParameterM/ODescriptionValues
emailMEmail address of the user.Email address of the user
cidMCustomer Identifier.Numeric ID linking the user to Customer system
auth_pinO

Authentication PIN code.

Deprecated.

Number with the length of 4.
e.g. 8798 
purchase_pinO

Purchase PIN code.

Deprecated.

Number with the length of 4.
e.g. 8798 

Error Codes

Error CodeDescription
1403email is missing
1405cid is missing
1412Email already exists
1413CID already Exists

Delete user account

Technical details

Request

Method TypeURLAuthorization
DELETEhttps://domain.tld/api/management/userIP

Query Strings

Please note that M is for Mandatory and O for Optional.

ParameterM/ODescriptionValues
emailMThe user identifier

Edit Existing User Account

This API is used to suspend or activate a user account. It can also be used to change the email or customer-id of an existing account. Following rules apply:

  • A user in DELETED state is not updated.
  • "email" and "cid" parameters should not belong to any existing user, even if the user in in DELETED state
  • If a user is suspended, his state is changed to DISABLED
  • If a DISABLED user is activated and grace period has not expired, then previous registration state is restored, otherwise his state is changed to UNREGISTERED
  • In other cases, if a user is activated, his state changed to REGISTERED.

Request

Method TypeURLAuthorization
PUT
https://domain.tld/api/management/user/>
IP

Query strings

Please note that M is for Mandatory and O for Optional.

ParameterM/ODescriptionValues
emailONew email address of the user. Defaults to no value.Email address of the user
cidONew customer Identifier. Defaults to no value.Numeric ID generated from Visio
auth_pinO

Authentication PIN code.

Deprecated.

Number with the length of 4.
e.g. 8798 

purchase_pinO

Purchase PIN code.

Deprecated.

Number with the length of 4.
e.g. 8798 
actionOSUSPEND or ACTIVATE keywords. Defaults to no value.SUSPEND or ACTIVATE keywords are allowed only.

Error Codes

Error CodeDescription
1407action value is invalid
100User not found in the system
1404email is invalid
1406cid is invlid

Request user password reset

A user will receive an email, on the current email address, containing a link that user can use to set a new password.

The URL provided in the email can be used to set a new password of the user.

Request

Method TypeURLAuthorization
GET
https://boox.fi/api/user/<email>/password/reset
IP

Query strings


N/A