AuthService Resource

A set of services for authentication. After a successful login, an authorization token is either delivered in the response header or returned as a string depending on which login end point being used. The token must then be included on subsequent calls when using other end points. The token expires after 8 hours if it has not been used but the expiration time is reset after a successfull call to an end point that requires authorization.

POST /v1/auth/login

Used to login to acquire an authentication token.

Request Body
media type data type description
application/json UserLogin (JSON) An AuthData instance containing a username and password.
Response Codes
code condition
401 The username and password do not match any credentials.
Response Body
media type data type description
application/json StatusMessage (JSON) A UUID is returned in the "auth-token" header.
Response Headers
name description
auth-token A random UUID to used on subsequent calls

Example

Request
POST /v1/auth/login
Content-Type: application/json
Accept: application/json

                
{
  "username" : "user",
  "password" : "secret"
}
Response
HTTP/1.1 201 Created
Content-Type: application/json
auth-token: ...

                
{
  "code" : 12345,
  "message" : "..."
}

CURL request

curl --location --request POST \
--header 'Content-Type:application/json' \
--data '{ "username" : "user" , "password" : "secret" }' \
/m2m/v1/auth/login

POST /v1/auth/login

Used to login to acquire an authentication token.

Request Body
media type data type description
application/json UserLogin (JSON) An AuthData instance containing a username and password.
Response Codes
code condition
401 The username and password do not match any credentials.
Response Body
media type data type description
application/vnd.se.alkit.wice.authservice-v2+json string (JSON) A UUID to be used on subsequent calls.

Example

Request
POST /v1/auth/login
Content-Type: application/json
Accept: application/vnd.se.alkit.wice.authservice-v2+json

                
{
  "username" : "user",
  "password" : "secret"
}
Response
HTTP/1.1 201 Created
Content-Type: application/vnd.se.alkit.wice.authservice-v2+json

                
...

DELETE /v1/auth/logout

Used to logout. This effectively invalidates the authorization token previously acquired.

Request Parameters
name type description
auth-token header The authentication token previously acquired at a successful login.
Response Body
media type data type description
application/json StatusMessage (JSON)

Example

Request
DELETE /v1/auth/logout
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "code" : 12345,
  "message" : "..."
}

POST /v1/auth/logout

This method has been deprecated. Use DELETE AuthService instead.

Used to logout. This effectively invalidates the authorization token previously acquired.

Request Parameters
name type description
auth-token header
Response Body
media type data type description
application/json StatusMessage (JSON)

Example

Request
POST /v1/auth/logout
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "code" : 12345,
  "message" : "..."
}