Update an existing session
Update an existing session with new information.
Path Parameters
- sessionId string required
"id of the session to update"
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- sessionToken string
Possible values:
non-empty
and<= 200 characters
"token of the session, previously returned on the create / update request"
checks object
"Check for user and password. Successful checks will be stated as factors on the session."
user object
"checks the user and updates the session on success"
userId stringPossible values:
non-empty
and<= 200 characters
loginName stringPossible values:
non-empty
and<= 200 characters
password object
"Checks the password and updates the session on success. Requires that the user is already checked, either in the previous or the same request."
password stringPossible values:
non-empty
and<= 200 characters
passkey object
"Checks the public key credential issued by the passkey client. Requires that the user is already checked and a passkey challenge to be requested, in any previous request."
credentialAssertionData object requiredPossible values:
>= 55 characters
and<= 1048576 characters
JSON representation of public key credential issued by the passkey client
intent object
"Checks the intent. Requires that the userlink is already checked and a successful intent."
intentId stringPossible values:
non-empty
and<= 200 characters
ID of the intent, previously returned on the success response of the IDP callback
token stringPossible values:
non-empty
and<= 200 characters
token of the intent, previously returned on the success response of the IDP callback
metadata object
"custom key value list to be stored on the session"
property name*
string- challenges string[]
Possible values: [
CHALLENGE_KIND_UNSPECIFIED
,CHALLENGE_KIND_PASSKEY
]
Request Body required
- sessionToken string
Possible values:
non-empty
and<= 200 characters
"token of the session, previously returned on the create / update request"
checks object
"Check for user and password. Successful checks will be stated as factors on the session."
user object
"checks the user and updates the session on success"
userId stringPossible values:
non-empty
and<= 200 characters
loginName stringPossible values:
non-empty
and<= 200 characters
password object
"Checks the password and updates the session on success. Requires that the user is already checked, either in the previous or the same request."
password stringPossible values:
non-empty
and<= 200 characters
passkey object
"Checks the public key credential issued by the passkey client. Requires that the user is already checked and a passkey challenge to be requested, in any previous request."
credentialAssertionData object requiredPossible values:
>= 55 characters
and<= 1048576 characters
JSON representation of public key credential issued by the passkey client
intent object
"Checks the intent. Requires that the userlink is already checked and a successful intent."
intentId stringPossible values:
non-empty
and<= 200 characters
ID of the intent, previously returned on the success response of the IDP callback
token stringPossible values:
non-empty
and<= 200 characters
token of the intent, previously returned on the success response of the IDP callback
metadata object
"custom key value list to be stored on the session"
property name*
string- challenges string[]
Possible values: [
CHALLENGE_KIND_UNSPECIFIED
,CHALLENGE_KIND_PASSKEY
]
Request Body required
- sessionToken string
Possible values:
non-empty
and<= 200 characters
"token of the session, previously returned on the create / update request"
checks object
"Check for user and password. Successful checks will be stated as factors on the session."
user object
"checks the user and updates the session on success"
userId stringPossible values:
non-empty
and<= 200 characters
loginName stringPossible values:
non-empty
and<= 200 characters
password object
"Checks the password and updates the session on success. Requires that the user is already checked, either in the previous or the same request."
password stringPossible values:
non-empty
and<= 200 characters
passkey object
"Checks the public key credential issued by the passkey client. Requires that the user is already checked and a passkey challenge to be requested, in any previous request."
credentialAssertionData object requiredPossible values:
>= 55 characters
and<= 1048576 characters
JSON representation of public key credential issued by the passkey client
intent object
"Checks the intent. Requires that the userlink is already checked and a successful intent."
intentId stringPossible values:
non-empty
and<= 200 characters
ID of the intent, previously returned on the success response of the IDP callback
token stringPossible values:
non-empty
and<= 200 characters
token of the intent, previously returned on the success response of the IDP callback
metadata object
"custom key value list to be stored on the session"
property name*
string- challenges string[]
Possible values: [
CHALLENGE_KIND_UNSPECIFIED
,CHALLENGE_KIND_PASSKEY
]
- 200
- 403
- 404
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to- sessionToken string
"token of the session, which is required for further updates of the session or the request other resources"
challenges object
passkey object
publicKeyCredentialRequestOptions objectOptions for Assertion Generaration (dictionary PublicKeyCredentialRequestOptions). Generated helper methods transform the field to JSON, for use in a WebauthN client. See also: https://www.w3.org/TR/webauthn/#dictdef-publickeycredentialrequestoptions
{
"details": {
"sequence": "2",
"changeDate": "2023-07-31",
"resourceOwner": "69629023906488334"
},
"sessionToken": "string",
"challenges": {
"passkey": {
"publicKeyCredentialRequestOptions": {
"publicKey": {
"allowCredentials": [
{
"id": "ATmqBg-99qyOZk2zloPdJQyS2R7IkFT7v9Hoos_B_nM",
"type": "public-key"
}
],
"challenge": "GAOHYz2jE69kJMYo6Laij8yWw9-dKKgbViNhfuy0StA",
"rpId": "localhost",
"timeout": 300000,
"userVerification": "required"
}
}
}
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to- sessionToken string
"token of the session, which is required for further updates of the session or the request other resources"
challenges object
passkey object
publicKeyCredentialRequestOptions objectOptions for Assertion Generaration (dictionary PublicKeyCredentialRequestOptions). Generated helper methods transform the field to JSON, for use in a WebauthN client. See also: https://www.w3.org/TR/webauthn/#dictdef-publickeycredentialrequestoptions
{
"details": {
"sequence": "2",
"changeDate": "2023-07-31",
"resourceOwner": "69629023906488334"
},
"sessionToken": "string",
"challenges": {
"passkey": {
"publicKeyCredentialRequestOptions": {
"publicKey": {
"allowCredentials": [
{
"id": "ATmqBg-99qyOZk2zloPdJQyS2R7IkFT7v9Hoos_B_nM",
"type": "public-key"
}
],
"challenge": "GAOHYz2jE69kJMYo6Laij8yWw9-dKKgbViNhfuy0StA",
"rpId": "localhost",
"timeout": 300000,
"userVerification": "required"
}
}
}
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to- sessionToken string
"token of the session, which is required for further updates of the session or the request other resources"
challenges object
passkey object
publicKeyCredentialRequestOptions objectOptions for Assertion Generaration (dictionary PublicKeyCredentialRequestOptions). Generated helper methods transform the field to JSON, for use in a WebauthN client. See also: https://www.w3.org/TR/webauthn/#dictdef-publickeycredentialrequestoptions
{
"details": {
"sequence": "2",
"changeDate": "2023-07-31",
"resourceOwner": "69629023906488334"
},
"sessionToken": "string",
"challenges": {
"passkey": {
"publicKeyCredentialRequestOptions": {
"publicKey": {
"allowCredentials": [
{
"id": "ATmqBg-99qyOZk2zloPdJQyS2R7IkFT7v9Hoos_B_nM",
"type": "public-key"
}
],
"challenge": "GAOHYz2jE69kJMYo6Laij8yWw9-dKKgbViNhfuy0StA",
"rpId": "localhost",
"timeout": 300000,
"userVerification": "required"
}
}
}
}
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}