Tenant User Login API

Request Body:

• userName string required

  userName refer to email id of the user attempting to login.

• password string required

  password refer to password associated with the username.

Response Payload:

• succeeded boolean

  Indicates whether the tenant user authentication and token retrieval were successful. It is a boolean value where true denotes success, and false indicates failure.

• status string

  Describes the status of the tenant user login attempt. It is a string providing additional information about the login status.

• data object | null

  Upon success, this property enables tenants to authenticate and obtain an access token for accessing protected resources within the customer portal. Additionally, it provides essential user details through the authContactBookInfo field. If the login attempt is not successful, the value is null.

• errors array

  Holds error information if applicable. It is an array containing error details in case there are issues with the tenant user login attempt.

object: data.authContactBookInfo

• id unique-identifier

  User ID.

• firstName string

  First name of the user.

• lastName string

  Last name of the user.

• email string

  User's email address.

• phoneNumber string

  User's phone number.

• address string

  User's street address.

• city string

  User's city of residence.

• region int

  State / County / Province ID (if applicable) for the tenant, by default 0 (if applicable).

• postalCode string

  User's postal code.

• country string

  User's country code.

string: token

• data.token string

  The token property in the response payload is a JSON Web Token (JWT) that serves as an authentication token, granting the authenticated tenant user access to protected resources within the StoRegister Management Application. This token should be included in the Authorization header of subsequent API requests.