Proxied Authentication Request Interface

This interface is used to query local account ID corresponding to given credentials.

Endpoint URL: SP_API_BASE_URL/users

Note: The SP_API_BASE_URL prefix is specified by an SP on the first step of registration the SP in IdP. For details, see the Registering SP in IdP section.

The following schema is used to query local account ID corresponding to given credentials:

1. IdP sends HTTPS POST request to URL SP_API_BASE_URL/users.

   POST parameters are user_name and password. Credentials are sent in plain text.
   

2. If SP considers the supplied credentials to be valid, it returns a web resource containing the account_id parameter.

   For details on the output format, refer to the Appendix.

   The parameter value is a local account login name or other identifier depending on the url_mapping parameter (that was specified on registration of SP in IdP).

   If credentials are not valid, the SP returns empty web resource.