Update session
Update the status for the current user session. In case the session is created an OTP for the user is created and send via email, the caller can verify the OTP using VerifyOTP or use the provided value.
Path parameters
-
sessionId string(uuid)
The ID of the user session.
Body Required
-
userId string(uuid)
The ID of the user that owns the session
-
passedLoginOTP boolean
sets the login otp to true (passed) or false (not passed)
Responses
-
200 application/json
OTP send.
-
Session updated.
-
401 application/vnd.api+json
OAuth token missing or invalid or a linked identity is missing.
Linked identity missing is a special case where you need to make sure that the user has additionally logged in / authorized with a third-party.
This is not relevant for most use-cases.
The specific error code that identifies a missing linked identity is
missing-linked-identity
Example:
{ "errors": [ { "id": "cbgmhslmp1o9or9kh1p0", "title": "Missing linked identity for authorized access", "detail": "Linked identity is needed to access this resource, please check why the user does not have a linked identity", "status": "401", "code": "missing-linked-identity" } ] }
-
404 application/vnd.api+json
Resource not found
-
500 application/vnd.api+json
Internal server error
PUT /sessions/{sessionId}
curl \
-X PUT https://api.pace.cloud/user/2024-3/sessions/ddac0bf6-e618-499e-b6ee-2c45530ea8ed \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"userId":"738e379f-fe30-45ab-819c-ba88804b6368","passedLoginOTP":true}'
Request examples
{
"userId": "738e379f-fe30-45ab-819c-ba88804b6368",
"passedLoginOTP": true
}
Response examples (200)
{
"otp": "773829",
"expiresAt": "2021-04-12T23:20:50.52Z"
}
Response examples (401)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (404)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (500)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}