Authenticate/Login to Server

Submits an authentication request (using credentials) to the PlanetPress 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 (basic user name & password). On success, the response with 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 no authorization token and no Authorization header, then the response will come back as Unauthorized and will contain an additional WWW-Authenticate response header.

Type: POST
URI: /rest/serverengine/authentication/login
Parameters: –
Request:
Add. Headers: Authorization – Basic User name & Password credentials (Base64 encoded)
Content: –
Content Type: –
Response:
Add. Headers: WWW-Authenticate – BASIC (Prompt for Basic Authorization Credentials when no Authorization header specified)
Content: Authorization Token
Content Type: text/plain
Status:
  • 200 OK – Server authentication successful, new token generated
  • 401 Unauthorized – Server authentication has failed or no credentials have been provided/specified in request header