Skip to main content

Update an existing session​

Update an existing session with new information.

Path Parameters
  • sessionId string required

    "id of the session to update"

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 string

    Possible values: non-empty and <= 200 characters

  • loginName string

    Possible 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 string

    Possible values: non-empty and <= 200 characters

  • webAuthN object

    "Checks the public key credential issued by the WebAuthN client. Requires that the user is already checked and a WebAuthN challenge to be requested, in any previous request."

  • credentialAssertionData object required

    Possible values: >= 55 characters and <= 1048576 characters

    JSON representation of public key credential issued by the webAuthN client

  • intent object

    "Checks the intent. Requires that the userlink is already checked and a successful intent."

  • intentId string

    Possible values: non-empty and <= 200 characters

    ID of the intent, previously returned on the success response of the IDP callback

  • token string

    Possible 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 object
  • webAuthN object
  • domain string required

    "Domain on which the session was created. Will be used in the WebAuthN challenge."

  • userVerificationRequirement string required

    Possible values: [USER_VERIFICATION_REQUIREMENT_UNSPECIFIED, USER_VERIFICATION_REQUIREMENT_REQUIRED, USER_VERIFICATION_REQUIREMENT_PREFERRED, USER_VERIFICATION_REQUIREMENT_DISCOURAGED]

    Default value: USER_VERIFICATION_REQUIREMENT_UNSPECIFIED

    "User verification that is required during validation. When set to USER_VERIFICATION_REQUIREMENT_REQUIRED the behaviour is for passkey authentication. Other values will mean U2F"

Responses

OK

Schema
  • details object
  • sequence uint64

    on 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-time

    on 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
  • webAuthN object
  • publicKeyCredentialRequestOptions object

    Options 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

Loading...