Skip to main content
POST
Provision an app user

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app.

Body

application/json

Payload for server-to-server app-user provisioning (embedded platforms).

email
string<email>
required

The app user's email — their identity in this app

role
string
required

Application-level role for in-app permissions

full_name
string | null
Maximum string length: 256

Response

Successful Response

The app user an email was provisioned as.

status
enum<string>
required

created for a new email, exists for one that already had an access request.

Available options:
created,
exists
Example:

"created"

email
string
required

The email, lowercased.

Example:

"dana@example.com"

role
string
required

The role the email holds in the app. For exists, the role it already had.

Example:

"user"