Compliance
Generate access review report (SOC 2)
Generate access review report for compliance audits (SOC 2, ISO 27001, etc.). Requires JWT Bearer token authentication. Both OrgBearerAuth and ProjectBearerAuth are supported (they use the same JWT token format). These are organization-level operations.
POST
/api/compliance/access-reviewSDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, ComplianceApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const compliance = new ComplianceApi(configuration);import { Configuration, ComplianceApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const compliance = new ComplianceApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await compliance.generateAccessReview(
{
orgId: "org_PToBVgoRgq",
reviewPeriod: "pixel connect"
}
);const { data: result } = await compliance.generateAccessReview(
{
orgId: "org_PToBVgoRgq",
reviewPeriod: "pixel connect"
}
);Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Request Body
json
{
"orgId": "685acbe0e129932fbb7a0fc3",
"reviewPeriod": {
"start": "2024-10-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z"
}
}{
"orgId": "685acbe0e129932fbb7a0fc3",
"reviewPeriod": {
"start": "2024-10-01T00:00:00Z",
"end": "2024-12-31T23:59:59Z"
}
}Responses
200Access review report generated
json
{
"success": true,
"message": "Access review report generated",
"data": {
"orgId": "685acbe0e129932fbb7a0fc3",
"users": [],
"summary": {},
"recommendations": [],
"generatedAt": "2024-01-15T10:00:00.000Z"
}
}{
"success": true,
"message": "Access review report generated",
"data": {
"orgId": "685acbe0e129932fbb7a0fc3",
"users": [],
"summary": {},
"recommendations": [],
"generatedAt": "2024-01-15T10:00:00.000Z"
}
}400—
401—
Errors
| Code | Meaning |
|---|---|
400 | — |
401 | — |