mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-07-24 13:01:56 +00:00
docs(api): use mintlify for API specs
This commit is contained in:
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: "Create SAML Configuration"
|
||||
api: "POST /api/v1/saml-config"
|
||||
description: "Configure SAML SSO."
|
||||
---
|
||||
|
||||
Add SAML identity provider for SSO authentication.
|
||||
|
||||
## Request Body
|
||||
\`\`\`json
|
||||
{
|
||||
"data": {
|
||||
"type": "saml-config",
|
||||
"attributes": {
|
||||
"entity_id": "https://idp.example.com",
|
||||
"sso_url": "https://idp.example.com/sso",
|
||||
"x509_cert": "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----"
|
||||
}
|
||||
}
|
||||
}
|
||||
\`\`\`
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Delete SAML Configuration"
|
||||
api: "DELETE /api/v1/saml-config/{id}"
|
||||
description: "Remove SAML SSO configuration."
|
||||
---
|
||||
|
||||
Delete SAML identity provider. Users will need alternative authentication.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "List SAML Configurations"
|
||||
api: "GET /api/v1/saml-config"
|
||||
description: "Retrieve SAML SSO configurations."
|
||||
---
|
||||
|
||||
Get configured SAML identity providers for single sign-on.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Retrieve SAML Configuration"
|
||||
api: "GET /api/v1/saml-config/{id}"
|
||||
description: "Get SAML SSO details."
|
||||
---
|
||||
|
||||
Fetch SAML configuration details.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Update SAML Configuration"
|
||||
api: "PATCH /api/v1/saml-config/{id}"
|
||||
description: "Update SAML SSO settings."
|
||||
---
|
||||
|
||||
Modify SAML identity provider configuration.
|
||||
Reference in New Issue
Block a user