API v2: Sharing Sessions 🆕

Fudo Enterprise enables sharing given session with another user.

Data Structures

SessionShareModel

Attribute	Type	Required	Description
id	string		Unique, read only object identifier. Protected.
session_id	string	yes	ID of the session to share. Immutable.
user_id	string	yes	Read-only. Hidden. Expensive to use. Immutable. Requires session-view right on the user object for GET and POST requests.
key	string		Read-only.
valid_since	datetime	yes	Immutable. Start date and time of the share validity period, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). Example: 2025-05-15T13:07:00.000Z
valid_to	datetime	yes	Immutable. End date and time of the share validity period, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). Example: 2025-05-15T21:07:00.000Z
readonly	boolean	yes	Immutable. Define whether the third party will be able to actively participate in session (applicable to live sessions).
link	string		Provide a session link that excludes the host prefix. Read-only. Expensive to use.
created_at	datetime		Read-only. Timestamp of creation.
modified_at	datetime		Read-only. Timestamp of modification.
removed	boolean		Read-only.

Retrieve Available Attributes of the SessionShareModel

Request

Method	GET
Path	/api/v2/objspec/session_share

GET /api/v2/objspec/session_share

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/session_share'

Get Session Sharing Information

Request

Method	GET
Path	/api/v2/session/<session_id>/share

GET /api/v2/session/<session_id>/share

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.31.92.108/api/v2/session/4782822804267466753/share'
{

Response

{
    "result": "success",
    "session_share": [
        {
            "session_id": "4665729213955833860",
            "key": "yKaOzVjAoPZ6Hga6ECFEoVD2yKJXrrcPTDvhYFeUYNfxJaLs8D1piZdhFLIxivcT",
            "valid_since": "2025-05-14 05:11:00-07",
            "valid_to": "2025-05-14 13:11:00-07",
            "readonly": true,
            "link": "\/sessions\/4665729213955833860\/?key=yKaOzVjAoPZ6Hga6ECFEoVD2yKJXrrcPTDvhYFeUYNfxJaLs8D1piZdhFLIxivcT",
            "created_at": "2025-05-14 05:11:20.443267-07",
            "modified_at": "2025-05-14 05:11:20.443267-07"
        },
        {
            "session_id": "4665729213955833860",
            "key": "fEGWO92C3IDki0EaMgpbpOffRFYSNhg6gYa6jYMp2zyfcMtFpIKdMr20S1jGKD3t",
            "valid_since": "2025-05-14 05:16:00-07",
            "valid_to": "2025-05-14 13:16:00-07",
            "readonly": true,
            "link": "\/sessions\/4665729213955833860\/?key=fEGWO92C3IDki0EaMgpbpOffRFYSNhg6gYa6jYMp2zyfcMtFpIKdMr20S1jGKD3t",
            "created_at": "2025-05-14 05:18:11.152713-07",
            "modified_at": "2025-05-14 05:18:11.152713-07"
        }
    ]
}

Share Session

Request

Method	POST
Path	/api/v2/session/<session_id>/share
Headers	Content-Type: Application/json
Body	SessionShareModel

POST /api/v2/session/<session_id>/share

Example Request

curl -s -k -X POST \
     -H 'Authorization: proxycrypto' \
         -H 'Content-Type: application/json' \
         -d '{"valid_since": "2025-05-15T13:07:00.000Z","valid_to": "2025-05-15T21:07:00.000Z","readonly": true}' \
     'https://10.31.92.108/api/v2/session/4665729213955833860/share'

Response

{
    "result": "success",
    "session_share": {
        "key": "gHJNP5SWFx08lvecW82uotFfxZVYJzOqhIbusRR9q1HmFLF1C7rd5xv7BywSmeOQ"
    }
}