Skip to main content
POST
Create a shareable invite link

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Body

application/json
role
enum<string>
required
Available options:
admin,
developer,
viewer

Response

The invite, the raw token and the link. Store neither: they cannot be shown again.

invite
object
required
token
string
required

The raw token, shown once.

Pattern: ^[A-Za-z0-9_-]{43}$
url
string<uri>
required

{APP_ORIGIN}/#/invite/{token}: the link to share.