User Invitations
Invite users to join a tenant via email. Manage pending invitations including resending and cancelling.
Send Invitation
Send an invitation email to a user to join the tenant.
Endpoint: POST /uflow/admin/invite
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Admin Bearer JWT token |
Request Body
{
"email": "string",
"role": "string",
"name": "string"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Email address of the user to invite |
role | string | No | Role to assign on acceptance |
name | string | No | Display name for the invitation |
Response
Success (200):
{
"message": "Invitation sent successfully",
"invitation_id": "string",
"email": "string"
}
Error Responses:
400- Bad Request - invalid email401- Unauthorized409- User already exists or invitation already pending
List Pending Invitations
Get all pending invitations for the tenant.
Endpoint: GET /uflow/admin/invite/pending
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Admin Bearer JWT token |
Response
Success (200):
[
{
"invitation_id": "string",
"email": "string",
"role": "string",
"status": "pending",
"created_at": "string",
"expires_at": "string"
}
]
Resend Invitation
Resend an invitation email to a user.
Endpoint: POST /uflow/admin/invite/resend
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Admin Bearer JWT token |
Request Body
{
"email": "string"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Email of the pending invitation |
Response
Success (200):
{
"message": "Invitation resent successfully"
}
Error Responses:
400- Bad Request404- No pending invitation found for email
Cancel Invitation
Cancel a pending invitation.
Endpoint: POST /uflow/admin/invite/cancel
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Admin Bearer JWT token |
Request Body
{
"email": "string"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Email of the invitation to cancel |
Response
Success (200):
{
"message": "Invitation cancelled successfully"
}
Error Responses:
400- Bad Request404- No pending invitation found