Sessions

Used to interact with the sessions of a client.

Get Session

Returns the session with the given id

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
session_id
required
string

the user session id.

Responses
200

Returns a Session object.

404

Request was not successful

get/v1/client/sessions/{session_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Touch session

Specify the active session for the client.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
session_id
required
string

the user session id.

Responses
200

Returns a Session object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/client/sessions/{session_id}/touch
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

End Session

Marks the given session as ended.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
session_id
required
string

the user session id.

Responses
200

Returns a Session object.

400

Request was not successful

404

Request was not successful

post/v1/client/sessions/{session_id}/end
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Remove Session

Delete the the given session.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
session_id
required
string

the user session id.

Responses
200

Returns a Session object.

400

Request was not successful

404

Request was not successful

post/v1/client/sessions/{session_id}/remove
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Create Session Token

Create a session jwt for the authenticated requested user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
session_id
required
string

the user session id.

Responses
200

OK

401

Request was not successful

404

Request was not successful

post/v1/client/sessions/{session_id}/tokens
Response samples
application/json
{
  • "jwt": "string"
}

Create Session Token With JWT Template

Create a session jwt for the authenticated requested user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
session_id
required
string

the user session id.

template_name
required
string

the template name

Responses
200

OK

post/v1/client/sessions/{session_id}/tokens/{template_name}
Response samples
application/json
{
  • "jwt": "string"
}