Session Model
- 07 Oct 2024
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
Session Model
- Mis à jour le 07 Oct 2024
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
The content is currently unavailable in French. You are viewing the default English version.
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
The OneSpan Identity Verification Session model defines data that is necessary for rendering and executing the current step in the e-agreement workflow. The session identifies the current signer, the language preference, session time-out information, presentation details, and other information.
Session properties
The session resource contains context information that is necessary for executing the interactive part of the e-agreement process by a user (participant). From the perspective of transaction metadata, session data is transient.
Session properties lists the session properties in OneSpan Identity Verification.
Path: .../properties/transaction/properties/session
Type: object
Property | Type | Description |
|---|---|---|
created | String | The date/time when the session was created in UTC.
|
currentStep | Integer | The step number for the progress indicator. Default value: 0 |
id | String | The session UUID.
|
last_request | String | The timestamp of the last request that was received in the context of this session.
|
role | String | The role associated with the session.
Default value: unknown |
totalSteps | Integer | The total number of steps for the progress indicator. Default value: 0 |
user_agent | String | User agent from the request header. |
verifications | Array | The list of verification workflows as defined for this tenant. Schema: ../common/common.schema.3.0.verification.json |
version | Integer | The version of the session record. Read-only property. Default value: 0 |
view_state | Object | This element carries information that defines the view that is displayed in the current workflow step. For the list of view_state properties, see view_state properties. |
Property | Type | Description |
|---|---|---|
error |
| Schema: transaction.schema.3.0.ux-component-config.json |
footer |
| Schema: transaction.schema.3.0.ux-component-config.json |
header |
| Schema: transaction.schema.3.0.ux-component-config.json |
page |
| Schema: transaction.schema.3.0.ux-component-config.json |
session_management | Object | This is a free JSON form that carries all configuration data required by the page (workflow element) of a given type. The configuration data is retrieved from the configuration service and passed as is to CWF UX. This accepts anything, provided it is valid JSON format. For the list of session_management properties, see session_management properties. |
wait |
| Schema: transaction.schema.3.0.ux-component-config.json |
Property | Type | Description |
|---|---|---|
active | Boolean | Timestamp. Flag that indicates the active session. |
end | Integer | Timestamp. The time-out for this session. |
warning | Integer | Timestamp. Warning when the session ends. |
Example session
{
"created": 1552498394341,
"id": "66e326gb-92ea-482b-8375-75f01e72d26a",
"verifications": [],
"last request": 1552498394362,
"role": "Role",
"currentStep": 0,
"totalSteps": 0,
"user_agent":"Mozilla/5.0",
"version": 1,
"view_state": {,
"header": {,
"type": "simple_header",
"config": {,
"logo": "logo.png",
"text": "OneSpan"
"text_url": "https://www.onespan.com",
},
"...": "..."
}
"footer" {
"type": "simple_footer"
"config": {
"links": [{
"text": "OneSpan"
"url": "https://www.onespan.com"
}
],
"copyright": "All rights reserved"
},
"...": "...":
},
"page": {
"type": "introduction:A",
"config": {
"...": "..."
},
"error": {
"type": "simple_error",
"...": "..."
},
"wait": {
"type": "simple_wait",
"...": "..."
},
"session_management": {
"warning": 240,
"end": 360,
"active": true
}
}
}
Cet article vous a-t-il été utile ?