mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-07-24 21:11:53 +00:00
docs(api): use mintlify for API specs
This commit is contained in:
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Add Provider Groups to Role"
|
||||
api: "POST /api/v1/roles/{id}/relationships/provider_groups"
|
||||
description: "Associate provider groups with role."
|
||||
---
|
||||
|
||||
Link provider groups to a role for scoped access.
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: "Create Role"
|
||||
api: "POST /api/v1/roles"
|
||||
description: "Create a new RBAC role."
|
||||
---
|
||||
|
||||
Create a custom role with specific permissions.
|
||||
|
||||
## Request Body
|
||||
\`\`\`json
|
||||
{
|
||||
"data": {
|
||||
"type": "roles",
|
||||
"attributes": {
|
||||
"name": "Security Auditor",
|
||||
"permissions": ["read:findings", "read:scans"]
|
||||
}
|
||||
}
|
||||
}
|
||||
\`\`\`
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Delete Role"
|
||||
api: "DELETE /api/v1/roles/{id}"
|
||||
description: "Remove a role."
|
||||
---
|
||||
|
||||
Delete a custom role. Built-in roles cannot be deleted.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "List Roles"
|
||||
api: "GET /api/v1/roles"
|
||||
description: "Retrieve RBAC roles."
|
||||
---
|
||||
|
||||
Get all roles available in the tenant for role-based access control.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Remove Provider Groups from Role"
|
||||
api: "DELETE /api/v1/roles/{id}/relationships/provider_groups"
|
||||
description: "Remove provider groups from role."
|
||||
---
|
||||
|
||||
Disassociate provider groups from a role.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Retrieve Role"
|
||||
api: "GET /api/v1/roles/{id}"
|
||||
description: "Get role details."
|
||||
---
|
||||
|
||||
Fetch information about a specific role.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Update Role Provider Groups"
|
||||
api: "PATCH /api/v1/roles/{id}/relationships/provider_groups"
|
||||
description: "Update role's provider groups."
|
||||
---
|
||||
|
||||
Modify provider group associations for a role.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Update Role"
|
||||
api: "PATCH /api/v1/roles/{id}"
|
||||
description: "Update role permissions."
|
||||
---
|
||||
|
||||
Modify role name or permissions.
|
||||
Reference in New Issue
Block a user