Controls

Invite an auditor

POST
/organizations/{organizationId}/auditor-access

Invites an external auditor to the organization and grants them access to the selected frameworks.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

organizationId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/organizations/string/auditor-access" \  -H "Content-Type: application/json" \  -d '{    "auditorEmail": "user@example.com",    "expiresAt": "string"  }'
{  "auditorAccess": {    "id": "string",    "organizationId": "string",    "organizationFrameworkIds": [      "string"    ],    "auditId": "string",    "audit": {      "id": "string",      "firmName": "string",      "frameworkNames": [        "string"      ]    },    "auditorEmail": "string",    "auditorOrgName": "string",    "invitedByUserId": "string",    "userId": "string",    "accountId": "string",    "status": "invited",    "permissions": {      "canExport": true,      "canComment": true,      "canViewDocuments": true    },    "invitedAt": "string",    "activatedAt": "string",    "expiresAt": "string",    "lastAccessAt": "string",    "revokedAt": "string",    "revokedByUserId": "string",    "dateCreated": null,    "dateUpdated": null,    "property1": null,    "property2": null  }}