Skip to content

Commit

Permalink
docs: Added note about XSRF token lifetime (#4936)
Browse files Browse the repository at this point in the history
* docs: Added note about XSRF token lifetime

* Minor fix
  • Loading branch information
nicolatimeus authored Nov 1, 2023
1 parent 9a1b03e commit 017f74f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/references/rest-apis/rest-session-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ The supported workflows are the following:

1. Try calling the [GET/xsrfToken](#getxsrftoken) to get an XSRF token, if the request succeeds a vaild session is already available, it is possible to proceed to step 4.

It is not necessary to call [GET/xsrfToken](#getxsrftoken) again until the current session expires, the obtained token is valid as long as the current session is valid.

2. Call the [POST/login/password](#postloginpassword) or [POST/login/certificate](#postlogincertificate) providing the credentials to create a new session.

The device will return a session cookie with the response, make sure to provide it in successive requests. If the request is performed by a browser, this should be done automatically.
Expand Down Expand Up @@ -83,7 +85,7 @@ The supported workflows are the following:

### GET/xsrfToken
* **REST API path** : /services/session/v1/xsrfToken
* **description** : Gets the XSRF token associated with the current session.
* **description** : Gets the XSRF token associated with the current session. It is not necessary to call this method again until the current session expires, the obtained token is valid as long as the current session is valid.
* **responses** :
* **200**
* **description** : Request succeeded, the XSRF token is returned in response body.
Expand Down

0 comments on commit 017f74f

Please sign in to comment.