mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-10-30 15:24:22 +00:00
docs(api): use mintlify for API specs
This commit is contained in:
1 parent
f831171a21
commit
77089eba57
136 files changed
+23969
No files matched your search
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Create Tenant"
|
||||
api: "POST /api/v1/tenants"
|
||||
description: "Create a new tenant organization."
|
||||
---
|
||||
|
||||
Create a new tenant (organization).
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Delete Tenant"
|
||||
api: "DELETE /api/v1/tenants/{id}"
|
||||
description: "Remove a tenant."
|
||||
---
|
||||
|
||||
Delete a tenant and all its data. This action cannot be undone.
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: "List Tenant Invitations"
|
||||
api: "GET /api/v1/tenants/invitations"
|
||||
description: "Retrieve pending invitations for the current tenant."
|
||||
---
|
||||
|
||||
View all pending invitations sent from your tenant to other users.
|
||||
|
||||
## Example Request
|
||||
|
||||
```bash
|
||||
curl -X GET "https://api.prowler.com/api/v1/tenants/invitations" \
|
||||
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
|
||||
-H "Content-Type: application/vnd.api+json"
|
||||
```
|
||||
|
||||
## Response
|
||||
|
||||
Returns a list of pending invitations.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Delete Tenant Invitation"
|
||||
api: "DELETE /api/v1/tenants/{id}/invitations/{invitation_id}"
|
||||
description: "Cancel invitation."
|
||||
---
|
||||
|
||||
Cancel a pending invitation.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Retrieve Tenant Invitation"
|
||||
api: "GET /api/v1/tenants/{id}/invitations/{invitation_id}"
|
||||
description: "Get invitation details."
|
||||
---
|
||||
|
||||
Fetch information about a specific invitation.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Update Tenant Invitation"
|
||||
api: "PATCH /api/v1/tenants/{id}/invitations/{invitation_id}"
|
||||
description: "Update invitation."
|
||||
---
|
||||
|
||||
Modify invitation or resend.
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: "List Tenants"
|
||||
api: "GET /api/v1/tenants"
|
||||
description: "Retrieve a list of tenants you belong to."
|
||||
---
|
||||
|
||||
Retrieve all tenants (organizations) that you are a member of.
|
||||
|
||||
## Example Request
|
||||
|
||||
```bash
|
||||
curl -X GET "https://api.prowler.com/api/v1/tenants" \
|
||||
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
|
||||
-H "Content-Type: application/vnd.api+json"
|
||||
```
|
||||
|
||||
## Response
|
||||
|
||||
Returns a list of tenants with their details and your role in each.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Remove Tenant Membership"
|
||||
api: "DELETE /api/v1/tenants/{id}/memberships/{membership_id}"
|
||||
description: "Remove user from tenant."
|
||||
---
|
||||
|
||||
Remove a user's membership from the tenant.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "List Tenant Memberships"
|
||||
api: "GET /api/v1/tenants/{id}/memberships"
|
||||
description: "Get all members of a tenant."
|
||||
---
|
||||
|
||||
Retrieve users who are members of the tenant.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Retrieve Tenant"
|
||||
api: "GET /api/v1/tenants/{id}"
|
||||
description: "Get tenant details."
|
||||
---
|
||||
|
||||
Fetch information about a specific tenant.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Update Tenant"
|
||||
api: "PATCH /api/v1/tenants/{id}"
|
||||
description: "Update tenant settings."
|
||||
---
|
||||
|
||||
Modify tenant name or configuration.
|
||||
Reference in new issue
Block a user