Pre Login Authentication
Business application can use this API to get the authentication method for the user, based on the configurations set in enterprise role
|
https://api.signinghub.com/authenticate/pre |
||
|
HTTP Verb |
POST |
|
|
Authorization |
Bearer {access_token} |
|
|
Accept |
application/json |
|
|
Request Body |
{ "username": "john_doe@gmail.com", }
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
{ "profile_name": "SigningHub ID", "method": "PASSWORD", "app_id": "", "tenant_id": null} |
| 403 | Forbidden |
{ "Message": "Account is disabled"} |
{ "error": "inactive_account", "error_description": "You must activate your account to access SigningHub."} |
||
|
500 |
Internal Server Error |
{ "Message": "An internal server error occurred while processing the request"} |
| Item Details | |
| Names |
Description |
| Request Parameters |
|
| access_token | OAuth access token obtained as a result of successful authentication via "client_credentials" grant type. |
| username | Email address of the user for which authentication method is te be retrieved. |
| Response Parameters | |
| profile_name | Name of the authentication profile |
| method | Method of the authentication profile |
| app_id | Application Id of the configured profile |
| tenant_id | Returns Tenant ID if MS Azure Active Directory or MS Office 365 authentication is configured as login authentication in user's role. It returns null if the configured authentication profile is other than these two authentication profiles. |