/api/auth

  • Mount Point: /resource/rest/api/auth

The following operations are supported on this resource:

POST

Rest web service authentication method.

Input Payload

element consumeable content type(s)
(custom)
  • */*
  • application/xml
  • application/json
description
incoming object with login/password information

Output Payload

element produceable content type(s)
(custom)
  • application/json
description
access token if authentication has been verified

Exceptions

name description
InvalidAuthException when token value is not valid
AuthTokenException when AuthToken is not valid
DTOMappingException when DTO mapping fails
BadRequestException when credentials are not fully set

GET

Rest web service get authentication token by token value method.

Parameters

name description type default
X-VMS-API-AuthToken authentication token value header

Output Payload

element produceable content type(s)
(custom)
  • application/json
description
token

Exceptions

name description
JsonMarshallingException when JSON marshaling fails
InvalidAuthException when token value is not valid
AuthTokenException when AuthToken is not valid
DTOMappingException when DTO mapping fails

DELETE

Rest web service authentication token deletion method.

Parameters

name description type default
X-VMS-API-AuthToken authentication token value header

Output Payload

element produceable content type(s)
(custom)
  • application/json
description
deleted token

Exceptions

name description
JsonMarshallingException when JSON marshaling fails
InvalidAuthException when token value is not valid
AuthTokenException when AuthToken is not valid
DTOMappingException when DTO mapping fails