| Back | Main view

Product:	IMiS/StorageConnector Services REST
Release:	9.5.1910
Date:	03/05/2020

Case:

IMiS/Storage Connector Services REST - Session

Description:

Session enables access to operations in which a session token is sent in the header of the request. The session is created and opened, and the user is authenticated. It remains valid until the user closes it or it expires after a certain period of inactivity, which can be set in the archive configuration.
Request and response are in JSON format.
Operation with sessions is described below.

Session open

Operation creates session and retrieves unique identifier. When the session is open, user authenticates and connects to the archive server.

Request
POST archives/{archiveId}/session/open.json

Body:
{
  "authentication" : {
    "username" : "rsalazar",
    "password" : "31p23p9",
    "ldap_password" : "431p23p9122",
    "kerberos5_service_ticket" : "MTIzYWZkYTM0M3I0YXIyMzVlZmE="
  },
  "api_version" : 6,
  "computer_name" : "RSZ-PC",
  "application_name" : "IMiS/wClient",
  "impersonate" : "kclay"
}

authentication.username	String	The name of the user.
authentication.password	String	The user password (optional).
authentication.ldap_password	String	LDAP password (optional).
authentication.kerberos5_service_ticket	String - Base64	Kerberos5 service ticket (optional).
api_version	Integer	API version (optional).
computer_name	String	The name of the computer (optional).
application_name	String	The name of the application (optional).
impersonate	String	The username of the user being impersonated (optional).

Response

Body:
{
  "api_version" : 6,
  "service_name" : "IMiS/ARChive Storage Server",
  "service_version" : 700,
  "token" : "nFFeEj11TXGrOeV3oU9XpUAv3pG9rvNeV7abpm346auo0vZmDffgknXcOHFy74Kj"
}

api_version	Integer	API version.
service_name	String	The name of the archive service.
service_version	Integer	The version of the archive service.
token	String	Unique identifier of the session (token).

Response status:
- 200: Session opened successfully.
- 400: Bad request.
- 401: Unsuccessful authorization.
- 404: Archive does not exist.
- 500: Server error.


Session close

Operation closes the session.

POST archives/{archiveId}/session/close.json

Body:
{
  "token" : "nFFeEj11TXGrOeV3oU9XpUAv3pG9rvNeV7abpm346auo0vZmDffgknXcOHFy74Kj"
}

token

String

Unique identifier of the session (token).

Response

Response status:
- 200: Session closed successfully.
- 400: Bad request.
- 404: Session does not exist.


Related Documents:



| Back | Main view