mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-07-19 10:31:51 +00:00
pedrooot
43 lines
745 B
Plaintext
43 lines
745 B
Plaintext
---
|
|
title: "Create Tenant Invitation"
|
|
api: "POST /api/v1/tenants/invitations"
|
|
description: "Invite a user to join your tenant."
|
|
---
|
|
|
|
Send an invitation to a user to join your tenant.
|
|
|
|
## Request Body
|
|
|
|
```json
|
|
{
|
|
"data": {
|
|
"type": "invitations",
|
|
"attributes": {
|
|
"email": "newuser@example.com",
|
|
"role": "member"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST "https://api.prowler.com/api/v1/tenants/invitations" \
|
|
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
|
|
-H "Content-Type: application/vnd.api+json" \
|
|
-d '{
|
|
"data": {
|
|
"type": "invitations",
|
|
"attributes": {
|
|
"email": "newuser@example.com",
|
|
"role": "member"
|
|
}
|
|
}
|
|
}'
|
|
```
|
|
|
|
## Response
|
|
|
|
Returns the created invitation.
|