Sign in
latestOpenAPI 3.1.02026-08-20118232229.3 KB

0e42b0fb26d9

Create guest

Creates a new guest with access to a specific externally accessible app and returns a login URL to share with them.

post/guests

Request body

$schemastring uri

A URL to the JSON Schema for this object.

appstring required

The name of the externally accessible app this guest can access.

expires_ininteger

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

namestring

Optional display name for the guest.

redirect_urlstring

Where to redirect the guest after they log in. Defaults to the app's subdomain.

Example request

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

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

login_urlstring required

The URL to share with the guest for logging in.

login_url_expires_atstring date-time required

When the login URL expires.

Example response

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