/api/auth
- Mount Point: /resource/rest/api/auth
The following operations are supported on this resource:
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) |
|
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 |
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) |
|
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 |
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) |
|
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 |