Sign in
latestOpenAPI 3.1.02026-08-20118232229.3 KB

0e42b0fb26d9

Regenerate guest login URL

Creates a new login URL for an existing guest. Use this if the previous URL expired or was compromised.

post/guests/{guest_id}/login-url

Path parameters

guest_idstring required

The ID of the guest to regenerate the login URL for.

The ID of the guest to regenerate the login URL for.

Request body

$schemastring uri

A URL to the JSON Schema for this object.

expires_ininteger

The number of seconds the guest session should last. Defaults to 72 hours.

redirect_urlstring

Where to redirect the guest after they log in.

Example request

{
  "$schema": "https://api.tower.dev/v1/schemas/RegenerateGuestLoginURLParams.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

login_urlstring required

The new login URL to share with the guest.

login_url_expires_atstring date-time required

When the login URL expires.

Example response

{
  "$schema": "https://api.tower.dev/v1/schemas/RegenerateGuestLoginURLResponse.json"
}