Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Performing operations related to sessions that use HSSO tokens

You can obtain a list of operations for HSSO token sessions or extend the valid period of a session.

Getting a list of operations for sessions of the HSSO token

You can obtain a list of operations that can be performed on sessions that use HSSO tokens.

Execution permission

Admin, StorageOps, Modify, User Management

Request line
GET baseURL/v1/services/KeepAlive/actions
Request body

Not applicable.

Response bodyThe structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

anyType[]

A list of Action objects. For details about Action, see the table below.

pagination

Pagination

Page information. This parameter is displayed only when the relevant resource exists.

count

int

Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute

Type

Description

page

integer

Page.

pageSize

integer

Size of page.

numPages

integer

Number of pages.

totalCount

integer

Number of objects.

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the action.

href

string

URL for the action.

method

string

Name of the method.

type

string

Data format for the object.

parameters

anyType[]

A list of objects necessary to execute an operation. No value is set.
Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code
[Request Header]
GET /Analytics/v1/services/KeepAlive/actions
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 22 Aug 2016 05:24:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 50a6ea7230762530879b2914c3ac12144074638c_Y2UOI2pkMXQ=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
    "data": [
        {
            "name": "submit",
            "href": "http://localhost:22015/Analytics/v1/services/KeepAlive/actions/submit/invoke",
            "method": "POST",
            "type": "application/json",
            "parameters": [
                
            ]
        }
    ],
    "count": 1
}

Preparing to extend the valid period of a session of the HSSO token

The following operation is the initial step to extend the valid time period of a session that uses HSSO tokens.

Execution permission

Admin, StorageOps, Modify, User Management

Request line
GET baseURL/v1/services/KeepAlive/actions/submit
Request body

Not applicable.

Response bodyThe structure of the response body and the object attributes is as follows:

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the action.

href

string

URL for the action.

method

string

Name of the method.

type

string

Data format for the object.

parameters

anyType[]

A list of objects necessary to execute an operation. No value is set.
Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code
[Request Header]
GET /Analytics/v1/services/KeepAlive/actions/submit
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:51:25 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "name" : "submit",
  "href" : "http://localhost:22015/Analytics/v1/services/KeepAlive/actions/submit/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ ]
}

Extending the valid period of a session of the HSSO token

You can extend the valid time period of a session that uses HSSO tokens.

Execution permission

Admin, StorageOps, Modify, User Management

Request line
POST baseURL/v1/services/KeepAlive/actions/submit/invoke
Request bodyThe structure of the request body and the object attributes are as follows:

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the action.

href

string

URL for the action.

method

string

Name of the method.

type

string

Data format for the object.

parameters

anyType[]

A list of objects necessary to execute an operation. No value is set.
Response bodyThe structure of the response body and the object attributes is as follows:

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

ID of the Instance.

created

string

Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

updated

string

Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

completed

string

Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00).

state

string

One of the following values is set:

"failed": The operation failed.

"success": The operation completed successfully.

affectedResource

string[]

A blank space is set.

result

anyType[]

A list of KeepAlive objects. For details about KeepAlive, see the table below.

KeepAlive

{
        "timeToLive":"..."
}

KeepAlive (Type: KeepAlive)

Attribute

Type

Description

timeToLive

long

Period during which the session is available by the HSSO token (sec.)

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

The format of the request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No execute privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code
[Request Header]
POST /Analytics/v1/services/KeepAlive/actions/submit/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "name" : "submit",
  "href" : "http://localhost:22015/Analytics/v1/services/KeepAlive/actions/submit/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ ]
}


[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:51:26 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "instanceID" : "43f90f1e-c0c3-41d1-a5dd-4666b2ba7c90",
  "created" : "2016-08-12T02:51:26.371+09:00",
  "updated" : "2016-08-12T02:51:26.400+09:00",
  "completed" : "2016-08-12T02:51:26.400+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "timeToLive" : 1000
  } ]
}