Authenticate/Login to Server
Submits an authentication request (using credentials) to the Connect server and if successful provides access to the various other REST API services available.
Request takes no content, but requires an additional Authorization header which contains a base64 encoded set of credentials (username and password). On success, the response will return an authorization token which can then be used as an additional auth_token header in any future requests made to the REST API services.
If server security settings are enabled and a request is made to any resource of any service in the REST API, if that request contains neither an auth_token header or an Authorization header, then the response will come back as Unauthorized and will contain an additional WWW-Authenticate response header.
Request
| Method Type: |
POST |
|---|---|
| URI: | |
| Content: | – |
| Content Type: |
– |
| Add. Headers: |
Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded) |
Response
Success
The following lists status codes indicative of a successful response:
| Status Code | Content | Content-Type | Add. Headers | Description |
|---|---|---|---|---|
| 200 OK |
Authorization Token | text/plain | – | Server authentication successful, new authorization token generated. |
Error
The following lists status codes indicative of a failed or error response:
| Status Code | Content | Content-Type | Add. Headers | Description |
|---|---|---|---|---|
|
401 Unauthorized |
– |
– |
WWW-Authenticate – BASIC (Basic Authentication credentials are accepted) |
Server authentication has failed.
|
|
401 Unauthorized |
– |
– |
– |
Server authentication has failed.
|