docs(api): use mintlify for API specs

This commit is contained in:
pedrooot
2025-10-30 18:58:05 +01:00
parent f831171a21
commit 77089eba57
136 changed files with 23969 additions and 0 deletions
+7
View File
@@ -0,0 +1,7 @@
---
title: "Add Roles to User"
api: "POST /api/v1/users/{id}/relationships/roles"
description: "Assign roles to user."
---
Grant roles to a user for RBAC.
+20
View File
@@ -0,0 +1,20 @@
---
title: "Create User"
api: "POST /api/v1/users"
description: "Invite a new user to the tenant."
---
Create and invite a new user.
## Request Body
\`\`\`json
{
"data": {
"type": "users",
"attributes": {
"email": "user@example.com",
"name": "John Doe"
}
}
}
\`\`\`
+7
View File
@@ -0,0 +1,7 @@
---
title: "Delete User"
api: "DELETE /api/v1/users/{id}"
description: "Remove user from tenant."
---
Delete a user. This action cannot be undone.
+7
View File
@@ -0,0 +1,7 @@
---
title: "List Users"
api: "GET /api/v1/users"
description: "Retrieve all users in the tenant."
---
Get list of users with their roles and permissions.
+23
View File
@@ -0,0 +1,23 @@
---
title: "Get Current User"
api: "GET /api/v1/users/me"
description: "Retrieve information about the currently authenticated user."
---
Get profile information for the currently authenticated user including roles and permissions.
## Example Request
```bash
curl -X GET "https://api.prowler.com/api/v1/users/me" \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "Content-Type: application/vnd.api+json"
```
## Response
Returns the current user's profile including email, roles, tenants, and permissions.
<Note>
Use this endpoint to verify authentication and retrieve user context for your application.
</Note>
@@ -0,0 +1,7 @@
---
title: "List User Memberships"
api: "GET /api/v1/users/{id}/memberships"
description: "Get user's tenant memberships."
---
Retrieve tenants the user belongs to.
@@ -0,0 +1,7 @@
---
title: "Retrieve User Membership"
api: "GET /api/v1/users/{id}/memberships/{membership_id}"
description: "Get specific membership details."
---
Fetch details about a user's membership in a tenant.
@@ -0,0 +1,7 @@
---
title: "Remove Roles from User"
api: "DELETE /api/v1/users/{id}/relationships/roles"
description: "Revoke roles from user."
---
Remove role assignments from a user.
+7
View File
@@ -0,0 +1,7 @@
---
title: "Retrieve User"
api: "GET /api/v1/users/{id}"
description: "Get user details."
---
Fetch information about a specific user.
@@ -0,0 +1,7 @@
---
title: "Update User Roles"
api: "PATCH /api/v1/users/{id}/relationships/roles"
description: "Update user's assigned roles."
---
Modify user role assignments.
+7
View File
@@ -0,0 +1,7 @@
---
title: "Update User"
api: "PATCH /api/v1/users/{id}"
description: "Update user information."
---
Modify user details or status.