Login Sessions

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/login-sessions

Summary

Resources	Methods
https://localhost:8443/api/rest/login-sessions	GET Retrieves a list of all the currently active login sessions.
https://localhost:8443/api/rest/login-sessions/{login-session-identifier}	GET Retrieves information about a user login session. DELETE Terminates a login session on DMA.

Resources

https://localhost:8443/api/rest/login-sessions

Methods

GET

Retrieves a list of all the currently active login sessions.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-login-session-list+xml application/vnd.plcm.plcm-login-session-list+json	Login Session list retrieved successfully.
304		Login Sessions has not changed since the last search. Note: The API client must provide the "plcm-login-session-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-login-session-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator \| provisioner.

https://localhost:8443/api/rest/login-sessions/{login-session-identifier}

Template Parameters

Name	Type	Description
login-session-identifier	xs:string	Unique identifier of the login session resource.

Methods

GET

Retrieves information about a user login session.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-login-session+xml application/vnd.plcm.plcm-login-session+json	Login Session information successfully retrieved.
304		Prefix Service information has not changed since the last retrieval. Note: The API client must provide the "plcm-login-session" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical login session retrieval in the "If-None-Match" header, then the HTTP response will contain the login session representation in the message body. The "plcm-login-session" ETag can be accessed from the initial retrieval result's HTTP response header.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Login Session information was not found.

DELETE

Terminates a login session on DMA.
[tags: DMA]

Request

Response

Status	Representation	Description
204		Login Session was successfully terminated
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Login Session was not found.