Sign in

Provision an app user

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Gives a person access to this app ahead of their first sign-in, so the app can be embedded signed in as them. Returns created for a new email, and exists for an email that already has an access request, whatever its state: a request still pending approval stays pending, and an embed sign-in token for it answers unknown_user. A workspace API key needs the Provision app users permission. Limited to 120 requests a minute per app, shared with deprovisioning. Higher plans get a higher limit.

post/api/apps/{app_id}/users/provisions

Path parameters

app_idstring required

ID of the app.

ID of the app.

Request body

emailstring email required

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

rolestring required

Application-level role for in-app permissions

full_namestring nullable

Response

Successful Response

status'created' | 'exists' required

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

emailstring required

The email, lowercased.

rolestring required

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

Example response

{
  "status": "created",
  "email": "dana@example.com",
  "role": "user"
}

Changes

Changed in 1 of the 35 revisions of this API.1