Skip to main content
Feedback

Permission System API Output Overview

This API output provides a comprehensive overview of the permissions and access levels within the system.

Below is a breakdown of the different endpoints, their associated functionalities, and the corresponding permissions granted:

  1. Organization (/organizations)

    • Get / List Organization (4000)
    • Get / List Alerts (2000)Explanation: This section outlines permissions related to viewing and managing organizations, including access to alerts.

  2. Organization Details (/organizations/<ID>)

    • Undefined (Undefined)
    • Get / List Organization (4000)Explanation: Describes permissions for accessing specific organization details.

  3. Organization Endpoints (/organizations/<ID>/endpoints)

    • Get / List Organization Endpoints (4100)Explanation: Covers permissions for managing endpoints within an organization.

  4. Organization Subscriptions (/organizations/<ID>/subscriptions)

    • Get / List Organization Subscriptions (4200)Explanation: Details permissions for managing subscriptions within an organization.

  5. Organization PGP Keys (/organizations/<ID>/pgp-keys)

    • Get / List Organization Certificates (4500)
    • Get / List Organization PGP Keys (4300)Explanation: Specifies permissions for managing PGP keys within an organization.

  6. Organization SSH Keys (/organizations/<ID>/ssh-keys)

    • Get / List Organization Certificates (4500)
    • Get / List Organization SSH Keys (4400)Explanation: Describes permissions for managing SSH keys within an organization.

  7. Organization Certificates (/organizations/<ID>/certificates)

    • Get / List Organization Certificates (4500)Explanation: Indicates permissions for managing certificates within an organization.

  8. Organization MFT Nodes (/organizations/<ID>/mft-nodes)

    • Get / List Organization MFT Nodes (4600)Explanation: Outlines permissions for managing MFT Nodes within an organization.

  9. Organization Machine Users (/organizations/<ID>/machine-users)

    • Get / List Organization Machine Users (4700)Explanation: Specifies permissions for managing machine users within an organization.

  10. Flows (/flows)

    • Get / List Flows (5000)
    • Get / List Alerts (2000)Explanation: Describes permissions related to managing flows and accessing alerts.

  11. Flow Details (/flows/<ID>/<ID>)

    • Get / List Flow Endpoint Server Path Config (5510)
    • Get / List Flow Endpoint Main Config (5440)
    • Get / List Flow Endpoint (5100)
    • Get / List Flow Endpoint Processing Config (5470)
    • Get / List Organization PGP Key (4300)
    • Get / List Flow Endpoint Anti Virus Config (5420)
    • Get / List Flow Endpoint Triggers Config (5530)
    • Get / List Flow Endpoint Rename Option Config (5490)
    • Get / List Flow Endpoint Email Notification Config (5450)
    • Get / List Flow Endpoint Alert Config (5410)
    • Get / List Flow Endpoint Server User Config (5520)
    • Get / List Organization Certificates (4500)
    • Get / List Organization SSH Keys (4400)
    • Get / List Flow Endpoint Server Path Mapping Config (5500)Explanation: This section details the various configurations and settings available for managing specific flow endpoints.

  12. Flow Subscribers (/flows/<ID>/subscribers)

    • Get / List Flow Subscriptions (5200)Explanation: Describes permissions for managing subscribers related to a specific flow.

  13. Flow Schedule History (/flows/<ID>/schedule-history)

    • Get / List Flow Transfer Requests (5020)
    • Get / List Flows (5000)
    • Get / List Flow Endpoints (5100)Explanation: Covers permissions related to the schedule history of a flow, including transfer requests and associated flow and endpoint details.

  14. Flow Responses (/flows/<ID>/responses/<ID>)

    • Get / List Flow Client Responses (5021)
    • Get / List Flows (5000)Explanation: Details permissions for managing client responses within a specific flow.

  15. Activity (/activity)

    • File Activity (1200)
    • Get / List Alerts (2000)
    • Download Files (1202)Explanation: Describes permissions related to file activity, alerts, and file downloads.

  16. Alerts (/alerts)

    • Get / List Alerts (2000)Explanation: Specifies permissions for managing alerts within the system.

  17. Admin Users (/admin/users)

    • Get / List User Management (6000)
    • Instance Admin APIs (6011)
    • Get / List Alerts (2000)Explanation: Outlines permissions for managing users, instance admin APIs, and alerts in the administrative context.

  18. Admin User Details (/admin/users/<ID>)

    • Get / List User Management (6000)
    • Instance Admin APIs (6011)
    • Undefined (Undefined)
    • Get Admin Roles (6200)
    • Get / List Organizations (4000)
    • Get / List Flows (5000)
    • Get / List Flow Endpoints (5100)Explanation: Details permissions for managing specific user accounts and associated administrative roles, organizations, flows, and flow endpoints.

  19. Admin User Sessions (/admin/users/<ID>/user-sessions)

    • Undefined (Undefined)
    • Get / List User Management (6000)
    • Instance Admin APIs (6011)Explanation: Describes permissions related to user sessions, user management, and instance admin APIs within the system.

  20. Admin Roles (/admin/roles)

    • Get Admin Roles (6200)
    • Instance Admin APIs (6011)Explanation: Outlines permissions for managing administrative roles and instance admin APIs.

  21. Admin Role Details (/admin/roles/<ID>)

    • Undefined (Undefined)
    • Get Admin Roles (6200)
    • Instance Admin APIs (6011)Explanation: Details permissions for specific administrative role configurations and instance admin APIs.

  22. Admin Retention (/admin/retention)

    • Get Admin Retention (6400)
    • Instance Admin APIs (6011)Explanation: Specifies permissions for managing retention settings within the administrative context.

  23. Admin Audit Log (/admin/audit-log)

    • Undefined (Undefined)Explanation: Describes permissions related to the audit log in the administrative context.

  24. Admin MFA (/admin/mfa)

    • Get Admin MFA (6410)
    • Instance Admin APIs (6011)Explanation: Outlines permissions for managing multi-factor authentication (MFA) settings within the administrative context.

  25. Admin MFT Nodes (/admin/mft-nodes)

    • List Admin MFT Nodes (6020)Explanation: Details permissions for listing MFT Nodes in the administrative context.

  26. Admin Feature Flags (/admin/feature-flags)

    • Get Admin Feature Flag (6100)Explanation: Specifies permissions for accessing and managing feature flags within the administrative context.

  27. MFT Admin App Settings (/mft-admin/app-settings)

    • Undefined (Undefined)
    • Get / List Alerts (2000)Explanation: Describes permissions for managing MFT admin app settings and accessing alerts.

  28. Search Test (/search/test)

    • Global Search (1400)
    • Get / List Alerts (2000)Explanation: Outlines permissions related to global search functionality and accessing alerts in the system.

This overview provides insights into the permissions and capabilities associated with system administration and configuration settings.