API roles to action mapping

The following roles only apply when authenticating with the OIDC Client Credentials flow.

When using Basic authentication, the user/app will have the same permissions as the Admin role.

---

Synchronous API

V3

Resource	Action	User	Admin
/api/v3/cdr-file	POST	x	x
/api/v3/cdr	POST	x	x
/api/v3/export-file	POST	x	x
/api/v3/export	POST	x	x
/api/v3/import-file	POST	x	x
/api/v3/import	POST	x	x

V2

Resource	Action	User	Admin
/api/FileTypeDetection/file	POST	x	x
/api/FileTypeDetection/base64	POST	x	x
/api/Analyse/file	POST	x	x
/api/Analyse/base64	POST	x	x
/api/Rebuild/file	POST	x	x
/api/Rebuild/base64	POST	x	x
/api/Rebuild/archivefile	POST	x	x
/api/Rebuild/protectedZipfile	POST	x	x
/api/Composite/file	POST	x	x
/api/Composite/base64	POST	x	x

---

Asynchronous API

V1

Resource	Action	User	Admin
/api/v1/cdr-async	POST	x	x
/api/v1/cdr-async/{transactionId}	GET	x	x
/api/v1/cdr-file-async	POST	x	x
/api/v1/cdr-file-async/{transaction}	GET	x	x

---

Policy Management API

V1

Resource	Action	User	Admin
/api/v1/policies/{policyName}	POST	x	x
/api/v1/policies/{policyName}	PUT	x	x
/api/v1/policies/{policyName}	GET	x	x
/api/v1/policies/{policyName}	DELETE	x	x
/api/v1/policies/	GET	x	x
/api/v1/policies/{policyName}/reset	PUT	x	x

---

License Management API

V1

Resource	Action	User	Admin
/api/v1/license-usage/{licenseId}	GET		x
/api/v1/license-usage/active	GET		x
/api/v1/license	POST		x
/api/v1/license	GET	x	x
/api/v1/license	DELETE		x
/api/v1/license-usage	GET	x	x

V2

Resource	Action	User	Admin
/api/v2/license	GET	x	x

---

ICAP Profile Management API

V1

Resource	Action	User	Admin
/api/v1/profiles/{profileName}	POST	x	x
/api/v1/profiles/{profileName}	PUT	x	x
/api/v1/profiles/{profileName}	GET	x	x
/api/v1/profiles/{profileName}	DELETE	x	x
/api/v1/profiles/	GET	x	x
/api/v1/profiles/{profileName}/reset	PUT	x	x

---

XML Validation API

V1

Resource	Action	User	Admin
/api/v1/validate-xml	POST	x	x

---

XML Policy Management API

V1

Resource	Action	User	Admin
/api/v1/xml-policies/{XMLPolicyName}	POST	x	x
/api/v1/xml-policies/{XMLPolicyName}	PUT	x	x
/api/v1/xml-policies/{XMLPolicyName}	GET	x	x
/api/v1/xml-policies/{XMLPolicyName}	DELETE	x	x
/api/v1/xml-policies/	GET	x	x
/api/v1/xml-policies/{XMLPolicyName}/reset	PUT	x	x

---

Storage Monitor API

V1

Resource	Action	User	Admin
/api/storage-monitor/sharepoint/v1/sites	GET	x	x
/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives	GET	x	x
/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors	POST	x	x
/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors	PATCH	x	x
/api/storage-monitor/sharepoint/v1/sites/{siteId}/drives/{driveId}/monitors	DELETE	x	x
/api/storage-monitor/sharepoint/v1/monitors	GET	x	x
/api/storage-monitor/sharepoint/v1/monitors	POST	x	x
/api/storage-monitor/sharepoint/v1/monitors	PATCH	x	x
/api/storage-monitor/sharepoint/v1/monitors	DELETE	x	x
/api/storage-monitor/sharepoint/v1/status	GET	x	x
/api/storage-monitor/onedrive/v1/users	GET	x	x
/api/storage-monitor/onedrive/v1/users/{userId}/monitors	POST	x	x
/api/storage-monitor/onedrive/v1/users/{userId}/monitors	PATCH	x	x
/api/storage-monitor/onedrive/v1/users/{userId}/monitors	DELETE	x	x
/api/storage-monitor/onedrive/v1/monitors	GET	x	x
/api/storage-monitor/onedrive/v1/monitors	POST	x	x
/api/storage-monitor/onedrive/v1/monitors	PATCH	x	x
/api/storage-monitor/onedrive/v1/monitors	DELETE	x	x
/api/storage-monitor/onedrive/v1/status	GET	x	x