Skip to main content
POST
Authenticate a direct workspace invitation

Headers

X-Signup-Invite
string

Supply a signed invitation using this header or an invite/invite_token query or body field. At least one is required; body/query values take precedence.

Query Parameters

invite
string

Supply a signed invitation using this header or an invite/invite_token query or body field. At least one is required; body/query values take precedence.

invite_token
string

Supply a signed invitation using this header or an invite/invite_token query or body field. At least one is required; body/query values take precedence.

Response

Operation result.

status
enum<string>
required
Available options:
success
Example:

"success"

data
object
required
session_token
string
required

Opaque resume credential; send in X-Workspace-Onboarding-Session. Never log it.

Required string length: 64
Example:

"example-session-token-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"