Verify Login Credentials

Verifies whether the provided login credentials are valid and if valid, returns the details of current logged in user.

❗️

Make sure that you have appropriate access control configured. For more information, see access group documentation.

API endpoint

https://{host}/v1/1store/login.json

Response parameters

ParameterDescription
responseContains the main structure of the response.
response.statusContains the status details of the response.
response.status.successIndicates if the response was a success. Returns "true" or "false" as a string.
response.status.codeThe HTTP response code. Typically, "200" indicates success.
response.status.messageMessage describing the status.
response.storeContains information about the store.
response.store.userContains details of the user associated with the store.
response.store.user.usernameThe username of the user associated with the store.
response.store.user.first_nameThe first name of the user.
response.store.user.last_nameThe last name of the user.
response.store.user.org_nameThe organization name associated with the user.
response.store.user.user_idThe unique identifier of the user.
response.store.user.typeType of the user, e.g., "STR_SERVER".
response.store.user.org_idThe unique identifier of the organization.
response.store.user.server_timeThe server timestamp at the time of the response.
response.store.user.associate_login_enabledIndicates if the associate login is enabled. Returns "true" or "false" as a string.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!