Skip to main content
POST
/
v2
/
databases
/
{database}
/
tenants
/
{tenantId}
/
invite
Invite a user to a tenant
curl --request POST \
  --url https://api.example.com/v2/databases/{database}/tenants/{tenantId}/invite \
  --header 'Content-Type: multipart/form-data' \
  --cookie nile-auth.session-token= \
  --form [email protected] \
  --form 'csrfToken=<string>' \
  --form 'redirectUrl=<string>' \
  --form 'callbackUrl=<string>'
{
  "status": "success",
  "message": "Invite email sent"
}

Authorizations

​
nile-auth.session-token
string
cookie
required

Session token stored in a cookie after user signs in, prefixed with __Secure if on https

Path Parameters

​
database
string
required
​
tenantId
string
required

Body

multipart/form-data
​
identifier
string<email>
required

Email address of the user being invited

​
csrfToken
string
required

CSRF token for request validation

​
redirectUrl
string<uri>
required

URL to redirect the user to after accepting the invite

​
callbackUrl
string<uri>
required

Callback URL to include in the invitation email

Response

Invite sent successfully

​
status
string
Example:

"success"

​
message
string
Example:

"Invite email sent"