{"info":{"_postman_id":"244c5280-5479-4b7d-abb9-41c0549cffc1","name":"AppOmni API","description":"
AppOmni API routes can be accessed using API tokens created and managed from Settings > API Settings in your AppOmni instance.
\nTo start using this Postman Collection, please update the required variables:
\nAppOmni Instance should be set to your AppOmni Instance subdomain - e.g. acme if you login to AppOmni via acme.appomni.com.
AppOmni API Token should be set to the Access Token you have configured in API Settings.
\nPlease Note: Routes and functionality not documented here are not guaranteed to be supported.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"45135595","collectionId":"244c5280-5479-4b7d-abb9-41c0549cffc1","publishedId":"2sBXc7Mjib","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-04T17:15:27.000Z"},"item":[{"name":"Monitored Services","item":[{"name":"List monitored services","id":"e4d77015-9a81-45be-a614-fd393f394b31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/","description":"Returns a paginated list of all Monitored Services configured in your environment.
\nEach entry includes core metadata such as name, service type, score, status flags, and connection state. Supports filtering and annotations via query parameters.
\nAnnotations schema
\nWhen the query parameter annotations=1 is included in the request, each Monitored Service object in the results array includes the following read-only, computed fields:
\n","urlObject":{"protocol":"https","path":["api","v1","core","monitoredservice",""],"host":["[your_subdomain]","appomni","com"],"query":[{"disabled":true,"description":{"content":"Integer; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"limit=50"},{"disabled":true,"description":{"content":"Integer; Number of items to skip (pagination)
\n","type":"text/plain"},"key":"offset","value":"offset=0"},{"disabled":true,"description":{"content":"Integer; Annotate services with read-only computed fields (see Annotations)
\n","type":"text/plain"},"key":"annotations","value":"annotations=1"},{"disabled":true,"description":{"content":"Boolean; Filter by integration connection state
\n","type":"text/plain"},"key":"integration_connected","value":"integration_connected=true"},{"disabled":true,"description":{"content":"Boolean; Filter by ingest completion state
\n","type":"text/plain"},"key":"initial_ingest_complete","value":"initial_ingest_complete=true"},{"disabled":true,"description":{"content":"Integer; Score greater than or equal to value
\n","type":"text/plain"},"key":"score__gte","value":"score__gte=50"},{"disabled":true,"description":{"content":"Integer; Score less than or equal to value
\n","type":"text/plain"},"key":"score__lte","value":"score__lte=100"},{"disabled":true,"description":{"content":"String; Search query
\n","type":"text/plain"},"key":"search","value":"search=admin"},{"disabled":true,"description":{"content":"String; Filter by service type
\n","type":"text/plain"},"key":"service_type","value":"service_type=box"}],"variable":[]}},"response":[{"id":"664ddb8a-15c7-419b-b617-78b8ccc6b233","name":"List Monitored Services","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":"https://acme.appomni.com/api/v1/core/monitoredservice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 6,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1,\n \"created\": \"2025-03-10T20:10:45.013060Z\",\n \"created_by\": 1,\n \"modified\": \"2025-04-08T15:41:32.406310Z\",\n \"modified_by\": null,\n \"owner\": 1,\n \"name\": \"Box DE\",\n \"external_id\": null,\n \"service_id\": \"285415710\",\n \"service_type\": \"box\",\n \"service_type_slug\": \"box\",\n \"description\": null,\n \"enforcement_mode\": \"monitor\",\n \"integration_connected\": true,\n \"monitoring_reqs_satisfied\": true,\n \"has_warnings\": false,\n \"has_errors\": false,\n \"initial_ingest_complete\": true,\n \"is_archived\": false,\n \"tags\": [1],\n \"baseline_policies\": [],\n \"detection_ingest_enabled\": true,\n \"score\": 100\n },\n ...,\n ]\n}"}],"_postman_id":"e4d77015-9a81-45be-a614-fd393f394b31"},{"name":"Monitored service detail","id":"45b5c785-52b6-4c19-abcd-5ed41e450d39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/{serviceType}/{serviceType}org/{id}","description":"Returns detailed metadata, sync status, user stats, preferences, and policy posture for a single monitored service instance by service type and org ID.
\nIf using developer platform modules, run the following call instead: GET api/v1/core/custom/custommonitoredservice/{id}
\nProvides users with information pertaining to the status of syncing various data types to AppOmni from their SaaS application.
\nFor example, if a sync hadn't started or finished for a few days, AppOmni would be operating on data from whenever the last data sync completed successfully, and could be missing important configuration changes or repo additions that occurred during that interim period.
\nFor developer platform modules, run:
GET api/v1/custom/custommonitoredservice/{id}/sync_timestamps/
Request an on-demand resync of the provided data type.
\nAffected by rate_limits and availability. Data syncs are enqueued. Only syncs with ‘allow_adhoc_refresh: true’ and ‘rate_limited: false’ will be requested.
\nFor the payload, specify the timestamp_field to resync.
\nFor developer platform module types, run:
POST - api/v1/{serviceType}/{serviceType}org/{id}/request_adhoc_sync/.
Request on-demand resyncs of all data types meeting the required criteria.
\nNo payload is necessary.
\nUtilizes the same schema as Request Sync Data Type.
\nFor developer platform module types, run:
POST - api/v1/custom/custommonitoredservice/{id}/request_adhoc_all_sync/
Each sync event for a monitored service is a job that requires authentication to push data to AppOmni. An ingest token is the authentication that makes the sync secure. You might require the ingest token to make direct API calls when you're using the AppOmni Developer Platform. Rotating a token immediately replaces the ingest token with a new value. Any existing integrations using the old/previous ingest token cease to work.
\nOnly users with Admin or Service Onboarder roles are able to use this endpoint. Users without permission will return a 403.
\nRun the \"List Monitored Services\" endpoint to obtain the ms_id variable.
\nThere is no payload required for this endpoint.
\nEach sync event for a monitored service is a job that requires authentication to push data to AppOmni. An ingest token is the authentication that makes the sync secure. You might require the ingest token to make direct API calls when you're using the AppOmni Developer Platform.
\nOnly users with Admin or Service Onboarder roles are able to use this endpoint. Users without permission will return a 403.
\nRun the \"List Monitored Services\" endpoint to obtain the ms_id variable.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"Integer; Number of results to skip for pagination
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field(s) to sort results by (prefix with - for descending)
\n","type":"text/plain"},"key":"ordering","value":"policy_type,name"},{"description":{"content":"Boolean; Filter by reference policies
\n","type":"text/plain"},"key":"is_reference","value":"true"}],"variable":[]}},"response":[{"id":"96291bce-19c4-468b-898e-6ec72e345a9f","name":"Get Policies","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/policy/?limit=25&offset=0&ordering=policy_type,name&is_reference=true","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","policy",""],"query":[{"key":"limit","value":"25","description":"Integer; Maximum number of results to return"},{"key":"offset","value":"0","description":"Integer; Number of results to skip for pagination"},{"key":"ordering","value":"policy_type,name","description":"String; Field(s) to sort results by (prefix with - for descending)"},{"key":"is_reference","value":"true","description":"Boolean; Filter by reference policies"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"count\": 64,\n \"next\": \"https:/[your-domain].appomni.com/api/v1/core/policy/?is_reference=true&limit=25&offset=25&ordering=policy_type%2Cname\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 591391,\n \"created\": \"2024-02-20T18:48:37.189165Z\",\n \"modified\": \"2024-02-20T19:05:43.282655Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"453a6236-79eb-4cf6-b38b-3cfcaf7b3277\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Auth0: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"auth0\",\n \"policy_type_slug\": \"auth0\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591392,\n \"created\": \"2024-02-20T18:48:49.386304Z\",\n \"modified\": \"2024-02-20T19:05:47.253582Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"8b85edc5-d57b-4645-a8d8-c5fd3baa5dde\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Crowdstrike: Baseline Posture Permissions\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"crowdstrike\",\n \"policy_type_slug\": \"crowdstrike\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591393,\n \"created\": \"2024-02-20T18:48:53.573669Z\",\n \"modified\": \"2024-02-20T19:04:10.081083Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"264733ca-a1a8-42b6-9680-a8d378be7407\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Crowdstrike: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"crowdstrike\",\n \"policy_type_slug\": \"crowdstrike\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591385,\n \"created\": \"2024-02-20T18:47:40.301220Z\",\n \"modified\": \"2024-02-20T19:05:52.215367Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"37dae3e3-23fe-4250-a6d8-a00698aef6de\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Duo : Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"duo\",\n \"policy_type_slug\": \"duo\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591432,\n \"created\": \"2024-02-20T19:02:25.937865Z\",\n \"modified\": \"2024-02-20T19:05:54.917348Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"282bc037-2739-4d4d-a294-1cb164ba5c14\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"GitHub: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"github\",\n \"policy_type_slug\": \"github\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591433,\n \"created\": \"2024-02-20T19:02:35.857015Z\",\n \"modified\": \"2024-02-20T19:04:13.323552Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"b656d02f-3833-442c-ad18-129ace97c1a3\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Github: ISO 27001:2013 Compliance Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"github\",\n \"policy_type_slug\": \"github\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591434,\n \"created\": \"2024-02-20T19:02:38.868938Z\",\n \"modified\": \"2024-02-20T19:04:14.339207Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"0e58e498-774a-4d92-bab4-5c8376c77a2f\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Github: NIST CSF v1.1 Compliance Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"github\",\n \"policy_type_slug\": \"github\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591435,\n \"created\": \"2024-02-20T19:02:45.322584Z\",\n \"modified\": \"2024-02-20T19:04:15.370742Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"57fb4d39-de50-4691-a110-51f16fe4a179\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Github: SOC 2 Type 1 Compliance Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"github\",\n \"policy_type_slug\": \"github\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591420,\n \"created\": \"2024-02-20T19:01:06.035410Z\",\n \"modified\": \"2024-02-20T19:05:58.715594Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"882d1f9c-f7dd-4f6e-8321-c602dffca0d2\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"GitLab: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"gitlab\",\n \"policy_type_slug\": \"gitlab\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591430,\n \"created\": \"2024-02-20T19:02:15.790449Z\",\n \"modified\": \"2024-02-20T19:06:01.988812Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"8be8b1db-ad58-416a-bfa5-78cb23987c1b\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Google Workspace: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"gsuite\",\n \"policy_type_slug\": \"gsuite\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591431,\n \"created\": \"2024-02-20T19:02:18.891486Z\",\n \"modified\": \"2024-02-20T19:04:18.500558Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"c91972e3-10f8-4714-b367-b2613e81180e\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Google Workspace: Posture Permissions\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"gsuite\",\n \"policy_type_slug\": \"gsuite\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591439,\n \"created\": \"2024-02-20T19:03:24.509504Z\",\n \"modified\": \"2024-02-20T19:06:06.227821Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"3e928803-d1f2-48ef-9914-7ec3c2dfd207\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Jamf: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"jamf\",\n \"policy_type_slug\": \"jamf\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591429,\n \"created\": \"2024-02-20T19:02:09.616323Z\",\n \"modified\": \"2024-02-20T19:06:09.362261Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"f12c3bcf-0ebd-49a0-9c2f-6a17f91be998\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"JumpCloud: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"jumpcloud\",\n \"policy_type_slug\": \"jumpcloud\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591436,\n \"created\": \"2024-02-20T19:02:49.154081Z\",\n \"modified\": \"2024-02-20T19:04:30.478349Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"7475f901-6551-428a-b00d-e1395bf471ea\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"NetSuite: Accounting Policy\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"netsuite\",\n \"policy_type_slug\": \"netsuite\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591437,\n \"created\": \"2024-02-20T19:02:57.843269Z\",\n \"modified\": \"2024-02-20T19:06:18.538099Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"5945ca8e-8f30-4b8f-afbc-fb72715e39e0\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"NetSuite: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"netsuite\",\n \"policy_type_slug\": \"netsuite\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591409,\n \"created\": \"2024-02-20T18:56:31.188611Z\",\n \"modified\": \"2024-02-20T19:04:21.551665Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"179f3d35-b0a0-427d-bfb0-8746369c6834\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: Azure AD Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 593401,\n \"created\": \"2024-02-23T18:31:15.850018Z\",\n \"modified\": \"2024-02-23T18:34:46.754343Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"e5cb6646-bb2e-426e-95f0-952dfb087641\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 593421,\n \"created\": \"2024-02-23T18:51:43.369928Z\",\n \"modified\": \"2024-02-23T18:53:31.769905Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"3fc0a205-db81-43d7-b7f2-b59c6404eab2\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: CIS Benchmark v.1.3.0 Compliance Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 593422,\n \"created\": \"2024-02-23T18:51:59.868975Z\",\n \"modified\": \"2024-02-23T18:53:33.108293Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"3b882af9-6f69-4816-9938-fde400537368\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: CIS Benchmark v.2.0.0 Policy\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 593418,\n \"created\": \"2024-02-23T18:51:14.995905Z\",\n \"modified\": \"2024-02-23T18:53:34.832275Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"5b07f05e-ba51-4956-bb24-79e7c0fc9265\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: ISO 27001:2013 Compliance Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 593420,\n \"created\": \"2024-02-23T18:51:29.101177Z\",\n \"modified\": \"2024-02-23T18:53:36.241090Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"2983d961-6323-4703-8601-7e00b1fa96cd\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: NIST CSF v1.1 Compliance Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591415,\n \"created\": \"2024-02-20T18:58:19.140893Z\",\n \"modified\": \"2024-02-20T19:04:27.373674Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"9a874993-f7f4-4514-8e9d-103f71a7fd72\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: Posture Permissions\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591416,\n \"created\": \"2024-02-20T18:58:34.788707Z\",\n \"modified\": \"2024-02-20T19:04:28.440364Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"fe4ec194-e81e-422e-aba1-42d67610c7be\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: SOC 2 Compliance Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591417,\n \"created\": \"2024-02-20T18:58:43.217878Z\",\n \"modified\": \"2024-02-20T19:04:29.527051Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"e13e6af1-0188-4629-958a-ee0a64cebe0c\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Microsoft 365: SOX Compliance Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"o365\",\n \"policy_type_slug\": \"o365\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 591427,\n \"created\": \"2024-02-20T19:01:51.624637Z\",\n \"modified\": \"2024-02-20T19:06:21.982473Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"a73d0f00-8ee2-4d0a-a2c4-75adbe6b2a17\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Okta: Baseline Classic Engine Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"okta\",\n \"policy_type_slug\": \"okta\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n }\n ]\n}"}],"_postman_id":"dbcc2a64-8366-40ba-8dac-3fa5ef9b8ffa"},{"name":"Get Policy","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"f75fc04e-0853-41e0-84fa-ca349cc6bb5e"}}],"id":"3def6879-b9df-4b8b-a75b-c5c28ac510f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/policy/:id/","description":"Policy ID
\n","type":"text/plain"},"type":"any","value":"{{policy_id}}","key":"id"}]}},"response":[{"id":"a4dfb6f4-ba15-44aa-b5d5-6724004785dc","name":"Get Policy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/policy/:id/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","policy",":id",""],"variable":[{"key":"id","value":"{{policy_id}}","description":"Policy ID"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 591391,\n \"created\": \"2024-02-20T18:48:37.189165Z\",\n \"modified\": \"2024-02-20T19:05:43.282655Z\",\n \"external_id\": null,\n \"created_by\": 1526,\n \"modified_by\": null,\n \"owner\": 1526,\n \"internal_id\": \"453a6236-79eb-4cf6-b38b-3cfcaf7b3277\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Auth0: Baseline Posture Settings\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"auth0\",\n \"policy_type_slug\": \"auth0\",\n \"custom_service_type\": null,\n \"installed_service_type\": null,\n \"tags\": [],\n \"is_reference\": true,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null,\n \"default_action\": null,\n \"asset_restrictions\": [],\n \"pers_fresh_ttl\": \"1 00:00:00\",\n \"notification_frequency\": \"immediate\",\n \"extra_notification_emails\": [],\n \"notif_env_filter_tags\": [],\n \"ext_services_enabled\": [],\n \"ext_services_configs\": {},\n \"is_runnable\": false,\n \"implements_classification_configuration\": null,\n \"open_issues_count\": 0,\n \"active_perspectives_count\": 0,\n \"interval_total_seconds\": 28800,\n \"basic_notifs_enabled\": false,\n \"enabled_notifs\": [],\n \"has_rule_requiring_auth\": false,\n \"bounding_classifications\": [],\n \"workflows\": [],\n \"last_policy_assessment_failure_infos\": [],\n \"last_policy_assessment_warnings\": [],\n \"target_tags\": [],\n \"is_obj_comprehensive\": false,\n \"is_field_comprehensive\": false,\n \"rule_type_counts\": {\n \"config.org.sys_setting\": {\n \"rules\": 23,\n \"exceptions\": 0,\n \"by_target_type\": {}\n }\n },\n \"not_runnable_reason\": \"missing_monitored_service\",\n \"pending_assessment_started_on\": null\n}"}],"_postman_id":"3def6879-b9df-4b8b-a75b-c5c28ac510f1"},{"name":"Start Policy Scan","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"100cd231-2579-4967-aa06-55994fe00c41"}}],"id":"ccae3470-1578-4c77-9de7-1a3b09072672","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/policy/:id/scan/","description":"POST request to begin policy scan.
\nPolicy ID to scan
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"69992039-7140-4b9e-8aaa-28fab0677efa","name":"Start Policy Scan","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://acme.appomni.com/api/v1/core/policy/:id/scan/","protocol":"https","host":["acme","appomni","com"],"path":["api","v1","core","policy",":id","scan",""],"variable":[{"key":"id","value":"12345","description":"Policy ID to scan"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"external_id\": \"39b9cf55-c2f0-476d-84e3-9ae32722db53\"\n}"}],"_postman_id":"ccae3470-1578-4c77-9de7-1a3b09072672"},{"name":"Check Policy Scan Status and Results","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"916834cc-78a2-44b3-a90b-174177ba295d"}}],"id":"d4fa4521-e720-4493-acee-69084ac0ca2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/policyassessment/check_status/","description":"String; Filter by external id
\n","type":"text/plain"},"key":"external_id","value":"{{external_id_value}}"}],"variable":[]}},"response":[{"id":"0c1a7e96-08b3-40fe-9186-b32655cbf4df","name":"Scan Incomplete","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://acme.appomni.com/api/v1/core/policyassessment/check_status?external_id=39b9cf55-c2f0-476d-84e3-9ae32722db53","protocol":"https","host":["acme","appomni","com"],"path":["api","v1","core","policyassessment","check_status"],"query":[{"key":"external_id","value":"39b9cf55-c2f0-476d-84e3-9ae32722db53","description":"String; Filter by external id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"external_id\": \"39b9cf55-c2f0-476d-84e3-9ae32722db53\",\n \"policy_id\": 136740,\n \"complete\": false\n}"},{"id":"c343d489-f106-4951-8436-68e759aecfce","name":"Scan Complete","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://acme.appomni.com/api/v1/core/policyassessment/check_status?external_id=39b9cf55-c2f0-476d-84e3-9ae32722db53","protocol":"https","host":["acme","appomni","com"],"path":["api","v1","core","policyassessment","check_status"],"query":[{"key":"external_id","value":"39b9cf55-c2f0-476d-84e3-9ae32722db53","description":"String; Filter by external id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"external_id\": \"39b9cf55-c2f0-476d-84e3-9ae32722db53\",\n \"policy_id\": 12345,\n \"complete\": true,\n \"completion_status\": \"success\",\n \"success\": true,\n \"open_issues\": 1,\n \"new_issues\": 0,\n \"reopened_issues\": 0\n}"}],"_postman_id":"d4fa4521-e720-4493-acee-69084ac0ca2a"},{"name":"List Open Policy Issues","id":"218123c9-118f-4d36-bb5c-eeea177bf97a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/ruleevent/","description":"All parameters are optional. This request with no filtering parameters will return all open Policy Issues.
\n","urlObject":{"protocol":"https","path":["api","v1","core","ruleevent",""],"host":["[your_subdomain]","appomni","com"],"query":[{"disabled":true,"description":{"content":"Array[String]; Filter by policy values
\n","type":"text/plain"},"key":"policy__in","value":"[{value1},{value2}]"},{"disabled":true,"description":{"content":"Array[String]; Filter by service org values
\n","type":"text/plain"},"key":"service_org__in","value":"[{value1},{value2}]"},{"disabled":true,"description":{"content":"Array[String]; Filter by service org tags values
\n","type":"text/plain"},"key":"service_org__tags__in","value":"[{tag1_id},{tag2_id}]"},{"disabled":true,"description":{"content":"Array[String]; Filter by service org type values
\n","type":"text/plain"},"key":"service_org__type__in","value":"[{value1},{value2}]"}],"variable":[]}},"response":[],"_postman_id":"218123c9-118f-4d36-bb5c-eeea177bf97a"},{"name":"List Compliance Controls for Policy Rule","id":"dbece7f4-39be-4c89-ba8c-b56adad6af2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/compliance/evaluated_controls/?rule_event_id=issue_id","description":"Filter results using the rule_event_id query parameter
\nCommon compliance_status values: \"compliant\", \"non_compliant\", \"not_applicable\", \"pending\"
\nArray[String]; Filter by compliance framework name values
\n","type":"text/plain"},"key":"compliance_framework_name__in","value":"[{value1},{value2}]"},{"disabled":true,"description":{"content":"String; Filter by compliant
\n","type":"text/plain"},"key":"compliant","value":"{{compliant_value}}"},{"description":{"content":"String; Filter by rule event id
\n","type":"text/plain"},"key":"rule_event_id","value":"issue_id"},{"disabled":true,"description":{"content":"Array[String]; Filter by service org values
\n","type":"text/plain"},"key":"service_org__in","value":"[{value1},{value2}]"},{"disabled":true,"description":{"content":"Array[String]; Filter by service types
\n","type":"text/plain"},"key":"service_type__in","value":"[\"sfdc\",\"m365\"]"}],"variable":[]}},"response":[],"_postman_id":"dbece7f4-39be-4c89-ba8c-b56adad6af2b"},{"name":"Assign Monitored Services to Policy","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"b97601d8-2132-4c24-993f-32b3476fa7a0"}}],"id":"c672b192-58a4-4a7e-9f7a-5e1b3bf53215","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"monitored_services\": [monitored_service_id, ...]}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/policy/:id/","description":"Assign monitored services to a Posture Policy in order to scan those with the policy. Note that the monitored services must be of the same service type as the policy.
\nThis endpoint updates the monitored services assigned to a policy
\nReturns the updated policy object
\nUse GET /api/v1/core/policy/{id}/ to retrieve current assignments
\nPolicy ID to modify
\n","type":"text/plain"},"type":"any","value":"{{policy_id}}","key":"id"}]}},"response":[],"_postman_id":"c672b192-58a4-4a7e-9f7a-5e1b3bf53215"},{"name":"Assign Target Tags to Policy","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"54bd5e82-d9b5-47e7-b156-63d7854cf339"}}],"id":"447ec00d-a6f5-4783-a5c6-abd4e7a6ffa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"target_tags\": [tag_id, ...]}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/policy/:id/","description":"By assigning Target Tags to a Posture Policy you are able to design a policy that will target all monitored services that are tagged with the tags specified as Target Tags at scan time.
\nNote that of the monitored services tagged with the policy's Target Tags, only the monitored services that are the same service type as the policy will be collected for scanning.
\nThis endpoint updates the tags assigned to a policy
\nTags are used to target specific resources for policy evaluation
\nReturns the updated policy object
\nPolicy ID to modify
\n","type":"text/plain"},"type":"any","value":"{{policy_id}}","key":"id"}]}},"response":[],"_postman_id":"447ec00d-a6f5-4783-a5c6-abd4e7a6ffa7"},{"name":"Retrieve Posture Policies","id":"e2d3942d-a761-43b9-ae65-666415580158","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/policy/?policy_type={monitored_service_config}","description":"Returns a list of posture policies configured for the specified monitored service(s)
\nString; Filter by policy_type
\n","type":"text/plain"},"key":"policy_type","value":"{monitored_service_config}"}],"variable":[]}},"response":[{"id":"599de248-4ad4-4a40-a9ce-580b8b81634c","name":"Retrieve Posture Policies","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain]/api/v1/core/policy/?filter.policyType=monitored_service_config","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","core","policy",""],"query":[{"key":"filter.policyType","value":"monitored_service_config","description":"String; Filter by filter.policyType"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 330516,\n \"created\": \"2022-12-05T22:03:58.321175Z\",\n \"modified\": \"2023-03-24T21:02:10.994053Z\",\n \"external_id\": null,\n \"created_by\": 3362,\n \"modified_by\": 3362,\n \"owner\": 3362,\n \"internal_id\": \"322bb353-70dc-4cc5-b7ba-5ab292460231\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"ds-1\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"sfdc\",\n \"policy_type_slug\": \"sfdc\",\n \"custom_service_type\": null,\n \"tags\": [],\n \"is_reference\": false,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [\n 107310\n ],\n \"monitored_services\": [],\n \"role\": \"security\",\n \"mode\": \"whitelist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"12:00:00\",\n \"last_run\": \"2023-03-24T20:04:16.823492Z\",\n \"last_scheduled\": \"2023-03-24T20:02:33.530066Z\",\n \"last_completed_scan\": \"2023-03-24T20:04:16.823492Z\",\n \"last_policy_assessment_status\": \"success\",\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 1,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 330517,\n \"created\": \"2022-12-05T22:08:16.525753Z\",\n \"modified\": \"2023-03-24T21:38:33.623855Z\",\n \"external_id\": \"212609\",\n \"created_by\": 3362,\n \"modified_by\": 3362,\n \"owner\": 3362,\n \"internal_id\": \"1855824b-49f4-4b35-bc5c-a838ae29c601\",\n \"baseline_policy_for_tenant\": true,\n \"name\": \"Salesforce: ISO 27001:2013\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"sfdc\",\n \"policy_type_slug\": \"sfdc\",\n \"custom_service_type\": null,\n \"tags\": [],\n \"is_reference\": false,\n \"from_reference_policy\": 212609,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [\n 26063\n ],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"01:00:00\",\n \"last_run\": \"2023-03-24T21:26:56.912034Z\",\n \"last_scheduled\": \"2023-03-24T21:26:38.374056Z\",\n \"last_completed_scan\": \"2023-03-24T21:26:56.912034Z\",\n \"last_policy_assessment_status\": \"success\",\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 1,\n \"monitored_services_count\": 1,\n \"risk_statistics\": {\n \"risk_score\": 0,\n \"risk_levels\": [\n {\n \"name\": \"Informational\",\n \"risk_count\": 2,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Low\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Medium\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"High\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Critical\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n }\n ],\n \"max_risks_only\": {\n \"risk_score\": 0,\n \"risk_levels\": [\n {\n \"name\": \"Informational\",\n \"risk_count\": 2,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Low\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Medium\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"High\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Critical\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n }\n ],\n \"max_risks_only\": null\n }\n },\n \"external_data\": null\n },\n {\n \"id\": 330518,\n \"created\": \"2022-12-05T22:09:06.094268Z\",\n \"modified\": \"2022-12-05T22:09:06.094288Z\",\n \"external_id\": \"166344\",\n \"created_by\": 3362,\n \"modified_by\": null,\n \"owner\": 3362,\n \"internal_id\": \"6ab7f626-0dfb-423c-8eb8-e42b520bb226\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Salesforce: SOC 2 Type 1\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"sfdc\",\n \"policy_type_slug\": \"sfdc\",\n \"custom_service_type\": null,\n \"tags\": [],\n \"is_reference\": false,\n \"from_reference_policy\": 166344,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"01:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 372222,\n \"created\": \"2023-02-16T15:59:04.069054Z\",\n \"modified\": \"2023-02-16T16:01:29.533521Z\",\n \"external_id\": null,\n \"created_by\": 3362,\n \"modified_by\": 3362,\n \"owner\": 3362,\n \"internal_id\": \"098206d2-6afb-4c9f-be4c-efde286fdd71\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"test-day\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"sfdc\",\n \"policy_type_slug\": \"sfdc\",\n \"custom_service_type\": null,\n \"tags\": [],\n \"is_reference\": false,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [\n 107310\n ],\n \"monitored_services\": [],\n \"role\": \"security\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"12:00:00\",\n \"last_run\": \"2023-03-24T20:04:16.823492Z\",\n \"last_scheduled\": \"2023-03-24T20:02:33.530066Z\",\n \"last_completed_scan\": \"2023-03-24T20:04:16.823492Z\",\n \"last_policy_assessment_status\": \"success\",\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 1,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 372224,\n \"created\": \"2023-02-16T16:04:34.255911Z\",\n \"modified\": \"2023-03-24T18:30:01.471226Z\",\n \"external_id\": null,\n \"created_by\": 3362,\n \"modified_by\": 3362,\n \"owner\": 3362,\n \"internal_id\": \"560622dc-a6e6-4b07-aaa7-457231165bda\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"smm-test\",\n \"description\": \"{\\\"ops\\\":[{\\\"insert\\\":\\\"testing 123\\\\n\\\"}]}\",\n \"active\": true,\n \"policy_type\": \"sfdc\",\n \"policy_type_slug\": \"sfdc\",\n \"custom_service_type\": null,\n \"tags\": [],\n \"is_reference\": false,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [\n 26063\n ],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": \"2023-03-24T18:29:39.679356Z\",\n \"last_scheduled\": \"2023-03-24T18:29:30.320152Z\",\n \"last_completed_scan\": \"2023-03-24T18:29:39.679356Z\",\n \"last_policy_assessment_status\": \"success\",\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 1,\n \"monitored_services_count\": 1,\n \"risk_statistics\": {\n \"risk_score\": 0,\n \"risk_levels\": [\n {\n \"name\": \"Informational\",\n \"risk_count\": 1,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Low\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Medium\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"High\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Critical\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n }\n ],\n \"max_risks_only\": {\n \"risk_score\": 0,\n \"risk_levels\": [\n {\n \"name\": \"Informational\",\n \"risk_count\": 1,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Low\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Medium\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"High\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n },\n {\n \"name\": \"Critical\",\n \"risk_count\": 0,\n \"max_risk_score\": 0\n }\n ],\n \"max_risks_only\": null\n }\n },\n \"external_data\": null\n },\n {\n \"id\": 390027,\n \"created\": \"2023-03-20T19:29:11.152396Z\",\n \"modified\": \"2023-03-20T19:31:03.208381Z\",\n \"external_id\": null,\n \"created_by\": 9153,\n \"modified_by\": null,\n \"owner\": 9153,\n \"internal_id\": \"640c9987-efa4-43ae-8106-2c2aade3ae04\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Test policy for workday\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"workday\",\n \"policy_type_slug\": \"workday\",\n \"custom_service_type\": null,\n \"tags\": [],\n \"is_reference\": false,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"monitored_service_config\",\n \"mode\": \"blacklist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"08:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 392490,\n \"created\": \"2023-03-24T20:45:28.212464Z\",\n \"modified\": \"2023-03-24T20:45:43.373981Z\",\n \"external_id\": null,\n \"created_by\": 3362,\n \"modified_by\": null,\n \"owner\": 3362,\n \"internal_id\": \"bf6f7d22-2be0-4c26-a9cf-9da2344f5155\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Policy test\",\n \"description\": null,\n \"active\": true,\n \"policy_type\": \"sfdc\",\n \"policy_type_slug\": \"sfdc\",\n \"custom_service_type\": null,\n \"tags\": [],\n \"is_reference\": false,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [],\n \"monitored_services\": [],\n \"role\": \"security\",\n \"mode\": \"whitelist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"12:00:00\",\n \"last_run\": null,\n \"last_scheduled\": null,\n \"last_completed_scan\": null,\n \"last_policy_assessment_status\": null,\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 0,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n },\n {\n \"id\": 392491,\n \"created\": \"2023-03-24T20:46:54.296919Z\",\n \"modified\": \"2023-03-24T20:51:32.002703Z\",\n \"external_id\": null,\n \"created_by\": 3362,\n \"modified_by\": 3362,\n \"owner\": 3362,\n \"internal_id\": \"3316651b-f505-4917-9921-fd7db9fb0ced\",\n \"baseline_policy_for_tenant\": false,\n \"name\": \"Functional policy test\",\n \"description\": \"{\\\"ops\\\":[{\\\"insert\\\":\\\"Test for API response\\\\n\\\"}]}\",\n \"active\": true,\n \"policy_type\": \"sfdc\",\n \"policy_type_slug\": \"sfdc\",\n \"custom_service_type\": null,\n \"tags\": [],\n \"is_reference\": false,\n \"from_reference_policy\": null,\n \"notify_pol_owner\": false,\n \"notify_ms_recips\": false,\n \"notify_user\": null,\n \"service_groups\": [\n 107310\n ],\n \"monitored_services\": [],\n \"role\": \"functional\",\n \"mode\": \"whitelist\",\n \"issue_handling\": \"notify\",\n \"scheduled\": true,\n \"pol_interval\": \"12:00:00\",\n \"last_run\": \"2023-03-24T20:53:08.344454Z\",\n \"last_scheduled\": \"2023-03-24T20:51:33.595679Z\",\n \"last_completed_scan\": \"2023-03-24T20:53:08.344454Z\",\n \"last_policy_assessment_status\": \"success\",\n \"last_policy_assessment_error_code\": null,\n \"targets_count\": 1,\n \"monitored_services_count\": 0,\n \"risk_statistics\": {},\n \"external_data\": null\n }\n]"}],"_postman_id":"e2d3942d-a761-43b9-ae65-666415580158"},{"name":"Retrieve Selected Posture Policy Rule Options","id":"f65d701d-9dce-49db-a074-ee4197898feb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/:service_type/rule/?policy={policy_id}","description":"Integer; Filter by specific policy ID
\n","type":"text/plain"},"key":"policy","value":"{policy_id}"}],"variable":[{"description":{"content":"SaaS application identifier
\n","type":"text/plain"},"type":"any","value":null,"key":"service_type"}]}},"response":[{"id":"3ecb5600-be73-4994-a377-a19f2fef03af","name":"Retrieve Selected Posture Policy Rule Options","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/:service_type/rule/?policy={{policy_id}}","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1",":service_type","rule",""],"query":[{"key":"policy","value":"{{policy_id}}","description":"Integer; Filter by specific policy ID"}],"variable":[{"key":"service_type","value":null,"description":"The SaaS application or AppOmni service"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"rule_options\": [\n {\n \"sys_value\": \"config.sys_setting.value\",\n \"label\": \"System Setting\",\n \"description\": \"Detect when a System Setting has been given a specified value\",\n \"binary_type\": false,\n \"md_kind\": \"sfdc.scp.rule.criteria.config.sys_setting.value\",\n \"disabled\": false,\n \"disabled_reason\": null,\n \"optgroup\": null,\n \"sspm_category\": \"system_config\",\n \"sspm_category_label\": \"System Configuration\",\n \"exception_handling\": \"convert_only\",\n \"options_support_service_specific_categories\": false\n },\n {\n \"sys_value\": \"config.profile.functional\",\n \"label\": \"Profile Setting\",\n \"description\": \"Detect when a Profile Setting has been assigned a specified value\",\n \"binary_type\": false,\n \"md_kind\": \"sfdc.scp.rule.criteria.config.profile.functional\",\n \"disabled\": false,\n \"disabled_reason\": null,\n \"optgroup\": \"Profile\",\n \"sspm_category\": \"rbac_settings\",\n \"sspm_category_label\": \"RBAC Element Settings\",\n \"exception_handling\": \"convert_only\",\n \"options_support_service_specific_categories\": false\n },\n ]\n}"}],"_postman_id":"f65d701d-9dce-49db-a074-ee4197898feb"},{"name":"Retrieve Rules for Policy","id":"d1014d79-8d87-4855-8009-eab45dd8e386","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/{policy_type}/rule/?policy={policy_id}","description":"Returns a list of rules configured for a posture policy, including rule_id(s) needed for other endpoints.
\nAllows users to update the details of the specified rule for a SaaS applicaiton in AppOmni.
\nWARNING
If you use the \"Update Policy Rule\" API endpoint to add NOTES to a Policy Rule, rather than using the UI method defined on the \"Manage Policy Rule\" page in the documentation portal, you will NOT be able to EDIT or DELETE the content you add.
NOTE: You may update tags by sending the payload below plus the additional tags payload:
\n\n\n{ \"tags\": [ 17367 ] }
\n
SaaS application
\n","type":"text/plain"},"type":"any","value":null,"key":"service_type"},{"description":{"content":"Unque identifier for a rule
\n","type":"text/plain"},"type":"any","value":null,"key":"rule_id"}]}},"response":[{"id":"cff17087-0ccb-49dc-be32-3f3280fcaf56","name":"Update Policy Rule","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"criteria\": {\n \"md_version\": 1,\n \"md_kind\": \"sfdc.scp.rule.criteria.config.profile.all_setting\",\n \"setting_name\": \"permissionsapienabled\",\n \"polarity\": \"IS\",\n \"values\": [\n \"false\"\n ],\n \"value_labels\": [\n \"false\"\n ],\n \"noop_rule\": false\n }\n}"},"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/:service_type/rule/:rule_id/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1",":service_type","rule",":rule_id",""],"variable":[{"key":"service_type","value":null},{"key":"rule_id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 443195,\n \"created\": \"2022-12-05T22:11:03.624785Z\",\n \"modified\": \"2023-03-25T01:05:37.487405Z\",\n \"external_id\": \"195014\",\n \"created_by\": 3362,\n \"modified_by\": 3362,\n \"owner\": 3362,\n \"rule_type\": \"config.sys_setting.value\",\n \"unique_id\": \"231ead69-d0af-4bce-a082-2fd8e8d5b2e6\",\n \"policy\": 330517,\n \"action\": null,\n \"status\": \"active\",\n \"expires\": null,\n \"name\": \"Password complexity requirement Org Setting Rule\",\n \"system_description\": {\n \"description\": \"All Profiles' setting '{setting}' {polarity} {values}\",\n \"placeholders\": {\n \"setting\": [\n {\n \"label\": \"API Enabled\",\n \"api_name\": \"permissionsapienabled\",\n \"api_id\": null,\n \"md_version\": 1,\n \"md_kind\": \"core.rule.criteria.translation_placeholder\"\n }\n ],\n \"polarity\": [\n {\n \"label\": \"must be\",\n \"api_name\": null,\n \"api_id\": null,\n \"md_version\": 1,\n \"md_kind\": \"core.rule.criteria.translation_placeholder\"\n }\n ],\n \"values\": [\n {\n \"label\": \"false\",\n \"api_name\": \"false\",\n \"api_id\": null,\n \"md_version\": 1,\n \"md_kind\": \"core.rule.criteria.translation_placeholder\"\n }\n ]\n },\n \"md_version\": 1,\n \"md_kind\": \"core.rule.criteria.translation\"\n },\n \"description\": null,\n \"criteria\": {\n \"md_version\": 1,\n \"md_kind\": \"sfdc.scp.rule.criteria.config.profile.all_setting\",\n \"setting_name\": \"permissionsapienabled\",\n \"polarity\": \"IS\",\n \"values\": [\n \"false\"\n ],\n \"value_labels\": [\n \"false\"\n ],\n \"noop_rule\": false\n },\n \"has_child_rules\": false,\n \"rule_posture_category\": \"system_config\",\n \"rule_posture_subcategory\": \"password_and_session_settings\",\n \"service_specific_category\": null,\n \"evaluation_errors\": [],\n \"tags\": [\n 87172\n ],\n \"mode\": \"blacklist\",\n \"compliance_controls\": [\n 126,\n 127\n ],\n \"external_data\": null\n}"}],"_postman_id":"c6dd7758-b56c-475d-94e0-a2681ae7ee33"},{"name":"Retrieve Impact Tags","id":"a9f41f5d-7096-4251-a47d-bfc862f8dffa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/tag/?type=impact","description":"Returns a list of Impact tags identifiers so you can update impact tags for posture rules.
\nString; Filter by type
\n","type":"text/plain"},"key":"type","value":"impact"}],"variable":[]}},"response":[{"id":"29bbd051-cabb-4e3a-86a9-a98b639c4803","name":"Retreive Impact Tags","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/tag/?type=impact","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","tag",""],"query":[{"key":"type","value":"impact","description":"String; Filter by type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 87167,\n \"created\": \"2022-11-26T22:10:52.885519Z\",\n \"modified\": \"2022-11-26T22:10:52.885524Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Confidentiality:Critical\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": \"DB0300\",\n \"immutable\": true,\n \"confidentiality_score\": 100,\n \"integrity_score\": null,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n },\n {\n \"id\": 87166,\n \"created\": \"2022-11-26T22:10:52.885490Z\",\n \"modified\": \"2022-11-26T22:10:52.885494Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Confidentiality:High\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": \"FD7A79\",\n \"immutable\": true,\n \"confidentiality_score\": 75,\n \"integrity_score\": null,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n },\n {\n \"id\": 87164,\n \"created\": \"2022-11-26T22:10:52.885430Z\",\n \"modified\": \"2022-11-26T22:10:52.885435Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Confidentiality:Low\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": \"E6C128\",\n \"immutable\": true,\n \"confidentiality_score\": 25,\n \"integrity_score\": null,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n },\n {\n \"id\": 87165,\n \"created\": \"2022-11-26T22:10:52.885460Z\",\n \"modified\": \"2022-11-26T22:10:52.885465Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Confidentiality:Medium\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": \"FFB000\",\n \"immutable\": true,\n \"confidentiality_score\": 50,\n \"integrity_score\": null,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n },\n {\n \"id\": 87172,\n \"created\": \"2022-11-26T22:10:52.885684Z\",\n \"modified\": \"2022-11-26T22:10:52.885689Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Integrity:Critical\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": \"DB0300\",\n \"immutable\": true,\n \"confidentiality_score\": null,\n \"integrity_score\": 100,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n },\n {\n \"id\": 87171,\n \"created\": \"2022-11-26T22:10:52.885653Z\",\n \"modified\": \"2022-11-26T22:10:52.885658Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Integrity:High\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": \"FD7A79\",\n \"immutable\": true,\n \"confidentiality_score\": null,\n \"integrity_score\": 75,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n },\n {\n \"id\": 87169,\n \"created\": \"2022-11-26T22:10:52.885583Z\",\n \"modified\": \"2022-11-26T22:10:52.885591Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Integrity:Low\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": \"E6C128\",\n \"immutable\": true,\n \"confidentiality_score\": null,\n \"integrity_score\": 25,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n },\n {\n \"id\": 87170,\n \"created\": \"2022-11-26T22:10:52.885623Z\",\n \"modified\": \"2022-11-26T22:10:52.885628Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Integrity:Medium\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": \"FFB000\",\n \"immutable\": true,\n \"confidentiality_score\": null,\n \"integrity_score\": 50,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n },\n {\n \"id\": 87168,\n \"created\": \"2022-11-26T22:10:52.885548Z\",\n \"modified\": \"2022-11-26T22:10:52.885557Z\",\n \"external_id\": null,\n \"created_by\": null,\n \"modified_by\": null,\n \"owner\": null,\n \"name\": \"Integrity:None\",\n \"short_name\": null,\n \"type\": \"impact\",\n \"color\": null,\n \"immutable\": true,\n \"confidentiality_score\": null,\n \"integrity_score\": 0,\n \"confidentiality_multiplier\": null,\n \"integrity_multiplier\": null\n }\n]"}],"_postman_id":"a9f41f5d-7096-4251-a47d-bfc862f8dffa"},{"name":"List open policy violations","id":"96847ee4-dff0-46ae-a468-d2d5d69d6a09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/:service_type/ruleevent/:id/list_instances/","description":"Given the service type and the issue id, this request returns a list of violations associated with that issue.
\nThis request returns the permissions for the currently authenticated user for viewing, creating, updating, and deleting policy issues.
\nThis request provides the issue id and the action allow in the payload, which creates an exception for violations for that issue in the queried environment.
expires (date/time) is optional. It is only needed when allowing an issue with a expiration date.
The records array contains all issues being allowed.
\nThis request passes the issue id and the closed_status in the payload, thereby closing the violations for the specified issue in the queried environment.
The records array contains all issues being closed.
\nThis request deletes the rule specified by the id passed in.
Multiple rule ids may be passed in through the payload, separated by commas. The specified rules are deleted from the queried environment.
\n","urlObject":{"protocol":"https","path":["api","v1",":service_type","rule","bulk_delete",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[{"type":"any","value":null,"key":"service_type"}]}},"response":[{"id":"b90eea5f-f3ed-45a7-ad06-d3434af54cf9","name":"Bulk delete rules within a policy","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"ids\": [443194,443193]\n} ","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[your_subdomain]/api/v1/:service_type/rule/bulk_delete/","protocol":"https","host":["[your_subdomain]"],"path":["api","v1",":service_type","rule","bulk_delete",""],"variable":[{"key":"service_type","value":null}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4e6aa243-872b-4953-8342-247fe61493e0"},{"name":"List the last successful scan time for the active policies in a given monitored service","id":"c1f996e0-2855-4b6c-ac69-aff19abdcf61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:id/last_successful_policy_assessments/","description":"Returns the last successful scan time for all active policies for the specified monitored service id.
\nReturns the last successful scan time for all monitored services for the specified active policy id.
\nAPI results account for all monitored services associated with a given policy, including those added directly and those added indirectly using Target Tags.
\nReturns a list of policy settings specific to Microsoft 365 service.
\nSystem Settings Collection Snapshot
\nSTEPS-Methods:
\nGET - List Monitored Services[your_subdomain]/api/v1/core/monitoredservice/
GET Get monitored service system settings[your_subdomain]/api/v1/:serviceType/svcexp/:serviceId/servicesettings/
POST Systems Settings Collection Snapshot[your_subdomain]/api/v1/core/policy/snapshot
Variables:
\n“name” - The name you are giving the snapshot that is being created
”baseline_monitored_service” - maps to ”id” from List Monitored Services - The monitored service that has the base policy content that is being snapshotted.
\"target_monitored_services\" - maps to ”id” from List Monitored Services - The monitored services that the snapshot is saved to.
”description” - string - *optional
“tags” - maps to “tags” from List Monitored Services expressed as integers (environment or target tags) - *optional
“filters”:“setting_id_ _in” - maps to “setting_id” from Get monitored service system settings
“filters”:“criticality” - maps to “criticality” from Get monitored service system setting
“filters”:”service_category”- maps to “service_category” from Get monitored service system setting
PAYLOAD (BODY)
\n{\n \"type\": \"system\",\n \"collections\": [\n {\n “baseline_monitored_service_id”: “<monitored service ID>”,\n “target_monitored_service_ids”: “<related monitored service IDs>”,\n “name”: “<string>”,\n “description”: “<string>”,\n “tags”: “<related tag IDs>”,\n “filters”: {\n “setting_id__in”: “<Array of primary keys>”,\n “<filter attribute>”: “<string>” | “<number>”,\n },\n }\n ]\n }\n\nSTEPS:
\nGET - List Monitored Services [your_subdomain]/api/v1/core/monitoredservice/
GET - List monitored service policy settings - M365 only[your_subdomain]/api/v1/o365/svcexp/:serviceId/policy
POST - Create a Posture Policy Collections Snapshot[your_subdomain]/api/v1/core/policy/snapshot
* `“name”` - The name you are giving the snapshot that is being created\n* `”baseline_monitored_service”` - maps to `”id”` from List Monitored Services - The monitored service that has the base policy content that is being snapshotted. \n* \"target_monitored_services\" - maps to `”id”` from List Monitored Services - The monitored services that the snapshot is saved to.\n* `”description”` - string - *optional\n* `“tags”` - maps to `“tags”` from List Monitored Services expressed as integers (environment or target tags) - *optional\n* `“policy_category”` - maps to `“policy_category”` from List monitored service policy settings -M365 only\n* `“policy_id”` - maps to `“policy_id”` from List monitored service policy settings \n\nPAYLOAD (BODY)
\n{\n “type”: “policies”\n “collections”: [\n {\n “name”: “<string>”,\n “description”: “<string>”,\n “baseline_monitored_service_id”: “<monitored service ID>”,\n “target_monitored_service_ids”: “<related monitored service IDs>”,\n “policy_category”: “<string>”,\n “policy_id”: “<policy ID>”,\n “tags”: “<related tag IDs>”,\n }\n ] \n }\n\nYour Refresh Token
\n","type":"text"},{"key":"client_id","value":"{{api_app_client_id}}","description":"The Client ID of your AppOmni API Application
\n","type":"text"},{"key":"client_secret","value":"{{api_app_client_secret}}","description":"The Client Secret of your AppOmni API Application
\n","type":"text"}]},"url":"https://[your_subdomain].appomni.com/oauth/token/","description":"This is a standard OAuth 2.0 \"Refresh Token Grant\" flow that enables the exchange of a valid Refresh Token for a new Access Token. The valid Access Token can then be used to make authenticated API requests in the context of the user who granted the Refresh Token.
\nUse this route to grant an Access Token with a custom expiration date. This can be used to create long-lived API tokens where necessary for service-to-service integrations that cannot execute the OAuth 2.0 token grant flow using a Refresh Token.
\nWhen using this capability, a new Refresh Token will be created for the specified Application. An Access Token with the specified expiration date will be granted under that Refresh Token.
\nIn the request,application is the ID of the AppOmni API Application to grant the token under. The API token you are using to make this request must have access to the application.
You can execute a GET request on /api/v1/core/oauthapplication/?limit=25&offset=0&ordering=-name to obtain ID's for available API applications.
This is a RFC 7662-compliant Access Token Introspection endpoint. When making a query to the introspection endpoint with your valid access token in the Authorization header, you will get a response including the Client ID of the API Application the Access Token belongs to, the unix timestamp the token expires at, and the username of the user to which the token grants access under.
\nhttps://datatracker.ietf.org/doc/html/rfc7662#section-2.2
\n","urlObject":{"protocol":"https","path":["oauth","introspect",""],"host":["[your_subdomain]"],"query":[],"variable":[]}},"response":[{"id":"812ed240-9492-4e7f-a370-2e0cf75eb0f3","name":"Introspect Access Token","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"url":"https://[your_subdomain]/oauth/introspect/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"active\": true,\n \"exp\": 1788793177,\n \"client_id\": \"XXX\",\n \"username\": user123\"\n}"}],"_postman_id":"eb40ace1-40a0-4d83-b7e1-ed174d1d171a"},{"name":"Revoke Refresh Token","id":"e97f6ab9-61c5-4f4e-97b1-c543146447db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"REFRESH_TOKEN","description":"Refresh Token to revoke
\n","type":"text"}]},"url":"https://[your_subdomain]/oauth/revoke/","description":"This is a RFC 7009-compliant revocation route for OAuth Refresh Tokens granted under AppOmni API Applications.
\nThis route should be called via POST with the token parameter containing the value of the Refresh Token to be revoked. The token, and all Access Tokens granted under it, will be immediately revoked.
https://datatracker.ietf.org/doc/html/rfc7009#section-2.1
\n","urlObject":{"protocol":"https","path":["oauth","revoke",""],"host":["[your_subdomain]"],"query":[],"variable":[]}},"response":[],"_postman_id":"e97f6ab9-61c5-4f4e-97b1-c543146447db"},{"name":"Revoke Refresh Token by Token ID","id":"a6c75a75-d6a9-40cb-ad55-d1df636d7ed9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://[your_subdomain]/api/v1/core/oauthrefreshtoken/:token_id/","urlObject":{"protocol":"https","path":["api","v1","core","oauthrefreshtoken",":token_id",""],"host":["[your_subdomain]"],"query":[],"variable":[{"description":{"content":"The ID of the Refresh Token to delete
\n","type":"text/plain"},"type":"any","value":"XXX","key":"token_id"}]}},"response":[],"_postman_id":"a6c75a75-d6a9-40cb-ad55-d1df636d7ed9"},{"name":"Get API Application by Client ID","id":"8957c87f-20fa-4f8b-82d2-63f88e67c2bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain]/api/v1/core/oauthapplication/?client_id=CLIENT_ID","description":"Using this route you are able to query for an AppOmni API Application (OAuthApplication object) by Client ID. This will allow you to convert a Client ID to the API Application ID, which may be necessary for other operations (e.g. rotating the client secret via API).
\n","urlObject":{"protocol":"https","path":["api","v1","core","oauthapplication",""],"host":["[your_subdomain]"],"query":[{"description":{"content":"String; Filter by client id
\n","type":"text/plain"},"key":"client_id","value":"CLIENT_ID"}],"variable":[]}},"response":[{"id":"201eafcd-1b6a-485d-8f1a-9866a964fbc2","name":"Get API Application by Client ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain]/api/v1/core/oauthapplication/?client_id=ABCDEF123456","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","core","oauthapplication",""],"query":[{"key":"client_id","value":"ABCDEF123456","description":"String; Filter by client id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"created\": \"2025-09-07T14:59:37.872737Z\",\n \"modified\": \"2025-09-07T14:59:37.872717Z\",\n \"external_id\": null,\n \"created_by\": 1,\n \"modified_by\": null,\n \"owner\": 1,\n \"name\": \"Sample Application\",\n \"description\": null\n \"client_id\": \"ABCDEF123456\",\n \"redirect_uris\": \"\",\n \"client_type\": \"confidential\",\n \"authorization_grant_type\": \"authorization-code\",\n \"skip_authorization\": false,\n \"allowed_scopes\": [],\n }\n]"}],"_postman_id":"8957c87f-20fa-4f8b-82d2-63f88e67c2bc"},{"name":"Rotate an API Application's Client Secret","id":"c71d683b-0ff1-4643-9d53-1b7bdb0b6dd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://[your_subdomain]/api/v1/core/oauthapplication/:app_id/rotate_client_secret/","description":"Making a POST request to this route with valid authorization credentials (must be a valid API token with access to manage the API Application in question) will immediately rotate the API Application's client secret. The new client secret will be required for all future Access Token grant requests in conjunction with a valid Refresh Token.
\nAll existing Refresh Tokens will remain valid, and all Access Tokens previously granted and still valid will remain so until their expiration time.
\nIn most cases this action is only required if you believe your API Application's Client Secret has been compromised. Otherwise, it is recommended you revoke and issue new Refresh Tokens.
\nThe ID of the API Application
\n","type":"text/plain"},"type":"any","value":"","key":"app_id"}]}},"response":[{"id":"d6507ee0-5740-40d3-b28b-b017b153c481","name":"Rotate an API Application's Client Secret","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://[your_subdomain]/api/v1/core/oauthapplication/:app_id/rotate_client_secret/","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","core","oauthapplication",":app_id","rotate_client_secret",""],"variable":[{"key":"app_id","value":"1","description":"The ID of the API Application"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"client_secret\": \"NEW_CLIENT_SECRET\"\n}"}],"_postman_id":"c71d683b-0ff1-4643-9d53-1b7bdb0b6dd5"}],"id":"e265732a-f827-445f-a97f-1d6fbc379af8","_postman_id":"e265732a-f827-445f-a97f-1d6fbc379af8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a paginated list of tags in the system.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Number of results to skip for pagination
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"String; Filter by tag full name
\n","type":"text/plain"},"key":"name","value":"Production"},{"disabled":true,"description":{"content":"String; Filter by tag short name
\n","type":"text/plain"},"key":"short_name","value":"Prod"},{"disabled":true,"description":{"content":"String; Filter by tag type (environment, impact, trust, compliance, generic)
\n","type":"text/plain"},"key":"type","value":"environment"}],"variable":[]}},"response":[{"id":"e3339dfc-f296-44d5-9011-969b4190a8d2","name":"List Tags","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/tag/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","tag",""],"query":[{"key":"name","value":"{{name_value}}","description":"String; Filter by name","disabled":true},{"key":"short_name","value":"{{short_name_value}}","description":"String; Filter by short name","disabled":true},{"key":"type","value":"{{type_value}}","description":"String; Filter by tag type","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[{ \n \"id\": 259814,\n \"created\": \"2025-03-28T14:45:37.694435Z\",\n \"modified\": \"2025-03-28T14:45:37.694453Z\",\n \"external_id\": null,\n \"created_by\": 1,\n \"modified_by\": null,\n \"owner\": 1,\n \"name\": \"custom-environment-tag\",\n \"short_name\": \"CE-tag\",\n \"type\": \"environment\",\n \"color\": null,\n \"immutable\": false,\n \"confidentiality_score\": null,\n \"integrity_score\": null,\n \"confidentiality_multiplier\": 0.45,\n \"integrity_multiplier\": 0.77\n },...]"}],"_postman_id":"7f689dd2-52c8-4403-a2ee-daeb718863db"}],"id":"fe098d7b-92e8-4490-83b2-534523a4de91","_postman_id":"fe098d7b-92e8-4490-83b2-534523a4de91","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Use this API route to retrieve AppOmni audit logs programmatically.
\nFor most use cases, its is recommended that you download AppOmni audit logs via the Reports feature. Audit logs are stored for 180 days; for longer term storage it is recommended you use Destinations to have logs sent to your SIEM.
\nAppOmni audit logs will be immediately sent to configured Threat Detection event sinks (e.g. a SIEM).
\nString (ISO datetime); Filter for audit logs since an ISO datetime
\n","type":"text/plain"},"key":"since","value":"2025-05-01T01:00:00.000Z"},{"disabled":true,"description":{"content":"String (ISO datetime); Filter for audit logs before an ISO datetime
\n","type":"text/plain"},"key":"before","value":"2025-05-02T01:00:00.000Z"},{"disabled":true,"description":{"content":"Integer; Filter to audit logs about a specific Monitored Service by its ID
\n","type":"text/plain"},"key":"monitored_service","value":"{{monitored_service_id}}"},{"disabled":true,"description":{"content":"Array[Integer]; Filter to audit logs about a set of Monitored Services by their IDs
\n","type":"text/plain"},"key":"monitored_service__in","value":"[{{ms1_id}},{{ms2_id}}]"},{"disabled":true,"description":{"content":"Integer; Filter to audit logs by a specific User by their ID
\n","type":"text/plain"},"key":"user","value":"{{user_id}}"},{"disabled":true,"description":{"content":"Array[Integer]; Filter to audit logs by a list of Users by their IDs
\n","type":"text/plain"},"key":"user__in","value":"[{{user1_id}},{{user2_id}}]"},{"disabled":true,"description":{"content":"Integer; Filter to audit logs about a specific Policy by its ID
\n","type":"text/plain"},"key":"policy","value":"{{policy_id}}"},{"disabled":true,"description":{"content":"Array[Integer]; Filter to audit logs about a list of Policies by their IDs
\n","type":"text/plain"},"key":"policy__in","value":"[{{policy1_id}},{{policy2_id}},{{policy3_id}}]"},{"disabled":true,"description":{"content":"String; Filter to audit logs about a specific action type
\n","type":"text/plain"},"key":"action_type","value":"user_login_saml"},{"disabled":true,"description":{"content":"Array[String]; Filter to audit logs about a list of action types
\n","type":"text/plain"},"key":"action_type__in","value":"[\"policy_scan_ended\",\"user_login_saml\"]"}],"variable":[]}},"response":[{"id":"1c01ef68-abc7-4813-934d-e3ace3bb4f19","name":"Get Audit Logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/auditlogs/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","auditlogs",""],"query":[{"key":"since","value":"2025-05-01T01:00:00.000Z","description":"String (ISO datetime); Filter for audit logs since an ISO datetime","disabled":true},{"key":"before","value":"2025-05-02T01:00:00.000Z","description":"String (ISO datetime); Filter for audit logs before an ISO datetime","disabled":true},{"key":"monitored_service","value":"{{monitored_service_id}}","description":"Integer; Filter to audit logs about a specific Monitored Service by its ID","disabled":true},{"key":"monitored_service__in","value":"[{{ms1_id}},{{ms2_id}}]","description":"Array[Integer]; Filter to audit logs about a set of Monitored Services by their IDs","disabled":true},{"key":"user","value":"{{user_id}}","description":"Integer; Filter to audit logs by a specific User by their ID","disabled":true},{"key":"user__in","value":"[{{user1_id}},{{user2_id}}]","description":"Array[Integer]; Filter to audit logs by a list of Users by their IDs","disabled":true},{"key":"policy","value":"{{policy_id}}","description":"Integer; Filter to audit logs about a specific Policy by its ID","disabled":true},{"key":"policy__in","value":"[{{policy1_id}},{{policy2_id}},{{policy3_id}}]","description":"Array[Integer]; Filter to audit logs about a list of Policies by their IDs","disabled":true},{"key":"action_type","value":"user_login_saml","description":"String; Filter to audit logs about a specific action type","disabled":true},{"key":"action_type__in","value":"[\"policy_scan_ended\",\"user_login_saml\"]","description":"Array[String]; Filter to audit logs about a list of action types","disabled":true}]}},"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": \"null\",\n \"previous\": null,\n \"results\": [\n {\n \"identifier\": \"24e94fd4-7d17-4302-9e98-1b9e468187a1\",\n \"user_id\": null,\n \"action_at\": \"2025-05-02T13:30:06.948560Z\",\n \"action_type\": \"policy_scan_ended\",\n \"service_id\": null,\n \"service_type\": null,\n \"service_name\": null,\n \"policy_id\": 311371,\n \"perspective_id\": null,\n \"perspective_name\": null,\n \"action_data\": {\n \"rule_id\": null,\n \"rule_name\": null,\n \"ruleexception_id\": null,\n \"ruleevent_id\": null,\n \"message\": null,\n \"expiration\": null,\n \"instance_id\": null,\n \"assignee_id\": null,\n \"assignee_username\": null,\n \"policy_id\": 311371,\n \"policy_name\": \"LP1\",\n \"exception_data\": null,\n \"policy_assessment_id\": null,\n \"policy_assessment_completion_date\": null,\n \"workflow_instance_id\": null,\n \"workflow_instance_name\": null,\n \"platform_ingest_job_id\": null,\n \"file_id\": null,\n \"third_party_application_id\": null,\n \"third_party_application_name\": null,\n \"oauth_application_id\": null,\n \"refresh_token_id\": null,\n \"access_token_id\": null,\n \"external_entity_id\": null,\n \"group_id\": null,\n \"group_name\": null,\n \"tag_id\": null,\n \"tag_name\": null,\n \"type_str\": null,\n \"reason_str\": null,\n \"detail_str\": \"Completion Status: Success\",\n \"error_str\": null,\n \"user_ip\": null,\n \"user_agent\": null,\n \"unified_identity_id\": null,\n \"unified_identity_email\": null,\n \"target_user_id\": null,\n \"target_user_username\": null,\n \"user_username\": null,\n \"setting_name\": null,\n \"old_value\": null,\n \"new_value\": null,\n \"scim_mapping_id\": null,\n \"scim_attribute\": null,\n \"scim_attribute_value\": null,\n \"scim_group_targets\": null,\n \"sink_id\": null,\n \"sink_name\": null,\n \"detection_rule_id\": null,\n \"detection_rule_name\": null,\n \"detection_ruleset_id\": null,\n \"detection_ruleset_name\": null,\n \"detection_alert_id\": null,\n \"detection_alert_count\": null,\n \"destination_id\": null,\n \"destination_name\": null,\n \"destination_hash\": null,\n \"destination_type\": null,\n \"external_connection_id\": null,\n \"external_connection_name\": null,\n \"external_connection_provider_type\": null,\n \"external_connection_auth_type\": null,\n \"eventsource_id\": null,\n \"eventsource_name\": null,\n \"eventsource_type\": null,\n \"eventsource_dataset\": null,\n \"investigation_id\": null,\n \"investigation_subject\": null,\n \"element_list_id\": null,\n \"element_id\": null,\n \"element_type\": null,\n \"global_value_list_collection_id\": null,\n \"email_addresses\": null,\n \"email_identifier\": null,\n \"email_reason\": null,\n \"insight_name\": null,\n \"thread_name\": null,\n \"occurrence_name\": null,\n \"insight_id\": null,\n \"thread_id\": null,\n \"occurrence_id\": null\n }\n },\n {\n \"identifier\": \"b0712e14-4e02-4f67-99f9-6e597a2c1663\",\n \"user_id\": 21,\n \"action_at\": \"2025-05-02T13:26:56.974998Z\",\n \"action_type\": \"user_login_saml\",\n \"service_id\": null,\n \"service_type\": null,\n \"service_name\": null,\n \"policy_id\": null,\n \"perspective_id\": null,\n \"perspective_name\": null,\n \"action_data\": {\n \"rule_id\": null,\n \"rule_name\": null,\n \"ruleexception_id\": null,\n \"ruleevent_id\": null,\n \"message\": null,\n \"expiration\": null,\n \"instance_id\": null,\n \"assignee_id\": null,\n \"assignee_username\": null,\n \"policy_id\": null,\n \"policy_name\": null,\n \"exception_data\": null,\n \"policy_assessment_id\": null,\n \"policy_assessment_completion_date\": null,\n \"workflow_instance_id\": null,\n \"workflow_instance_name\": null,\n \"platform_ingest_job_id\": null,\n \"file_id\": null,\n \"third_party_application_id\": null,\n \"third_party_application_name\": null,\n \"oauth_application_id\": null,\n \"refresh_token_id\": null,\n \"access_token_id\": null,\n \"external_entity_id\": null,\n \"group_id\": null,\n \"group_name\": null,\n \"tag_id\": null,\n \"tag_name\": null,\n \"type_str\": null,\n \"reason_str\": null,\n \"detail_str\": null,\n \"error_str\": null,\n \"user_ip\": \"71.178.255.92\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\",\n \"unified_identity_id\": null,\n \"unified_identity_email\": null,\n \"target_user_id\": null,\n \"target_user_username\": null,\n \"user_username\": \"John Doe\",\n \"setting_name\": null,\n \"old_value\": null,\n \"new_value\": null,\n \"scim_mapping_id\": null,\n \"scim_attribute\": null,\n \"scim_attribute_value\": null,\n \"scim_group_targets\": null,\n \"sink_id\": null,\n \"sink_name\": null,\n \"detection_rule_id\": null,\n \"detection_rule_name\": null,\n \"detection_ruleset_id\": null,\n \"detection_ruleset_name\": null,\n \"detection_alert_id\": null,\n \"detection_alert_count\": null,\n \"destination_id\": null,\n \"destination_name\": null,\n \"destination_hash\": null,\n \"destination_type\": null,\n \"external_connection_id\": null,\n \"external_connection_name\": null,\n \"external_connection_provider_type\": null,\n \"external_connection_auth_type\": null,\n \"eventsource_id\": null,\n \"eventsource_name\": null,\n \"eventsource_type\": null,\n \"eventsource_dataset\": null,\n \"investigation_id\": null,\n \"investigation_subject\": null,\n \"element_list_id\": null,\n \"element_id\": null,\n \"element_type\": null,\n \"global_value_list_collection_id\": null,\n \"email_addresses\": null,\n \"email_identifier\": null,\n \"email_reason\": null,\n \"insight_name\": null,\n \"thread_name\": null,\n \"occurrence_name\": null,\n \"insight_id\": null,\n \"thread_id\": null,\n \"occurrence_id\": null\n }\n }\n ]\n}"}],"_postman_id":"e6d91600-f467-4557-9157-2bfb37b934ae"},{"name":"List audit action types","id":"5294c479-f0ab-4027-996e-d0ef082b2218","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/auditlogs/action_types/","description":"Use this API route to programatically retrieve all possible Audit record action types, to use in filtering the Get Audit Logs endpoint if desired.
\nThis endpoint will return all possible Audit action types, which may include some action types not seen in your tenant.
\nReturns a list of reports which a user can run.
\nTo list report groups, see /reports/group
accepted_parameters can be passed when requesting a report.
String; Searches for the specified string anywhere in the report_pretty_name and return matching reports
\n","type":"text/plain"},"key":"report_pretty_name","value":"All Issues"},{"disabled":true,"description":{"content":"String; Searches for the specified string anywhere in the report_description and return matching reports
\n","type":"text/plain"},"key":"report_description","value":"issues"}],"variable":[]}},"response":[{"id":"3e3ba85b-0e9d-4c74-99a5-2440ba7c0a33","name":"List Available Reports","originalRequest":{"method":"GET","header":[],"url":""},"_postman_previewlanguage":"Text","header":[{}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"report_package\": \"core\",\n \"report_pretty_name\": \"All Issues Export Report\",\n \"report_description\": \"Report on all issues\",\n \"report_class\": \"AllIssuesExportReport\",\n \"report_types\": [\n \"xlsx\",\n \"csv\",\n \"json\"\n ],\n \"service_type\": \"core\",\n \"accepted_parameters\": [\n {\n \"name\": \"pk__in\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"unique_id__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"pk\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"service_org_id\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"instance_id__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"service_org__type__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"service_org__type_slug__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"service_org__in\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"service_org__tags__in\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"risk_score__gte\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"risk_score__lte\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"risk_score__ranges\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"policy__in\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"policy_type__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"policy_type_slug__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"policy_mode__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"policy_role__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"tags__in\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"rule__compliance_controls__compliance_framework__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"rule__rule_posture_category\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"rule__rule_posture_category__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"rule__rule_posture_subcategory\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"rule__rule_posture_subcategory__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"service_specific_category\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"service_specific_category__in\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"closed\",\n \"type\": \"bool\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"search\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"assignee__in\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"limit\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"offset\",\n \"type\": \"int\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n },\n {\n \"name\": \"ordering\",\n \"type\": \"str\",\n \"required\": false,\n \"md_version\": 1,\n \"md_kind\": \"reports.report.acceptedparameter\"\n }\n ],\n \"category\": \"summary\",\n \"is_internal\": false\n },\n...\n]"}],"_postman_id":"5e5dae77-8831-4a20-b99a-9121d2beb342"},{"name":"List report categories","id":"4c2df0d2-4c50-4167-bff0-41283472a983","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/reports/list/report_categories","description":"Returns a list of all available report categories
\nCreates a request to generate a single report, which will be created as the desired file type. This will be queued up and processed by at a later time; most likely immediately.)
\nIn addition to the required parameters (report_package, report_type, report_class, and in most cases, monitored_service_id), additional parameters may be provided as required by the individual report. Parameters that are not needed by the individual report will be ignored.
report_class and report_package, along with the supported file types, and any required additional parameters, can be found from the List Available Reports endpoint.
POST operation is available:
\nCertain reports contain data in the params, such as long lists of GUIDs, that cause length issues with the URLs if that data is encoded into the URL as a query string.
\nAppOmni accepts POST as an alternative, where the data is instead sent via the body of the request.
\nString; Required. The app targeted by the report (e.g. box, o365). This must match the report_package returned by the list_reports endpoint
\n","type":"text/plain"},"key":"report_package","value":"{{report_package}}"},{"disabled":true,"description":{"content":"String; Required. Name of the Python class underlying the report (Unique identifier for the report). This must match a report_class available from the list_reports endpoint
\n","type":"text/plain"},"key":"report_class","value":"{{report_class}}"},{"disabled":true,"description":{"content":"Integer; Monitored service to run report against. Available from the /monitoredservice endpoint
\n","type":"text/plain"},"key":"monitored_service_id","value":"{{monitored_service_id}}"},{"description":{"content":"String; Required. The output format for the created report file (csv, xlsx, pdf, json). Note: PDF is not valid for all reports
\n","type":"text/plain"},"key":"report_type","value":"xlsx"},{"disabled":true,"description":{"content":"Array[String]; Email addresses for report recipients without AppOmni accounts
\n","type":"text/plain"},"key":"notify_external_emails","value":"[\"user1@example.com\",\"user2@example.com\"]"}],"variable":[]}},"response":[{"id":"e82f7e09-607c-4d23-a140-d8a993151eb3","name":"Generate Single XLSX Report","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/reports/request/report?report_package=sfdc&report_type=xlsx&report_class=OauthTokensReport&monitored_service_id=1","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","reports","request","report"],"query":[{"key":"report_package","value":"sfdc"},{"key":"report_type","value":"xlsx"},{"key":"report_class","value":"OauthTokensReport"},{"key":"monitored_service_id","value":"1"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"request_id\": \"5071137b-1e9a-4697-bb0c-c28128b7cbc8\",\n \"report_status\": \"requested\",\n \"pending_report_id\": 8\n}"},{"id":"cfa4649a-6038-47fc-8796-3de82f239616","name":"Generate Single CSV Report","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/reports/request/report?report_package=sfdc&report_type=csv&report_class=OauthTokensReport&monitored_service_id=1","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","reports","request","report"],"query":[{"key":"report_package","value":"sfdc"},{"key":"report_type","value":"csv"},{"key":"report_class","value":"OauthTokensReport"},{"key":"monitored_service_id","value":"1"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"request_id\": \"5071137b-1e9a-4697-bb0c-c28128b7cbc8\",\n \"report_status\": \"requested\",\n \"pending_report_id\": 8\n}"},{"id":"e1957dd1-7673-4908-a1e0-a84002324acb","name":"Generate Single JSON Report","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/reports/request/report?report_package=sfdc&report_type=json&report_class=OauthTokensReport&monitored_service_id=1","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","reports","request","report"],"query":[{"key":"report_package","value":"sfdc"},{"key":"report_type","value":"json"},{"key":"report_class","value":"OauthTokensReport"},{"key":"monitored_service_id","value":"1"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"request_id\": \"5071137b-1e9a-4697-bb0c-c28128b7cbc8\",\n \"report_status\": \"requested\",\n \"pending_report_id\": 8\n}"},{"id":"2d898d5d-f548-4056-96a0-b1ff6fc4be65","name":"Generate Single Report with accepted parameters","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/reports/request/report?report_package=sfdc&report_type=xlsx&report_class=NewCommunitiesReportV2&monitored_service_id={{monitored_service_id}}&start_date=2024-01-01&end_date=2024-12-31","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","reports","request","report"],"query":[{"key":"report_package","value":"sfdc","description":"String; Package identifier for package that contains desired report (e.g. sfdc, box, github)"},{"key":"report_type","value":"xlsx","description":"String; Desired file type for generated report. One of: pdf, xlsx, json, csv"},{"key":"report_class","value":"NewCommunitiesReportV2","description":"String; Class name of desired report (e.g. OauthTokensReport). This is returned from the List Available Reports endpoint"},{"key":"monitored_service_id","value":"{{monitored_service_id}}","description":"Integer; Monitored Service to run report against"},{"key":"start_date","value":"2024-01-01","description":"String (Date); Start date for the report (YYYY-MM-DD)"},{"key":"end_date","value":"2024-12-31","description":"String (Date); End date for the report (YYYY-MM-DD)"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"request_id\": \"5071137b-1e9a-4697-bb0c-c28128b7cbc8\",\n \"report_status\": \"requested\",\n \"pending_report_id\": 8\n}"},{"id":"3f19808c-6bcd-4993-af48-ac696cad4981","name":"Generate Single Report","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/reports/request/report?report_package={{report_package}}&report_type={{report_type}}&report_class={{report_class}}&monitored_service_id={{monitored_service_id}}","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","reports","request","report"],"query":[{"key":"report_package","value":"{{report_package}}","description":"String; Package identifier for package that contains desired report (e.g. sfdc, box, github)"},{"key":"report_type","value":"{{report_type}}","description":"String; Desired file type for generated report. One of: pdf, xlsx, json, csv"},{"key":"report_class","value":"{{report_class}}","description":"String; Class name of desired report (e.g. OauthTokensReport). This is returned from the List Available Reports endpoint"},{"key":"monitored_service_id","value":"{{monitored_service_id}}","description":"Monitored Service to run report against"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1e7e46c8-8aea-4649-ad39-c8336a269216","name":"Generate Single Report","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/reports/request/report?report_package={{report_package}}&report_type={{report_type}}&report_class={{report_class}}&monitored_service_id={{monitored_service_id}}","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","reports","request","report"],"query":[{"key":"report_package","value":"{{report_package}}","description":"String; Package identifier for package that contains desired report (e.g. sfdc, box, github)"},{"key":"report_type","value":"{{report_type}}","description":"String; Desired file type for generated report. One of: pdf, xlsx, json, csv"},{"key":"report_class","value":"{{report_class}}","description":"String; Class name of desired report (e.g. OauthTokensReport). This is returned from the List Available Reports endpoint"},{"key":"monitored_service_id","value":"{{monitored_service_id}}","description":"Monitored Service to run report against"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"80002af8-9359-4ee8-a343-bfc1b9bbe199"},{"name":"Generate a single report","id":"09847c45-00fc-48b8-ad42-0c0264dcaa35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"report_params\": {\n \"report_name\": \"test\",\n \"report_package\": \"core\",\n \"report_class\": \"AllIssuesExportReport\",\n \"report_type\": \"csv\",\n \"monitored_service_id\": 36887,\n \"notify_external_emails\": [\"user@example.com\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/reports/request/report","description":"Creates a request to generate a single report using POST method. This is useful when report parameters contain long lists that would exceed URL length limits.
\nReturns a list of report groups configured in the system.
\nBoolean; Filter for scheduled report groups
\n","type":"text/plain"},"key":"is_scheduled","value":"true"}],"variable":[]}},"response":[{"id":"f6efd4eb-ae49-4544-96b5-8cc8d98b9d57","name":"List Available Report Groups","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/reports/group","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","reports","group"],"query":[{"key":"is_scheduled","value":null,"description":"Optional. Boolean. ","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 9905,\n \"created\": \"2025-01-15T20:29:52.541539Z\",\n \"modified\": \"2025-01-15T20:29:52.541555Z\",\n \"external_id\": null,\n \"created_by\": 1,\n \"modified_by\": null,\n \"owner\": 1,\n \"name\": \"asd\",\n \"report_configs\": [\n {\n \"report_package\": \"core\",\n \"report_class\": \"UnifiedIdentityExportReport\",\n \"report_type\": \"json\",\n \"monitored_service_id\": null,\n \"report_name\": \"All AppOmni Unified Identities\",\n \"parameters\": {},\n \"md_version\": 1,\n \"md_kind\": \"reports.report.config_data\"\n }\n ],\n \"schedule_start_date\": null,\n \"last_run_date\": null,\n \"next_run_date\": null,\n \"schedule_interval\": \"\",\n \"notify_external_emails\": [],\n \"notify_internal_users\": [\n 1\n ]\n },"}],"_postman_id":"39c8bd1d-e1c9-4dc3-87b9-3fe7f3f1903e"},{"name":"Create a report group","id":"69464165-2aa2-482a-8505-69563b3722a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"My Report Group\",\n \"notify_external_emails\": [\"user1@example.com\",\"user2@example.com\"],\n \"notify_internal_users\": [\n 1\n ],\n \"report_configs\": [\n {\n \"monitored_service_id\": 15033,\n \"parameters\": {},\n \"report_class\": \"GithubUsersByRepositoryReport\",\n \"report_name\": \"GitHub Users by Repository\",\n \"report_package\": \"github\",\n \"report_type\": \"csv\"\n },\n {\n \"monitored_service_id\": 67953,\n \"parameters\": {},\n \"report_class\": \"SNOWISOComplianceReport\",\n \"report_name\": \"ServiceNow ISO 27001 Compliance Report\",\n \"report_package\": \"snow\",\n \"report_type\": \"json\"\n }\n ],\n \"schedule_interval\": \"daily\",\n \"schedule_start_date\": \"2025-04-01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/reports/group","description":"Creates a report group, with the option to generate the reports in the group on a schedule.
\nReturns the details for a single specified report group.
\nUpdates the details for a single specified report group.
\nNote: The \"/\" utilized in the below report_configs entries denotes nesting. See the example request body.
\nmd_version, md_kind, owner, & external_id are \"unused\" from the customer perspective.
Requests that a report group be run.
\nThe returned request_id is used to check the status of the request later.
Integer; Required. The ID of the report group to run
\n","type":"text/plain"},"key":"group_id","value":"{{group_id}}"}],"variable":[]}},"response":[{"id":"b7e02c10-7525-4857-8973-6c1752a68f6a","name":"Run a Report Group","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your-subdomain].appomni.com/api/v1/reports/request/group/?group_id={{group_id}}","protocol":"https","host":["[your-subdomain]","appomni","com"],"path":["api","v1","reports","request","group",""],"query":[{"key":"group_id","value":"{{group_id}}","description":"Integer; Required. The ID of the report group to run"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\"request_id\":\"32a8aa4a-aea2-49a4-a915-854d58a6d987\"}"}],"_postman_id":"1e738b45-782d-4116-8809-98b254f4fef6"}],"id":"0353df9e-66c7-4f79-98c7-d8c58867ec35","_postman_id":"0353df9e-66c7-4f79-98c7-d8c58867ec35","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a list of all insights matching the specified filter criteria.
\nThis request returns a list of insights filtered by the specified parameters. If no parameters are set, all insights are returned for the tenant.
\nInteger; Defaults to 50, max 500
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Integer; Pagination offset
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Array[String]; One or more of open, dismissed, closed
\n","type":"text/plain"},"key":"status","value":"[\"open\"]"},{"disabled":true,"description":{"content":"String (ISO datetime); Filter for insights first seen before an ISO datetime
\n","type":"text/plain"},"key":"first_seen__lte","value":"2023-02-21T08:00:00.000Z"},{"disabled":true,"description":{"content":"String (ISO datetime); Filter for insights first seen since an ISO datetime
\n","type":"text/plain"},"key":"first_seen__gte","value":"2022-12-01T08:00:00.000Z"},{"disabled":true,"description":{"content":"String (ISO datetime); Filter for insights last seen before an ISO datetime
\n","type":"text/plain"},"key":"last_seen__lte","value":"2023-02-21T08:00:00.000Z"},{"disabled":true,"description":{"content":"String (ISO datetime); Filter for insights last seen since an ISO datetime
\n","type":"text/plain"},"key":"last_seen__gte","value":"2023-02-01T08:00:00.000Z"},{"disabled":true,"description":{"content":"Array[Integer]; Filter Insights to Monitored Services with specified list of tag IDs
\n","type":"text/plain"},"key":"monitored_service__tags__in","value":"[120]"},{"disabled":true,"description":{"content":"Array[Integer]; Filter Insights to the specified list of Monitored Service IDs
\n","type":"text/plain"},"key":"monitored_service__in","value":"[2057,3012]"}],"variable":[]}},"response":[{"id":"b9355e51-1eb7-4cf1-8c68-c8854b3d6d40","name":"List Insights","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/insights/discoveredinsight/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","insights","discoveredinsight",""],"query":[{"key":"limit","value":"50","description":"Defaults to 50, max 500","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 245,\n \"next\": \"https://example.appomni.com/api/v1/insights/discoveredinsight/?limit=50&offset=50\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 102455,\n \"created\": \"2025-09-04T03:45:55.343531Z\",\n \"modified\": \"2025-09-17T17:52:48.138399Z\",\n \"external_id\": null,\n \"created_by\": 65,\n \"modified_by\": 6734,\n \"owner\": null,\n \"label\": \"Data records exposed to anonymous world\",\n \"open_occurrences_summary\": 1,\n \"dismissed_occurrences_summary\": 0,\n \"description\": \"Data records exposed to the anonymous world should be limited to public data.\",\n \"service_type\": \"sfdc\",\n \"insight_type\": \"data_access\",\n \"insight_category\": \"authorization\",\n \"risk_score\": 100,\n \"risk_level\": \"critical\",\n \"appomni_risk_score\": 100,\n \"appomni_risk_level\": \"critical\",\n \"confidence\": 100,\n \"first_seen\": \"2025-09-04T03:45:55.343622Z\",\n \"last_seen\": \"2025-09-17T17:52:38.035581Z\",\n \"last_evaluated\": \"2025-09-17T08:19:24.773115Z\",\n \"status\": \"open\",\n \"tags\": [],\n \"dismissal_expires\": null,\n \"dismissed_on\": null,\n \"internal_name\": \"sfdc.scheduled.guest.GuestAccessibleRecordsInsight\",\n \"external_data\": null,\n \"internal_id\": \"f1c4a87d-6f83-4b2e-a960-2f8e3fdba9d2\",\n \"last_resolved_on\": \"2025-09-17T17:52:24.153210Z\",\n \"total_filtered_instance_data_count\": 1,\n \"dismissed_monitored_service\": [],\n \"dismissed_environments\": [],\n \"dismissal_reason_value\": null,\n \"dismissal_reason_label\": null,\n \"has_max_occurrences\": false\n }\n ]\n}"}],"_postman_id":"214a2e83-89ad-40d7-abc9-61587fcf7caf"},{"name":"Dismiss Insight [Dismiss a single insight]","id":"df411fab-345f-4843-b6f5-5a9e93976dfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"message\":\"{{optional_comment_for_feed_log}}\",\"expires\":\"{{iso_datetime_for_dismissal_expiration_date_omit_for_permanent_dismissal}}\"}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/insights/discoveredinsight/:insight_id/dismiss/","description":"This endpoint updates the specified insight by setting the status to dismissed.
\nRequest Body Fields:
\nInteger; Unique AppOmni identifier for the Insight
\n","type":"text/plain"},"type":"any","value":"{{insight_id}}","key":"insight_id"}]}},"response":[{"id":"53bd2a40-e528-4d29-85c4-ef34be98a704","name":"Dismiss Insight [Dismiss a single insight]","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"message\":\"dismiss for 10 days while testing\",\"expires\":\"2023-02-28T08:00:00.000Z\"}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/insights/discoveredinsight/3563/dismiss/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"/*\nRESPONSE SCHEMA DOCUMENTATION:\n\n| Field | Data Type | Description | Example |\n|------------------------------------|-------------------------------|------------------------------------------------------|---------------------------------------------|\n| id | Integer | Unique identifier | 3563 |\n| created | String (ISO datetime) | Timestamp when record was created | \"2022-06-10T08:23:31.577633Z\" |\n| modified | String (ISO datetime) | Timestamp when record was last modified | \"2023-02-24T23:41:07.792650Z\" |\n| external_id | String or null | External system identifier | null |\n| created_by | Integer | ID of user who created the record | 1010 |\n| modified_by | Integer | ID of user who last modified the record | 1010 |\n| owner | Integer or null | ID of the record owner | null |\n| label | String | Human-readable label for the record | \"User information insight\" |\n| description | String | Detailed description of the record | \"Description about what this insight is...\" |\n| service_type | String | Type of service (e.g., sfdc, o365) | \"sfdc\" |\n| insight_type | String | Category of insight | \"posture\" |\n| insight_category | String | Specific category within insight type | \"authorization\" |\n| risk_score | Integer | Risk score from 0-100 | 75 |\n| risk_level | String | Risk level classification | \"high\" |\n| appomni_risk_score | Integer or null | AppOmni calculated risk score | null |\n| appomni_risk_level | String or null | AppOmni risk level classification | null |\n| confidence | Integer | Confidence score from 0-100 | 80 |\n| first_seen | String (ISO datetime) | Timestamp when first detected | \"2022-06-10T08:23:31.577740Z\" |\n| last_seen | String (ISO datetime) | Timestamp when last detected | \"2023-02-24T08:09:10.789875Z\" |\n| last_evaluated | String (ISO datetime) | Timestamp of last evaluation | \"2023-02-24T15:16:48.132672Z\" |\n| instance_data_count | Integer | Number of active instance data records | 1 |\n| inactive_instance_data_count | Integer | Number of inactive instance data records | 0 |\n| instance_count | Integer | Number of active instances | 1 |\n| inactive_instance_count | Integer | Number of inactive instances | 0 |\n| resolved_instance_data_count | Integer | Number of resolved instance data records | 0 |\n| status | String | Current status (open, dismissed, resolved) | \"dismissed\" |\n| tags | Array[Integer] | Array of associated tag IDs | [] |\n| dismissal_expires | String (ISO datetime) or null | When dismissal expires (null for permanent) | \"2023-02-28T08:00:00Z\" |\n| dismissed_on | String (ISO datetime) or null | When record was dismissed | \"2023-02-24T23:41:07.788351Z\" |\n| internal_name | String | Internal system name | \"TheInternalNameGivenToThisInsight\" |\n| external_data | Object or null | Additional external data | null |\n| internal_id | String (UUID) | Internal UUID identifier | \"5898e899-0eec-4cbe-b38f-b5dab6755c18\" |\n| last_resolved_on | String (ISO datetime) or null | When record was last resolved | null |\n| total_instance_data_count | Integer | Total count of all instance data | 1 |\n| total_filtered_instance_data_count | Integer | Total count after applying filters | 1 |\n| dismissed_monitored_service | Array[Integer] | Array of dismissed monitored service IDs | [] |\n| dismissed_environments | Array[Integer] | Array of dismissed environment IDs | [] |\n*/\n\n{\n \"id\": 3563,\n \"created\": \"2022-06-10T08:23:31.577633Z\",\n \"modified\": \"2023-02-24T23:41:07.792650Z\",\n \"external_id\": null,\n \"created_by\": 1010,\n \"modified_by\": 1010,\n \"owner\": null,\n \"label\": \"User information insight\",\n \"description\": \"Description about what this insight is all about.\",\n \"service_type\": \"sfdc\",\n \"insight_type\": \"posture\",\n \"insight_category\": \"authorization\",\n \"risk_score\": 75,\n \"risk_level\": \"high\",\n \"appomni_risk_score\": null,\n \"appomni_risk_level\": null,\n \"confidence\": 80,\n \"first_seen\": \"2022-06-10T08:23:31.577740Z\",\n \"last_seen\": \"2023-02-24T08:09:10.789875Z\",\n \"last_evaluated\": \"2023-02-24T15:16:48.132672Z\",\n \"instance_data_count\": 1,\n \"inactive_instance_data_count\": 0,\n \"instance_count\": 1,\n \"inactive_instance_count\": 0,\n \"resolved_instance_data_count\": 0,\n \"status\": \"dismissed\",\n \"tags\": [],\n \"dismissal_expires\": \"2023-02-28T08:00:00Z\",\n \"dismissed_on\": \"2023-02-24T23:41:07.788351Z\",\n \"internal_name\": \"TheInternalNameGivenToThisInsight\",\n \"external_data\": null,\n \"internal_id\": \"5898e899-0eec-4cbe-b38f-b5dab6755c18\",\n \"last_resolved_on\": null,\n \"total_instance_data_count\": 1,\n \"total_filtered_instance_data_count\": 1,\n \"dismissed_monitored_service\": [],\n \"dismissed_environments\": []\n}"}],"_postman_id":"df411fab-345f-4843-b6f5-5a9e93976dfa"},{"name":"List Occurrences (DB)","id":"c8dd9da3-edfe-4076-801d-77f5ed068f6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/insights/discoveredinsightinstanceoccurrence/?limit=100&offset=0","description":"Returns a list of occurrences for all Insights for a tenant.
\nNOTE: The default behavior of this endpoint uses pagination with a limit of 100 results per request, so you do not need to specify offset or limit.
However, changing the default limit is supported and offset is still required to access additional pages apart from the first one.
Response Structure: The actual API response wraps this data in a paginated format with count, next, previous, and results fields
Status Values: Common values include \"open\", \"dismissed\", \"closed\"
Service Types: Common values include \"sfdc\", \"m365\", \"box\", \"gws\"
Data Array: Contains detailed field information with data_type, key, value, md_kind, and md_version
\nMessage Data: Structured format for displaying occurrence details in UI
\nArray[String]; One of open, dismissed
\n","type":"text/plain"},"key":"status","value":"status__in=[\"{{occurrence_status}}\"]"},{"disabled":true,"description":{"content":"Array[Integer]; Filter occurrences to display only Monitored Services with specified tags
\n","type":"text/plain"},"key":"monitored_service__tags__in","value":"[{{tag1_id}},{{tag2_id}}]"},{"disabled":true,"description":{"content":"Array[Integer]; Filter occurrences to display a list of specified Monitored Service IDs
\n","type":"text/plain"},"key":"monitored_service__in","value":"[{{ms1_id}},{{ms2_id}}]"},{"description":{"content":"Integer; Defaults to 100, max 1000
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"Integer; Pagination offset
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Integer; Returns occurrences for a given insight, for all instances under the specified insight
\n","type":"text/plain"},"key":"discovered_insight","value":"{{insight_id}}"},{"disabled":true,"description":{"content":"Integer; Returns occurrences for a single instance (previously also known as threads)
\n","type":"text/plain"},"key":"discovered_insight_instance","value":"{{insight_instance_id}}"}],"variable":[]}},"response":[{"id":"ce42fc82-b555-404e-a2c4-850cfb559fc6","name":"List Occurrences (DB)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain]/api/v1/insights/discoveredinsightinstanceoccurrence/?limit=100","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","insights","discoveredinsightinstanceoccurrence",""],"query":[{"key":"limit","value":"100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1247,\n \"next\": \"https://example.appomni.com/api/v1/insights/discoveredinsightinstanceoccurrence/?limit=100&offset=100\",\n \"previous\": null,\n \"results\": [\n {\n \"DiscoveredInsightInstanceOccurrence_ai_tags+\": null,\n \"external_id\": null,\n \"org\": 23,\n \"owner\": null,\n \"created_by\": 65,\n \"modified_by\": 65,\n \"id\": \"98b3b123-e017-4377-b864-7134e5e2b84b\",\n \"unique_identifier\": \"{\\\"service_type\\\": \\\"sfdc\\\", \\\"object_type\\\": \\\"sobject\\\", \\\"monitored_service_id\\\": 81964, \\\"object_id\\\": \\\"0DBDX000000CmgL4AS\\\", \\\"perspective_id\\\": 169439}\",\n \"md_kind\": \"sfdc.aotypes.objects.sfdcserviceobject\",\n \"md_version\": 1,\n \"object_id\": \"0DBDX000000CmgL4AS\",\n \"object_label\": \"OmniCommunity#4638\",\n \"object_type\": \"sobject\",\n \"object_type_label\": \"SObject\",\n \"search_data\": \"network OmniCommunity#4638 https://business-app-4638-dev-ed.scratch.my.site.com/\",\n \"monitored_service_id\": 81964,\n \"discovered_insight\": 102455,\n \"discovered_insight_instance\": 317109,\n \"perspective\": 169439,\n \"data\": [\n {\n \"data_type\": \"field\",\n \"key\": \"id\",\n \"value\": \"0DBDX000000CmgL4AS\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"name\",\n \"value\": \"OmniCommunity#4638\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"sobjecttype\",\n \"value\": \"Network\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"object_name\",\n \"value\": \"network\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"object_label\",\n \"value\": \"Network\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"url\",\n \"value\": \"https://business-app-4638-dev-ed.scratch.my.site.com/\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n }\n ],\n \"first_seen\": \"2025-09-04T03:45:56.443826+00:00\",\n \"last_seen\": \"2025-09-10T04:52:47.726083+00:00\",\n \"dismissed_by\": null,\n \"dismissal_message\": null,\n \"created\": \"2025-09-04T03:45:56.471885+00:00\",\n \"modified\": \"2025-09-10T04:52:47.726083+00:00\",\n \"sobject_name\": \"network\",\n \"sobject_label\": \"Network\",\n \"table_name\": null,\n \"internal_table_name\": null,\n \"record_type\": null,\n \"ai_tags\": null,\n \"di_status\": \"open\",\n \"dii_status\": \"open\",\n \"monitored_service_name\": \"SFDC-Coretest-Scratch-Int\",\n \"service_type\": \"sfdc\",\n \"perspective_username\": \"test-voxziptfghvx@example.com\",\n \"thread_label\": \"Network\",\n \"internal_name\": \"sfdc.scheduled.guest.GuestAccessibleRecordsInsight\",\n \"risk_score\": 100,\n \"status\": \"open\",\n \"dismissal_reason_value\": null,\n \"remediation_due\": null,\n \"remediation_start\": null,\n \"dismissed_on\": null,\n \"dismissal_expires\": null,\n \"message\": \"SObject: network\\nRecord: OmniCommunity#4638\\nSite: https://business-app-4638-dev-ed.scratch.my.site.com/\\n\",\n \"message_data\": [\n {\n \"label\": \"SObject\",\n \"value\": \"network\",\n \"type\": \"string\"\n },\n {\n \"label\": \"Record\",\n \"value\": \"OmniCommunity#4638\",\n \"type\": \"string\"\n },\n {\n \"label\": \"Site\",\n \"value\": \"https://business-app-4638-dev-ed.scratch.my.site.com/\",\n \"type\": \"string\"\n }\n ],\n \"dynamic_data\": {\n \"sobject\": \"network\",\n \"record\": \"OmniCommunity#4638\",\n \"site\": \"https://business-app-4638-dev-ed.scratch.my.site.com/\"\n },\n \"dismissal_reason_label\": null\n }\n ]\n}"}],"_postman_id":"c8dd9da3-edfe-4076-801d-77f5ed068f6a"},{"name":"Get occurrence details (DB)","id":"decaaf85-4a88-4944-9a1c-46d983f438b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/insights/discoveredinsightinstanceoccurrence/:id/","description":"Returns the details for an occurrence when you pass the uid of occurrence. The API endpoint corresponds to database storage for Insights.
\nStatus definitions:
Statuses may be:
Status types:
\nString (UUID); Unique identifier for the occurrence
\n","type":"text/plain"},"type":"any","value":"{{occurrence_id}}","key":"id"}]}},"response":[{"id":"3e4457a4-f071-4375-85a3-cc23966019de","name":"Get occurrence details (DB)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain]/api/v1/insights/discoveredinsightinstanceoccurrence/:id/","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","insights","discoveredinsightinstanceoccurrence",":id",""],"variable":[{"key":"id","value":"b65b4c33-dcbc-4844-b9e0-807408b347b4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"external_id\": null,\n \"org\": 177,\n \"owner\": null,\n \"created_by\": 3362,\n \"modified_by\": 3362,\n \"id\": \"b65b4c33-dcbc-4844-b9e0-807408b347b4\",\n \"unique_identifier\": \"{\\\"service_type\\\": \\\"sfdc\\\", \\\"object_type\\\": \\\"sobject\\\", \\\"monitored_service_id\\\": 26063, \\\"object_id\\\": \\\"permissionset/PermissionsCanVerifyComment\\\", \\\"perspective_id\\\": null}\",\n \"md_kind\": \"sfdc.aotypes.objects.sfdcserviceobject\",\n \"md_version\": 1,\n \"object_id\": \"permissionset/PermissionsCanVerifyComment\",\n \"object_label\": \"\",\n \"object_type\": \"sobject\",\n \"object_type_label\": \"SObject\",\n \"search_data\": \"Permission Set Verify Answers to Chatter Questions\",\n \"monitored_service_id\": 26063,\n \"discovered_insight\": 4661,\n \"discovered_insight_instance\": 109830,\n \"perspective\": null,\n \"data\": [\n {\n \"data_type\": \"field\",\n \"key\": \"sobject_label\",\n \"value\": \"Permission Set\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"sobject_name\",\n \"value\": \"permissionset\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"field_label\",\n \"value\": \"Verify Answers to Chatter Questions\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"field_name\",\n \"value\": \"PermissionsCanVerifyComment\",\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n },\n {\n \"data_type\": \"field\",\n \"key\": \"field_count\",\n \"value\": 15782,\n \"md_kind\": \"ServiceObjectData\",\n \"md_version\": 1\n }\n ],\n \"first_seen\": \"2023-08-24T02:27:35.704700+00:00\",\n \"last_seen\": \"2023-10-13T13:22:35.929543+00:00\",\n \"created\": \"2023-08-24T02:27:36.841438+00:00\",\n \"modified\": \"2023-10-13T13:22:35.929543+00:00\",\n \"sobject_name\": \"schema\",\n \"sobject_label\": \"schema\",\n \"table_name\": null,\n \"internal_table_name\": null,\n \"di_status\": \"open\",\n \"dii_status\": \"open\",\n \"monitored_service_name\": \"AppOmni\",\n \"service_type\": \"sfdc\",\n \"perspective_username\": null,\n \"thread_label\": \"schema\",\n \"internal_name\": \"sfdc.scheduled.schema.InlineHelpTextMissingInsight\",\n \"risk_score\": 0,\n \"status\": \"open\",\n \"dismissal_reason_value\": null,\n \"remediation_due\": null,\n \"remediation_start\": \"2023-08-24T02:27:35.704700+00:00\",\n \"dismissed_on\": null,\n \"dismissal_expires\": null,\n \"message\": \"sObject: Permission Set\\nField: Verify Answers to Chatter Questions\\n\",\n \"message_data\": [\n {\n \"label\": \"sObject\",\n \"value\": \"Permission Set\",\n \"type\": \"string\"\n },\n {\n \"label\": \"Field\",\n \"value\": \"Verify Answers to Chatter Questions\",\n \"type\": \"string\"\n }\n ],\n \"dynamic_data\": {\n \"sobject\": \"Permission Set\",\n \"field\": \"Verify Answers to Chatter Questions\"\n },\n \"dismissal_reason_label\": null\n}"}],"_postman_id":"decaaf85-4a88-4944-9a1c-46d983f438b2"},{"name":"Bulk dismiss Occurrences (DB)","id":"1a4a2a6d-ac6f-475c-b713-2a5552a28d1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\"discovered_insight_instance_occurrence__in\":[\"{{occurrence_uuid}}\"]}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/insights/discoveredinsightinstanceoccurrence/bulk_dismiss/","description":"Dismisses a list of occurrences when you pass the uids (comma delimited). The API endpoint corresponds to database storage for Insights.
\nRestores a list of occurrences when you pass the uids (comma delimited). The API endpoint corresponds to database storage for Insights.
\nThis request returns a list of users and user details configured for the AppOmni Instance being queried.
\nAs of October 2025, this endpoint is only functional for users with the roles of User Manager, Admin, or Read-only.
\nFor users with roles other than User Manager, Admin, or Read-only, see the /limited-user endpoint, which will allow access to a subset of the user data.
Array[Integer]; Limits results to users posessing one or more of the listed role IDs
\n","type":"text/plain"},"key":"role__in","value":"role__in=[123,456]"},{"disabled":true,"description":{"content":"Boolean; Limits results to either active or inactive users
\n","type":"text/plain"},"key":"is_active","value":"is_active=true"},{"disabled":true,"description":{"content":"Array[Integer]; Limits results to users with access to one or more of the listed environment tag IDs
\n","type":"text/plain"},"key":"environments_allowed__in","value":"environments_allowed__in=[1,2,4]"},{"disabled":true,"description":{"content":"String; Name of the field by which to order results
\n","type":"text/plain"},"key":"ordering","value":"ordering=first_name"},{"disabled":true,"description":{"content":"String; Limits results to users with a username, first_name, last_name, or email which contains the search term
\n","type":"text/plain"},"key":"search","value":"search=searchterm"}],"variable":[]}},"response":[{"id":"94ffa1e6-ad63-4bbf-9686-5f28d5a7e76a","name":"List Users","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 123,\n \"username\": \"user1@example.com\",\n \"email\": \"user1@example.com\",\n \"first_name\": \"User\",\n \"last_name\": \"One\",\n \"phone\": null,\n \"title\": null,\n \"is_active\": true,\n \"locked\": false,\n \"locked_at\": null,\n \"groups\": [\n 789\n ],\n \"created\": \"2024-03-30T17:19:31.240005Z\",\n \"modified\": \"2024-04-20T17:45:53.328790Z\",\n \"external_id\": null,\n \"timezone\": \"UTC\",\n \"mfa_enabled\": \"totp\",\n \"phone_verified\": false,\n \"is_mfa_verified\": true,\n \"sso_enabled\": false,\n \"jit_provisioned\": true,\n \"scim_provisioned\": false,\n \"org_id\": 1,\n \"last_ao_login\": \"2024-04-20T17:45:53.328493Z\",\n \"last_login_type\": \"direct\",\n \"environment_restricted\": false,\n \"environments\": [],\n \"can_environment_restrict\": false,\n \"override_enable_direct_login\": false,\n \"last_password_change\": null\n },\n {\n \"id\": 124,\n \"username\": \"user2@example.com\",\n \"email\": \"user2@example.com\",\n \"first_name\": \"User\",\n \"last_name\": \"Two\",\n \"phone\": null,\n \"title\": null,\n \"is_active\": true,\n \"locked\": false,\n \"locked_at\": null,\n \"groups\": [\n 789,\n 790\n ],\n \"created\": \"2024-04-20T15:14:47.108414Z\",\n \"modified\": \"2024-04-20T15:14:47.403189Z\",\n \"external_id\": null,\n \"timezone\": \"UTC\",\n \"mfa_enabled\": \"disabled\",\n \"phone_verified\": false,\n \"is_mfa_verified\": false,\n \"sso_enabled\": true,\n \"jit_provisioned\": true,\n \"scim_provisioned\": false,\n \"org_id\": 1,\n \"last_ao_login\": \"2024-04-20T15:14:47.393591Z\",\n \"last_login_type\": \"google\",\n \"environment_restricted\": false,\n \"environments\": [],\n \"can_environment_restrict\": true,\n \"override_enable_direct_login\": false,\n \"last_password_change\": null\n },\n {\n \"id\": 125,\n \"username\": \"user3@example.com\",\n \"email\": \"user3@example.com\",\n \"first_name\": \"User\",\n \"last_name\": \"Three\",\n \"phone\": null,\n \"title\": null,\n \"is_active\": true,\n \"locked\": false,\n \"locked_at\": null,\n \"groups\": [\n 790\n ],\n \"created\": \"2023-03-20T18:58:55.653498Z\",\n \"modified\": \"2023-03-20T19:26:48.874948Z\",\n \"external_id\": null,\n \"timezone\": \"UTC\",\n \"mfa_enabled\": \"disabled\",\n \"phone_verified\": false,\n \"is_mfa_verified\": false,\n \"sso_enabled\": true,\n \"jit_provisioned\": true,\n \"scim_provisioned\": false,\n \"org_id\": 1,\n \"last_ao_login\": \"2023-03-20T19:26:48.874610Z\",\n \"last_login_type\": \"google\",\n \"environment_restricted\": false,\n \"environments\": [],\n \"can_environment_restrict\": false,\n \"override_enable_direct_login\": false,\n \"last_password_change\": null\n }\n]"},{"id":"680e423b-bafe-4558-81d1-7b60125d6a16","name":"List Users from Specific Role","originalRequest":{"method":"GET","header":[],"url":{"raw":"?role__in=[567]","query":[{"key":"role__in","value":"[567]"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 123,\n \"username\": \"user1@example.com\",\n \"email\": \"user1@example.com\",\n \"first_name\": \"User\",\n \"last_name\": \"One\",\n \"phone\": null,\n \"title\": null,\n \"is_active\": true,\n \"locked\": false,\n \"locked_at\": null,\n \"groups\": [\n 567\n ],\n \"created\": \"2023-03-30T17:19:31.240005Z\",\n \"modified\": \"2023-04-20T17:45:53.328790Z\",\n \"external_id\": null,\n \"timezone\": \"UTC\",\n \"mfa_enabled\": \"disabled\",\n \"phone_verified\": false,\n \"is_mfa_verified\": true,\n \"sso_enabled\": true,\n \"jit_provisioned\": true,\n \"scim_provisioned\": false,\n \"org_id\": 1,\n \"last_ao_login\": \"2023-04-20T17:45:53.328493Z\",\n \"last_login_type\": \"google\",\n \"environment_restricted\": false,\n \"environments\": [],\n \"can_environment_restrict\": false,\n \"override_enable_direct_login\": false,\n \"last_password_change\": null\n }\n]"}],"_postman_id":"f6a53e44-53d7-4649-97d7-ee540f9ef1a1"},{"name":"List users for roles with limited permissions","id":"94c4d85d-572e-47ad-97cd-8f4164dd4047","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/limited-user/","description":"This endpoint is for users that have roles other than User Manager, Admin, or Read-only. It allows access to a subset of user information that is available to User Manager, Admin, or Read-only.
\nReturns a list of users and limited user details configured for the AppOmni Instance being queried.
\nString
\n","type":"text/plain"},"key":"username","value":"user1@example.com"},{"disabled":true,"description":{"content":"JSON list of strings
\n","type":"text/plain"},"key":"username__in","value":""},{"disabled":true,"description":{"content":"Boolean; Limits results to either active or inactive users
\n","type":"text/plain"},"key":"is_active","value":"is_active=true"},{"disabled":true,"description":{"content":"String; Name of the field by which to order results.
\n","type":"text/plain"},"key":"ordering","value":"ordering=first_name"},{"disabled":true,"description":{"content":"String; Limits results to users with a username, first_name, last_name, or email which contains the search term
\n","type":"text/plain"},"key":"search","value":"search=searchterm"}],"variable":[]}},"response":[{"id":"f711307e-7055-4771-b838-afbeaba74205","name":"List users for roles with limited permissions","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 13524,\n \"email\": \"james.page@example.com\",\n \"first_name\": \"James\",\n \"last_name\": \"Page\",\n \"username\": \"PageyCS\",\n \"is_active\": true\n },\n {\n \"id\": 40167,\n \"email\": \"marie.kondo@example.com\",\n \"first_name\": \"Marie\",\n \"last_name\": \"Kondo\",\n \"username\": \"MKondo\",\n \"is_active\": true\n },\n]\n"}],"_postman_id":"94c4d85d-572e-47ad-97cd-8f4164dd4047"},{"name":"List users by ID for roles with limited permissions","id":"14e457c7-1769-4d4b-ae6d-8f9021f73541","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/limited-user/:id/","description":"This endpoint is for users that have roles other than User Manager, Admin, or Read-only. It allows access to a subset of user information that is available to User Manager, Admin, or Read-only.
\nReturns a list of users by id and limited user details configured for the AppOmni Instance being queried.
\nString
\n","type":"text/plain"},"key":"username","value":"user1@example.com"},{"disabled":true,"description":{"content":"JSON list of strings
\n","type":"text/plain"},"key":"username__in","value":""},{"disabled":true,"description":{"content":"Boolean; Limits results to either active or inactive users
\n","type":"text/plain"},"key":"is_active","value":"is_active=true"},{"disabled":true,"description":{"content":"String; Name of the field by which to order results.
\n","type":"text/plain"},"key":"ordering","value":"ordering=first_name"},{"disabled":true,"description":{"content":"String; Limits results to users with a username, first_name, last_name, or email which contains the search term
\n","type":"text/plain"},"key":"search","value":"search=searchterm"}],"variable":[{"description":{"content":"Integer; Unique ID of the user
\n","type":"text/plain"},"type":"any","value":"12345","key":"id"}]}},"response":[{"id":"ad7071a4-0d9a-4824-91aa-4af6f91b764e","name":"List users by ID for roles with limited permissions","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 13524,\n \"email\": \"james.page@example.com\",\n \"first_name\": \"James\",\n \"last_name\": \"Page\",\n \"username\": \"PageyCS\",\n \"is_active\": true\n },\n {\n \"id\": 40167,\n \"email\": \"marie.kondo@example.com\",\n \"first_name\": \"Marie\",\n \"last_name\": \"Kondo\",\n \"username\": \"MKondo\",\n \"is_active\": true\n },\n]\n"}],"_postman_id":"14e457c7-1769-4d4b-ae6d-8f9021f73541"},{"name":"List RBAC Roles","id":"ccd435f1-1f86-479d-9a10-bcab1a968a4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/group/","description":"Returns a list of AppOmni roles (permissions) and their identifiers.
\nReturns the details for the user specified by the id passed in the URL.
Integer; The ID of the User to get details for
\n","type":"text/plain"},"type":"any","value":"{{user_id}}","key":"id"}]}},"response":[{"id":"a397aa6f-7c19-407a-ba8b-0cb5540e9a94","name":"Get user details (roles)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain]/api/v1/core/user/:id/","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","core","user",":id",""],"variable":[{"key":"id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 9538,\n \"username\": \"user2@example.com\",\n \"email\": \"user2@example.com\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"phone\": null,\n \"title\": null,\n \"is_active\": true,\n \"locked\": false,\n \"locked_at\": null,\n \"override_enable_direct_login\": false,\n \"groups\": [\n 1392\n ],\n \"created\": \"2023-03-30T17:19:31.240005Z\",\n \"modified\": \"2023-04-20T17:45:53.328790Z\",\n \"external_id\": null,\n \"timezone\": \"UTC\",\n \"mfa_enabled\": \"disabled\",\n \"phone_verified\": false,\n \"is_mfa_verified\": false,\n \"sso_enabled\": true,\n \"jit_provisioned\": true,\n \"scim_provisioned\": false,\n \"org_id\": 177,\n \"last_ao_login\": \"2023-04-20T17:45:53.328493Z\",\n \"last_login_type\": \"google\",\n \"environment_restricted\": false,\n \"environments\": [],\n \"can_environment_restrict\": false,\n \"last_password_change\": null\n}"}],"_postman_id":"772ac39b-58bf-422d-9bf5-6cb11ca42bb3"},{"name":"Add or remove user permissions","id":"92678549-dad6-4034-94d8-1b96fcaa8b44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"groups\": [{{group_id}}]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/user/:id/","description":"The groups array contains all group IDs to be assigned to a user. This example shows how to update RBAC roles for a user.
\nInteger; The ID of the User to update permissions for
\n","type":"text/plain"},"type":"any","value":"{{user_id}}","key":"id"}]}},"response":[{"id":"65ef65ad-98f8-4de2-afb0-b1d891a7552d","name":"Add or remove user permissions","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"groups\": [1397]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[your_subdomain]/api/v1/core/user/:id/","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","core","user",":id",""],"variable":[{"key":"id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 10345,\n \"username\": \"user3@example.com\",\n \"email\": \"user3@example.com\",\n \"first_name\": \"Bob\",\n \"last_name\": \"Smith\",\n \"phone\": null,\n \"title\": null,\n \"is_active\": true,\n \"locked\": false,\n \"locked_at\": null,\n \"override_enable_direct_login\": false,\n \"groups\": [\n 1397,\n 1394\n ],\n \"created\": \"2023-04-20T16:45:39.059190Z\",\n \"modified\": \"2023-05-12T12:22:29.895482Z\",\n \"external_id\": null,\n \"timezone\": \"UTC\",\n \"mfa_enabled\": \"disabled\",\n \"phone_verified\": false,\n \"is_mfa_verified\": false,\n \"sso_enabled\": false,\n \"jit_provisioned\": false,\n \"scim_provisioned\": false,\n \"org_id\": 177,\n \"last_ao_login\": null,\n \"last_login_type\": null,\n \"environment_restricted\": false,\n \"environments\": [],\n \"can_environment_restrict\": true,\n \"last_password_change\": null\n}"}],"_postman_id":"92678549-dad6-4034-94d8-1b96fcaa8b44"},{"name":"Deactivate or Activate User","id":"d5ba17c1-19c4-4feb-a195-9295e0593b26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"is_active\": {{is_active_status}}\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/user/:id/","description":"In AppOmni users are not deleted. When users no longer require access, they are deactivated (their status is set to Inactive). This endpoint is used to deactivate users.
\nChange the status of a user from active to inactive (or vice versa) when the user id is passed.
\nInteger; The ID of the User to deactivate or activate
\n","type":"text/plain"},"type":"any","value":"{{user_id}}","key":"id"}]}},"response":[{"id":"8ec6404f-9564-4641-9795-6aefac016e9e","name":"Deactivate User","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"is_active\": \"false\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[your_subdomain]/api/v1/core/user/:id/","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","core","user",":id",""],"variable":[{"key":"id","value":"15050"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 15050,\n \"username\": \"user4@example.com\",\n \"email\": \"user4@example.com\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"phone\": \"null\",\n \"title\": \"null\",\n \"is_active\": false,\n \"locked\": false,\n \"locked_at\": null,\n \"override_enable_direct_login\": false,\n \"groups\": [\n 1392,\n 1394\n ],\n \"created\": \"2023-08-07T15:57:21.503302Z\",\n \"modified\": \"2023-08-07T18:17:50.678319Z\",\n \"external_id\": null,\n \"timezone\": \"UTC\",\n \"mfa_enabled\": \"disabled\",\n \"phone_verified\": false,\n \"is_mfa_verified\": false,\n \"sso_enabled\": false,\n \"jit_provisioned\": false,\n \"scim_provisioned\": false,\n \"org_id\": 177,\n \"last_ao_login\": null,\n \"last_login_type\": null,\n \"environment_restricted\": false,\n \"environments\": [],\n \"can_environment_restrict\": false,\n \"last_password_change\": null\n}"},{"id":"00376c80-2a83-42da-928a-c15b7a5719c6","name":"Reactivate User","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"is_active\": \"true\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[your_subdomain]/api/v1/core/user/:id/","protocol":"https","host":["[your_subdomain]"],"path":["api","v1","core","user",":id",""],"variable":[{"key":"id","value":"15050"}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 15050,\n \"username\": \"user4@example.com\",\n \"email\": \"user4@example.com\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"phone\": \"null\",\n \"title\": \"null\",\n \"is_active\": true,\n \"locked\": false,\n \"locked_at\": null,\n \"override_enable_direct_login\": false,\n \"groups\": [\n 1392,\n 1394\n ],\n \"created\": \"2023-08-07T15:57:21.503302Z\",\n \"modified\": \"2023-08-07T18:17:50.678319Z\",\n \"external_id\": null,\n \"timezone\": \"UTC\",\n \"mfa_enabled\": \"disabled\",\n \"phone_verified\": false,\n \"is_mfa_verified\": false,\n \"sso_enabled\": false,\n \"jit_provisioned\": false,\n \"scim_provisioned\": false,\n \"org_id\": 177,\n \"last_ao_login\": null,\n \"last_login_type\": null,\n \"environment_restricted\": false,\n \"environments\": [],\n \"can_environment_restrict\": false,\n \"last_password_change\": null\n}"}],"_postman_id":"d5ba17c1-19c4-4feb-a195-9295e0593b26"},{"name":"Add User","id":"f9e4ed81-655a-41b5-b1e4-03bbb3a7322c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"{{username}}\",\n \"email\": \"{{email}}\",\n \"first_name\": \"{{first_name}}\",\n \"last_name\": \"{{last_name}}\",\n \"phone\": \"{{phone}}\",\n \"title\": \"{{title}}\",\n \"is_active\": {{is_active}},\n \"override_enable_direct_login\": {{override_enable_direct_login}},\n \"groups\": [{{group_ids}}],\n \"environment_restricted\": {{environment_restricted}},\n \"environments\": [{{environment_ids}}]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/user/","description":"Creates a new user.
\nReturns the details of the user created, including the generated id.
Use this endpoint to enable breakglass access for emergency scenarios, so that authorized users can bypass standard SSO restrictions during critical incidents. This can only be called by an administrator, and will return a successful status of 204.
\nInteger; The ID of the User to enable breakglass access for
\n","type":"text/plain"},"type":"any","value":"{{user_id}}","key":"user_id"}]}},"response":[],"_postman_id":"febf7961-30f8-4b99-9e0a-964d1a2d2174"},{"name":"Disable breakglass access for emergencies","id":"66d88ded-e04c-46f6-8f29-f5c0dce44f70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/user/:user_id/disable_breakglass","description":"Use this endpoint to disable breakglass access for emergency scenarios, so that authorized users can bypass standard SSO restrictions during critical incidents. This can only be called by an administrator, and will return a successful status of 204.
\nInteger; The ID of the User to disable breakglass access for
\n","type":"text/plain"},"type":"any","value":"{{user_id}}","key":"user_id"}]}},"response":[],"_postman_id":"66d88ded-e04c-46f6-8f29-f5c0dce44f70"}],"id":"ebdf5a5e-1b3d-4606-a779-5e043b822ef4","_postman_id":"ebdf5a5e-1b3d-4606-a779-5e043b822ef4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a list of all unified identities.
\nInteger; Maximum number of records to return per page.
\n","type":"text/plain"},"key":"limit","value":"25"},{"disabled":true,"description":{"content":"Integer; Number of records to skip before starting to return results.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Array[String]; Filters by identity status (e.g., active, inactive, etc.).
\n","type":"text/plain"},"key":"identity_status__in","value":"[\"active\", \"inactive\"]"},{"disabled":true,"description":{"content":"ISO 8601 DateTime; Filters for users whose last login is on or after the specified time.
\n","type":"text/plain"},"key":"last_login__gte","value":"2024-09-01T00:00:00Z"},{"disabled":true,"description":{"content":"ISO 8601 DateTime; Filters for users whose last login is on or before the specified time.
\n","type":"text/plain"},"key":"last_login__lte","value":"2024-09-30T23:59:59Z"},{"disabled":true,"description":{"content":"Array[String]; Filters by one or more user permission levels.
\n","type":"text/plain"},"key":"permission_level__in","value":"[\"admin\", \"elevated\", \"standard\"]"},{"disabled":true,"description":{"content":"Array[Integer]; Filters results by a list of linked service IDs.
\n","type":"text/plain"},"key":"services_linked__in","value":"[10861, 25811, 59855]"},{"disabled":true,"description":{"content":"String; Performs a keyword-based search across user-relevant fields (linked username).
\n","type":"text/plain"},"key":"search","value":"John"},{"disabled":true,"description":{"content":"Array[String]; Filters results by service type names.
\n","type":"text/plain"},"key":"service_types__in","value":"[\"m365\", \"gws\", \"slack\", \"zoom\"]"},{"disabled":true,"description":{"content":"Array[Integer]; Filters results by a list of tag IDs.
\n","type":"text/plain"},"key":"tags__in","value":"[100, 200, 300]"}],"variable":[]}},"response":[{"id":"72c09bbd-e924-4997-b2a8-342bf97472cd","name":"List Unified Identities","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"AppOmni API Token","type":"text","disabled":true}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/unifiedidentity/annotated_list/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","unifiedidentity","annotated_list",""],"query":[{"key":"limit","value":"limit=25","description":"Integer; Maximum number of records to return per page.","disabled":true},{"key":"offset","value":"offset=25","description":"Integer; Number of records to skip before starting to return results.","disabled":true},{"key":"identity_status__in","value":"identity_status__in=[%22active%22]","description":"Array[String]; Filters by identity status (e.g., active, inactive, etc.).","disabled":true},{"key":"last_login__gte","value":"last_login__gte=2025-03-04T08:00:00.000Z","description":"ISO 8601 DateTime; Filters for users whose last login is on or after the specified time.","disabled":true},{"key":"last_login__lte","value":"last_login__lte=2025-03-10T07:00:59.999Z","description":"ISO 8601 DateTime; Filters for users whose last login is on or before the specified time.","disabled":true},{"key":"permission_level__in","value":"permission_level__in=[%22admin%22,%22elevated%22]","description":"Array[String]; Filters by one or more user permission levels. ","disabled":true},{"key":"services_linked__in","value":"services_linked__in=[58956]","description":"Array[Integer]; Filters results by a list of linked service IDs.","disabled":true},{"key":"search","value":"search=John","description":"String; Performs a keyword-based search across user-relevant fields (linked username).","disabled":true},{"key":"service_types__in","value":"service_types__in=[%22lucid%22]","description":"Array[String]; Filters results by service type names.","disabled":true},{"key":"tags__in","value":"tags__in=[234390]","description":"Array[Integer]; Filters results by a list of tag IDs.","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"count\": -1,\n \"next\": \"https://coretest.int.appomni.com/api/v1/core/unifiedidentity/?limit=100&offset=100\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 143568, // This is the internal ID of the unified identities, it can be used in the details endpoint \n \"identity_id\": \"8590914a-a00a-4d0a-a9f4-626803eb9c1e\", // This is an external reference ID for the identity\n \"services_linked\": [ // These are IDs of monitored services that has a linked MSU\n 10861,\n 25811,\n 59855,\n 59856\n ],\n \"service_types\": [ // These are unique names of monitored service types that have a linked MSU\n \"lucid\",\n \"zoom\"\n ],\n \"service_names\": [ // These are names of monitored services that have a linked MSU\n \"Lucid - 098453\",\n \"lucid-vj\",\n \"lucid-vj-2\",\n \"Zoom Monitored Service 1\"\n ]\n // ... other fields omitted\n }\n ]\n}"}],"_postman_id":"5a52042d-ded5-4a8e-855c-397e41399a76"},{"name":"Unified identity details","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","pm.test(\"Response Policy ID is correct\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.id).to.eql(parseInt(pm.variables.get(\"policy_id\")));","});"],"type":"text/javascript","packages":{},"id":"31cd043f-71d0-440d-b115-70ca669076ec"}}],"id":"68c52303-bc79-4436-8d1e-d10a70dd48e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/unifiedidentity/{{identity_id}}/","description":"Returns details for a specific unified identity. Use the id from the List Unified Identities endpoint response above.
Integer;
Maximum number of records to return per page.
Integer; Number of records to skip before starting to return results.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Array[String]; Filters by identity status (e.g., active, inactive, etc.).
\n","type":"text/plain"},"key":"identity_status__in","value":"[\"active\", \"inactive\"]"},{"disabled":true,"description":{"content":"ISO 8601 DateTime; Filters for users whose last login is on or after the specified time.
\n","type":"text/plain"},"key":"last_login__gte","value":"2024-09-01T00:00:00Z"},{"disabled":true,"description":{"content":"ISO 8601 DateTime; Filters for users whose last login is on or before the specified time.
\n","type":"text/plain"},"key":"last_login__lte","value":"2024-09-30T23:59:59Z"},{"disabled":true,"description":{"content":"Array[String]; Filters by one or more user permission levels.
\n","type":"text/plain"},"key":"permission_level__in","value":"[\"admin\", \"elevated\", \"standard\"]"},{"disabled":true,"description":{"content":"String; Performs a keyword-based search across user-relevant fields (linked username)
\n","type":"text/plain"},"key":"search","value":"John"},{"disabled":true,"description":{"content":"Array[Integer]; Filters results by a list of linked service IDs.
\n","type":"text/plain"},"key":"services_linked__in","value":"[10861, 25811, 59855]"},{"disabled":true,"description":{"content":"Array[String]; Filters results by service type names.
\n","type":"text/plain"},"key":"service_types__in","value":"[\"m365\", \"gws\", \"slack\", \"zoom\"]"},{"disabled":true,"description":{"content":"Array[Integer]; Filters results by a list of tag IDs.
\n","type":"text/plain"},"key":"tags__in","value":"[100, 200, 300]"}],"variable":[{"description":{"content":"Integer; The ID of the unified identity to get details for
\n","type":"text/plain"},"type":"any","value":"{{identity_id}}","key":"identity_id"}]}},"response":[{"id":"56e80354-0bc2-4f33-a727-a5d40889e6a2","name":"Get Identity Details by UUID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/unifiedidentity/:identity_id","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","unifiedidentity",":identity_id"],"variable":[{"key":"identity_id","value":"f9eaf6ad-bf00-446f-a370-ad3515e20aae","description":"Identity ID or UUID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jun 2022 17:13:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Authorization, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"8/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 13211,\n \"created\": \"2021-10-22T01:34:03.069775Z\",\n \"modified\": \"2021-10-22T01:34:03.069782Z\",\n \"external_id\": null,\n \"identity_id\": \"f9eaf6ad-bf00-446f-a370-ad3515e20aae\",\n \"identity_status\": \"active\",\n \"identity_signature\": \"se@appomni.com\",\n \"name\": \"Sales One Prod Authenticated\",\n \"name_akas\": [\n \"Sales One Dev Authenticated\",\n \"AppOmni SE's\",\n \"Platform 1\",\n \"se+it\",\n \"Rogue 2\",\n \"SE UAT\",\n \"SE Demo\",\n \"Solutions Engineering\",\n \"se+unsanctioneduser\",\n \"se+malicioususer\",\n \"se+leadership\",\n \"Rogue One\",\n \"Demo Prod\",\n \"Jasper Chik\",\n \"Core 1\",\n \"Demo Dev\",\n \"Sales One\",\n \"Rogue1\",\n \"se+support\",\n \"John Smith\",\n \"Sales one\",\n \"se+PMM\",\n \"Core2\"\n ],\n \"email\": \"se+prod-sales1-unauthenticated@appomni.com\",\n \"primary_rbac_element_names\": [\n \"Member\",\n \"System Administrator\",\n \"Custom: Sales Profile\",\n \"Super Administrator\"\n ],\n \"user_controlled\": false,\n \"idp_controlled\": false,\n \"num_users_linked\": 25,\n \"num_users_active\": 25,\n \"num_users_inactive\": 0,\n \"any_elevated\": true,\n \"any_admin\": true,\n \"services_linked\": [\n 7543,\n 7717,\n 7720,\n 11169,\n 11264,\n 12515\n ],\n \"user_label\": null,\n \"notes\": null,\n \"tags\": [],\n \"service_types\": [\n \"jira\",\n \"okta\",\n \"sfdc\",\n \"zoom\"\n ],\n \"service_names\": [\n \"Zoom - Prod\",\n \"SFDC - Prod\",\n \"SFDC - Dev (staging)\",\n \"Okta - Prod\",\n \"SFDC - UAT\",\n \"Jira - Prod\"\n ]\n}"}],"_postman_id":"68c52303-bc79-4436-8d1e-d10a70dd48e7"},{"name":"List monitored service users linked to a unified identity","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","pm.test(\"Response Policy ID is correct\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.id).to.eql(parseInt(pm.variables.get(\"policy_id\")));","});"],"type":"text/javascript","packages":{},"id":"7c02e779-84d6-4734-a71b-42d8816f53d4"}}],"id":"fada09dd-e6c6-415e-92d9-901b0422bc1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/unifiedidentity/{{identity_id}}/users","description":"Returns a list of monitored service users linked to a specific unified identity.
\nidentity_id may be used instead of id in this endpoint.
Integer; Maximum number of records to return per page.
\n","type":"text/plain"},"key":"limit","value":"25"},{"disabled":true,"description":{"content":"Integer; Number of records to skip before starting to return results.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"String; Filter results by user status. Accepts a JSON-encoded array of status strings.
\n","type":"text/plain"},"key":"user_status__in","value":"[\"active\", \"inactive\", \"disabled\"]"},{"disabled":true,"description":{"content":"Array[String]; Filter results by service type. Accepts a JSON-encoded array of strings.
\n","type":"text/plain"},"key":"service_type__in","value":"[%22lucid%22]"},{"disabled":true,"description":{"content":"Array[Integer]; Filter results by organization IDs. Accepts a JSON-encoded array of integers.
\n","type":"text/plain"},"key":"service_org_id__in","value":"[10861, 25811, 59855]"},{"disabled":true,"description":{"content":"Array[String]; Filter results by user permission levels. Accepts a JSON-encoded array of strings.
\n","type":"text/plain"},"key":"permission_level__in","value":"[\"admin\", \"elevated\", \"standard\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filters users whose last login is greater than or equal to the specified timestamp.
\n","type":"text/plain"},"key":"last_login__gte","value":"2024-09-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filters users whose last login is less than or equal to the specified timestamp.
\n","type":"text/plain"},"key":"last_login__lte","value":"2024-09-30T23:59:59Z"}],"variable":[{"description":{"content":"Integer; The ID of the unified identity to get linked users for
\n","type":"text/plain"},"type":"any","value":"{{identity_id}}","key":"identity_id"}]}},"response":[{"id":"ca44ccb0-630d-451e-ae09-9f157592960e","name":"List Monitored Service Users Linked to a Unified Identity","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/unifiedidentity/{id}/users","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","unifiedidentity","{id}","users"],"query":[{"key":"identity_id","value":"","description":"Unified Identity UUID","disabled":true},{"key":"service_org__in","value":"","description":"Filter Policy Issues to specified Monitored Service IDs","disabled":true},{"key":"service_org__type__in","value":"","description":"Filter Policy Issues to specified Monitored Service types","disabled":true},{"key":"service_org__tags__in","value":"","description":"Filter Policy Issues to Monitored Services with specified tags","disabled":true},{"key":"limit","value":"","description":"Defaults to 50, max 500","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"count\": 4,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 2906, // the AppOmni identifier for this monitored service user\n \"unified_identity_id\": 180452, //the unified identity this MSU is linked to\n \"service_org_id\": 25811, // the ID of the monitored service this MSU is from\n \"service_type\": \"lucid\", // the service type of the monitored service, this can be `custom` for customer monitored services\n \"service_type_slug\": \"lucid\", // the unique slug of the monitored service this MSU is from used for lookup\n \"service_org_name\": \"Lucid - 098453\", // name of the monitored service\n \"user_id\": \"lucid-177067822\", // id for the user within the monitored service itself\n },\n // ...other 3 results omitted"}],"_postman_id":"fada09dd-e6c6-415e-92d9-901b0422bc1a"},{"name":"Get monitored service user details","id":"eb1f28c9-ec48-432f-84de-33d8cf44eed4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/lucid/svcexp/{{service_org_id}}/user/{{user_id}}","description":"Returns the details of a specified monitored service user.
\nNote: Monitored service users are users detected by scans of a specific monitored service. These users should not be confused with AppOmni users, which are users who can login to the AppOmni console.
\nInteger; Maximum number of records to return per page.
\n","type":"text/plain"},"key":"limit","value":"25"},{"disabled":true,"description":{"content":"Integer; Number of records to skip before starting to return results.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"String; Filter results by user status. Accepts a JSON-encoded array of status strings.
\n","type":"text/plain"},"key":"user_status__in","value":"[\"active\", \"inactive\", \"disabled\"]"},{"disabled":true,"description":{"content":"Array[String]; Filter results by service type. Accepts a JSON-encoded array of strings.
\n","type":"text/plain"},"key":"service_type__in","value":"[%22lucid%22]"},{"disabled":true,"description":{"content":"Array[Integer]; Filter results by organization IDs. Accepts a JSON-encoded array of integers.
\n","type":"text/plain"},"key":"service_org_id__in","value":"[10861, 25811, 59855]"},{"disabled":true,"description":{"content":"Array[String]; Filter results by user permission levels. Accepts a JSON-encoded array of strings.
\n","type":"text/plain"},"key":"permission_level__in","value":"[\"admin\", \"elevated\", \"standard\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filters users whose last login is greater than or equal to the specified timestamp.
\n","type":"text/plain"},"key":"last_login__gte","value":"2024-09-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filters users whose last login is less than or equal to the specified timestamp.
\n","type":"text/plain"},"key":"last_login__lte","value":"2024-09-30T23:59:59Z"}],"variable":[{"description":{"content":"Integer; The ID of the service organization
\n","type":"text/plain"},"type":"any","value":"{{service_org_id}}","key":"service_org_id"},{"description":{"content":"Integer; The ID of the monitored service user
\n","type":"text/plain"},"type":"any","value":"{{user_id}}","key":"user_id"}]}},"response":[{"id":"7afeb908-b31f-486f-82a9-6bc38d86067e","name":"Get Monitored Service User Details","originalRequest":{"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/lucid/svcexp/{service_org_id}/user/{id}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2906, // id of the monitored service user\n \"user_id\": \"lucid-177067822\", //id for user within the monitored service\n \"unified_identity\": 180452, // Unified identity this monitored service user is linked to\n\n // .... \n}"}],"_postman_id":"eb1f28c9-ec48-432f-84de-33d8cf44eed4"}],"id":"87edb18e-de95-4ba5-b592-70e7e8cd406c","_postman_id":"87edb18e-de95-4ba5-b592-70e7e8cd406c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a paginated list of unified identities.
\nSpecified as query string parameters:
\nUse these public field names in ordering:
Examples:
\nordering=name
ordering=-last_login
ordering=permission_level,-name
Paged response wrapper:
\nUnified identity schema:
\n","urlObject":{"protocol":"https","path":["api","v1","identity","unifiedidentity",""],"host":["[your_subdomain]","appomni","com"],"query":[{"disabled":true,"key":"limit","value":"25"},{"disabled":true,"key":"offset","value":"0"},{"disabled":true,"key":"search","value":"test"},{"disabled":true,"key":"ordering","value":"name"},{"disabled":true,"key":"permission_level__in","value":"[\"admin\",\"elevated\"]"},{"disabled":true,"key":"services_linked__in","value":"[58886, 7887]"},{"disabled":true,"key":"service_types__in","value":"[\"sfdc\",\"okta\"]"}],"variable":[]}},"response":[{"id":"2e09f9f9-c079-409f-a4d1-22a6da9e393e","name":"List Unified Identities","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/identity/unifiedidentity/?limit=25&offset=0&ordering=name&permission_level__in=[\"admin\",\"elevated\"]&services_linked__in=[101, 102]&service_types__in=[\"github\",\"google_workspace\"]","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","identity","unifiedidentity",""],"query":[{"key":"limit","value":"25"},{"key":"offset","value":"0"},{"key":"search","value":"","disabled":true},{"key":"ordering","value":"name"},{"key":"permission_level__in","value":"[\"admin\",\"elevated\"]"},{"key":"services_linked__in","value":"[101, 102]"},{"key":"service_types__in","value":"[\"github\",\"google_workspace\"]"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"results\": [\n {\n \"any_admin\": true,\n \"any_elevated\": true,\n \"created\": \"2024-01-15T12:00:00Z\",\n \"email\": \"jane@example.com\",\n \"id\": \"4e5ab37b-7d39-4fa8-9f14-6f2e74d9cd1f\",\n \"identity_signature\": \"jane@example.com\",\n \"status\": \"active\",\n \"last_login\": \"2024-07-08T10:30:00Z\",\n \"modified\": \"2024-07-08T10:35:00Z\",\n \"name\": \"Jane Doe\",\n \"name_akas\": [\n \"Jane Doe\",\n \"Jane Ann Doe\"\n ],\n \"num_users_active\": 2,\n \"num_users_deprovisioned\": 0,\n \"num_users_disabled\": 0,\n \"num_users_highest_admin\": 1,\n \"num_users_highest_elevated\": 0,\n \"num_users_highest_standard\": 1,\n \"num_users_inactive\": 0,\n \"num_users_linked\": 2,\n \"num_users_unknown_activity\": 0,\n \"permission_level\": \"admin\",\n \"primary_rbac_element_names\": [\n \"admins\"\n ],\n \"service_types\": [\n \"github\",\n \"google_workspace\"\n ],\n \"service_names\": [\n \"GitHub\",\n \"Google Workspace\"\n ],\n \"services_linked\": [\n 101,\n 202\n ]\n }\n ]\n}"}],"_postman_id":"bd0df706-b662-4e03-a351-9c3589b3f737"},{"name":"Get Unified Identity","id":"9e546317-5fc1-4078-b1d8-f8b6dec97147","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/identity/unifiedidentity/{{identity_id}}/","description":"Returns details for the requested unified identity.
\nReturns a unified identity:
\n","urlObject":{"protocol":"https","path":["api","v1","identity","unifiedidentity","{{identity_id}}",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"43557441-b04d-4328-8946-30c22993fd7d","name":"Get Unified Identity","originalRequest":{"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/identity/unifiedidentity/{{identity_id}}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"any_admin\": false,\n \"any_elevated\": false,\n \"created\": \"2024-01-15T12:00:00Z\",\n \"email\": \"jane@example.com\",\n \"id\": \"4e5ab37b-7d39-4fa8-9f14-6f2e74d9cd1f\",\n \"identity_signature\": \"jane@example.com\",\n \"status\": \"active\",\n \"last_login\": \"2024-07-08T10:30:00Z\",\n \"modified\": \"2024-07-08T10:35:00Z\",\n \"name\": \"Jane Doe\",\n \"name_akas\": [\n \"Jane Doe\"\n ],\n \"num_users_active\": 1,\n \"num_users_deprovisioned\": 0,\n \"num_users_disabled\": 0,\n \"num_users_highest_admin\": 0,\n \"num_users_highest_elevated\": 0,\n \"num_users_highest_standard\": 1,\n \"num_users_inactive\": 0,\n \"num_users_linked\": 1,\n \"num_users_unknown_activity\": 0,\n \"permission_level\": \"standard\",\n \"primary_rbac_element_names\": [\n \"viewer\"\n ],\n \"service_types\": [\n \"github\"\n ],\n \"service_names\": [\n \"GitHub\"\n ],\n \"services_linked\": [\n 101\n ],\n}\n"}],"_postman_id":"9e546317-5fc1-4078-b1d8-f8b6dec97147"}],"id":"459be2d1-dbfd-47dc-8f82-06c2cad0b97c","_postman_id":"459be2d1-dbfd-47dc-8f82-06c2cad0b97c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a paginated list of service users.
\nSpecified as query string parameters.
\nUse these public field names in ordering:
Examples:
\nordering=username
ordering=-last_login
ordering=service_org_name,username
Paged response wrapper:
\nService user schema:
\n","urlObject":{"protocol":"https","path":["api","v1","identity","user",""],"host":["[your_subdomain]","appomni","com"],"query":[{"disabled":true,"key":"limit","value":"25"},{"disabled":true,"key":"offset","value":"0"},{"disabled":true,"key":"search","value":"test"},{"disabled":true,"key":"ordering","value":"name"},{"disabled":true,"key":"service_org_id__in","value":"[58886]"},{"disabled":true,"key":"user_status__in","value":"[\"active\",\"inactive\"]"},{"disabled":true,"key":"permission_level__in","value":"[\"admin\"]"},{"disabled":true,"key":"identity_id","value":"4d395724-3a6b-480a-be31-f9fdf9a08488"}],"variable":[]}},"response":[{"id":"3ed1aff3-b736-4c56-9725-f5317946b828","name":"List Service Users","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/identity/user/?limit=25&offset=0&ordering=-name&permission_level__in=[\"admin\",\"standard\"]&service_type__in=[\"sfdc\",\"github\"]","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","identity","user",""],"query":[{"key":"limit","value":"25"},{"key":"offset","value":"0"},{"key":"search","value":"","disabled":true},{"key":"ordering","value":"-name"},{"key":"permission_level__in","value":"[\"admin\",\"standard\"]"},{"key":"service_type__in","value":"[\"sfdc\",\"github\"]"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"results\": [\n {\n \"active\": true,\n \"created_at_date\": \"2024-01-15T12:00:00Z\",\n \"email\": \"jane@example.com\",\n \"has_admin_perms\": false,\n \"has_elevated_perms\": false,\n \"id\": \"0f55fd46-6f0e-48c0-a0a1-8a615c8d5f1a\",\n \"is_internal_user\": false,\n \"last_login\": \"2024-07-08T10:30:00Z\",\n \"modified_at_date\": \"2024-07-08T10:35:00Z\",\n \"name\": \"Jane Doe\",\n \"permission_level\": \"standard\",\n \"primary_rbac_element_name\": \"viewer\",\n \"service_org_id\": 101,\n \"service_org_name\": \"GitHub\",\n \"service_type\": \"github\",\n \"service_type_slug\": \"github\",\n \"unified_identity_id\": \"4e5ab37b-7d39-4fa8-9f14-6f2e74d9cd1f\",\n \"user_id\": \"external-user-123\",\n \"user_status\": \"active\",\n \"username\": \"jane.doe\"\n }\n ]\n}\n"}],"_postman_id":"5668210a-32e0-4cde-94ef-a7f8a6b62bbb"},{"name":"Get Service User","id":"4c7411a1-f75b-486b-9ba3-68b0daffdf65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/identity/user/{{user_id}}","description":"Returns details for a specific monitored service user.
\nResponse Fields
\nReturns a Service User object.
\n","urlObject":{"protocol":"https","path":["api","v1","identity","user","{{user_id}}"],"host":["[your_subdomain]","appomni","com"],"query":[{"disabled":true,"key":"limit","value":"25"},{"disabled":true,"key":"offset","value":"0"},{"disabled":true,"key":"search","value":"test"},{"disabled":true,"key":"ordering","value":"name"},{"disabled":true,"key":"permission_level__in","value":"[\"admin\",\"elevated\"]"},{"disabled":true,"key":"services_linked__in","value":"[58886, 7887]"},{"disabled":true,"key":"service_types__in","value":"[\"sfdc\",\"okta\"]"}],"variable":[]}},"response":[{"id":"07b6e25d-b91a-4aaf-b9ce-c84b1b86a5a2","name":"Get Service User","originalRequest":{"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/identity/user/{{user_id}}/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"active\": true,\n \"created_at_date\": \"2024-01-15T12:00:00Z\",\n \"email\": \"jane@example.com\",\n \"has_admin_perms\": false,\n \"has_elevated_perms\": false,\n \"id\": \"0f55fd46-6f0e-48c0-a0a1-8a615c8d5f1a\",\n \"is_internal_user\": false,\n \"last_login\": \"2024-07-08T10:30:00Z\",\n \"modified_at_date\": \"2024-07-08T10:35:00Z\",\n \"name\": \"Jane Doe\",\n \"permission_level\": \"standard\",\n \"primary_rbac_element_name\": \"viewer\",\n \"service_org_id\": 101,\n \"service_org_name\": \"GitHub\",\n \"service_type\": \"github\",\n \"service_type_slug\": \"github\",\n \"unified_identity_id\": \"4e5ab37b-7d39-4fa8-9f14-6f2e74d9cd1f\",\n \"user_id\": \"external-user-123\",\n \"user_status\": \"active\",\n \"username\": \"jane.doe\"\n}\n"}],"_postman_id":"4c7411a1-f75b-486b-9ba3-68b0daffdf65"}],"id":"c99f5a69-ebc5-446d-9e8d-f287be31625b","_postman_id":"c99f5a69-ebc5-446d-9e8d-f287be31625b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"A Unified Identity represents a person and is composed of the different monitored service user accounts of that person, associated by email addresses.
\nMonitored service users are users detected by scans of a specific monitored service.
\n","_postman_id":"f4ff765d-9944-4cd1-8c38-352328213511","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Updates all of the user fields for a user by user id.
\nIf the user ID is not known, you can run a GET Request such as {{url}}/scim/v2/Users
\nThis will return a list of users with their user information such as IDs, usernames, groups, etc, which you can use in the body of the PUT request to ensure you are not changing additional settings. For this reason PUT operations are considered a best SCIM practice for updates.
\nReturns all users.
\nReturns a specified user by ID.
\nReturns a specified user with filtered results.
\nString; Query filter expression using SCIM syntax
\n","type":"text/plain"},"key":"filter","value":"userName+sw+\"{{username}}\""}],"variable":[]}},"response":[{"id":"52cc68b5-d270-4c11-a1bf-f8018fb2b7ad","name":"User with filter","originalRequest":{"method":"GET","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n ],\n \"totalResults\": 2,\n \"itemsPerPage\": 50,\n \"startIndex\": 1,\n \"Resources\": [\n {\n \"id\": \"891\",\n \"externalId\": null,\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"user@example.com\",\n \"name\": {\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"formatted\": \"John Doe\"\n },\n \"displayName\": \"John Doe\",\n \"emails\": [\n {\n \"value\": \"user@example.com\",\n \"primary\": true\n }\n ],\n \"active\": true,\n \"groups\": [\n {\n \"value\": \"315\",\n \"$ref\": \"https://example.appomni.com/scim/v2/Groups/315\",\n \"display\": \"Administrators\"\n }\n ],\n \"meta\": {\n \"resourceType\": \"User\",\n \"created\": \"2021-07-06T15:17:44.031973+00:00\",\n \"lastModified\": \"2025-04-08T21:00:45.291578+00:00\",\n \"location\": \"https://example.appomni.com/scim/v2/Users/891\"\n }\n },\n {\n \"id\": \"32078\",\n \"externalId\": \"user1\",\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"user@example.onmicrosoft.com\",\n \"name\": {\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"formatted\": \"John Doe\"\n },\n \"displayName\": \"John Doe\",\n \"emails\": [\n {\n \"value\": \"user@example.onmicrosoft.com\",\n \"primary\": true\n }\n ],\n \"active\": true,\n \"groups\": [\n {\n \"value\": \"315\",\n \"$ref\": \"https://example.appomni.com/scim/v2/Groups/315\",\n \"display\": \"Administrators\"\n }\n ],\n \"meta\": {\n \"resourceType\": \"User\",\n \"created\": \"2024-09-17T19:31:33.590464+00:00\",\n \"lastModified\": \"2024-09-17T19:31:33.927287+00:00\",\n \"location\": \"https://example.appomni.com/scim/v2/Users/32078\"\n }\n }\n ]\n}\n"}],"_postman_id":"bc2e90c4-863d-4de6-bc27-eb68b5361579"},{"name":"List groups","id":"7d6d2237-9c3d-4e9d-929c-305d9ee281f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/scim/v2/Groups","description":"Returns a list of all groups.
\nNote: Only Get operations are available for groups.
\nUse SCIM to connect your identity provider to AppOmni, and utilize this API to:
\nGet all users in a company
\nActivate or deactivate users
\nUpdate a user’s name, password, user name, email address
\nTo update a user’s role, AppOmni SCIM Mappings must be enabled
\nNote: Patch operations are not supported.
\nSee AppOmni’s documentation for creating SCIM mappings. The first step is enabling SCIM provisioning, which enables the creation of SCIM mappings.
\nSCIM2 (System for Cross-domain Identity Management) is a specification designed to automate the provisioning of user and group identities across cloud-based applications and services using SSO services and Identity Providers.
\nSCIM provides API methods and JSON objects that define users and groups. The SCIM API is based on the Open standard: System for Cross-domain Identity Management version 2.0.
\n","_postman_id":"3e79ea88-7db5-41c3-b73e-5ee4b8ad0690","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a list of findings. Findings are comprised of policy rule violations and Insights.
\nThis endpoint returns paginated results, even if not specifically specified on the request by having limit/offset params..
\nThe default limit/offset for all requests is 100 with an offset of 0. These parameters can still be specified on the request by the user. The maximum allowed value for limit is 100. If the value exceeds this, an error response of 400 is returned.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Integer; Zero-based offset of the first item to return
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"String; Fields to order results by (prepend - for descending)
\n","type":"text/plain"},"key":"ordering","value":"-created"},{"disabled":true,"description":{"content":"Array[Integer]; Filter by assignee user IDs
\n","type":"text/plain"},"key":"assignee__in","value":"[123, 456]"},{"disabled":true,"description":{"content":"Array[String]; Filter by risk category values
\n","type":"text/plain"},"key":"category__in","value":"[\"permissions\", \"configuration\", \"data_exposure\"]"},{"disabled":true,"description":{"content":"Array[String]; Filter by compliance framework names
\n","type":"text/plain"},"key":"compliance_frameworks__in","value":"[\"SOC2\", \"ISO27001\", \"HIPAA\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter findings opened on or after this date
\n","type":"text/plain"},"key":"first_opened__gte","value":"2024-01-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter findings opened on or before this date
\n","type":"text/plain"},"key":"first_opened__lte","value":"2024-12-31T23:59:59Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter findings closed on or after this date
\n","type":"text/plain"},"key":"last_closed__gte","value":"2024-08-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter findings closed on or before this date
\n","type":"text/plain"},"key":"last_closed__lte","value":"2024-08-31T23:59:59Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter findings last opened on or after this date
\n","type":"text/plain"},"key":"last_opened__gte","value":"2024-09-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter findings last opened on or before this date
\n","type":"text/plain"},"key":"last_opened__lte","value":"2024-09-30T23:59:59Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter findings last scanned on or after this date
\n","type":"text/plain"},"key":"last_scanned__gte","value":"2024-09-20T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter findings last scanned on or before this date
\n","type":"text/plain"},"key":"last_scanned__lte","value":"2024-09-25T23:59:59Z"},{"disabled":true,"description":{"content":"Array[Integer]; Filter by monitored service IDs
\n","type":"text/plain"},"key":"monitored_service__in","value":"[1, 2, 5]"},{"disabled":true,"description":{"content":"Array[String]; Filter by monitored service environment tags
\n","type":"text/plain"},"key":"monitored_service__tags__in","value":"[\"production\", \"critical\", \"finance\"]"},{"disabled":true,"description":{"content":"Array[String]; Filter by monitored service owner email addresses
\n","type":"text/plain"},"key":"monitored_service_owner__in","value":"[\"john.doe@example.com\", \"jane.smith@example.com\"]"},{"disabled":true,"description":{"content":"Array[String]; Filter by monitored service type slugs
\n","type":"text/plain"},"key":"monitored_service_service_type_slug__in","value":"[\"m365\", \"gws\", \"sfdc\", \"box\"]"},{"disabled":true,"description":{"content":"Integer; Filter by minimum number of open occurrences
\n","type":"text/plain"},"key":"num_occurrences_open","value":"5"},{"disabled":true,"description":{"content":"Integer; Filter by minimum number of closed occurrences
\n","type":"text/plain"},"key":"num_occurrences_closed","value":"10"},{"disabled":true,"description":{"content":"Array[Integer]; Filter by policy IDs
\n","type":"text/plain"},"key":"policy_id__in","value":"[101, 102, 103]"},{"disabled":true,"description":{"content":"Integer; Filter by minimum risk score
\n","type":"text/plain"},"key":"risk_score__gte","value":"7"},{"disabled":true,"description":{"content":"Integer; Filter by maximum risk score
\n","type":"text/plain"},"key":"risk_score__lte","value":"10"},{"disabled":true,"description":{"content":"Array[String]; Filter by risk score ranges
\n","type":"text/plain"},"key":"risk_score__ranges","value":"[\"0-3\", \"4-6\", \"7-10\"]"},{"disabled":true,"description":{"content":"Array[String]; Filter by risk score ranges including null values
\n","type":"text/plain"},"key":"risk_score__rangesornull","value":"[\"0-3\", \"4-6\", \"7-10\", \"null\"]"},{"disabled":true,"description":{"content":"Example: source_name__in=[“source_name value”, ..]An array of values that can be in source_name. The strings provided as part of the array are exact lookups. For partial lookups the &search param can be used.
String; Filter by source type (scanner or insight)
\n","type":"text/plain"},"key":"source_type","value":"scanner"},{"disabled":true,"description":{"content":"String; Filter by finding status (open or closed)
\n","type":"text/plain"},"key":"status","value":"open"},{"disabled":true,"description":{"content":"Array[String]; Filter by general tag names
\n","type":"text/plain"},"key":"tags__in","value":"[\"security\", \"compliance\", \"audit\"]"}],"variable":[]}},"response":[{"id":"2faff2d5-29e6-4454-8a87-2ef5772b02b5","name":"List Findings","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/findings/finding?Limit=?limit=100","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","findings","finding"],"query":[{"key":"Paging Offset","value":"&offset=25","description":"Specifies the (zero-based) offset of the first item in the collection to return. Default is zero.","disabled":true},{"key":"Limit","value":"?limit=100","description":"*WARNING: Endpoint will timeout if a limit is not set and Finding Occurrences exceed 500."},{"key":"Order By","value":"&ordering=risk_score,-last_scanned","description":"Specifies the fields that will be used to order the query results. Default sort order is ascending,. Prepending a minus “-” symbol to the field name denotes descending. Multiple fields can be specified in a comma delimited list.\nRequired field support:\n\n- risk_score\n\n- service_type\n\n- source_type\n\n- num_occurrences_open\n\n- num_occurrences_closed\n\n- first_opened\n\n- last_closed\n\n- status\n\n- monitored_service\n\n- last_reopened\n\n- last_scanned\n\n- tags (Not sortable in Beta 0)\n\n- description (Not sortable in Beta 0)\n\n- policy (Not sortable in Beta 0)","disabled":true},{"key":"Filter by Risk","value":"&risk_score__ranges=[0,0,1,25]\n&risk_score__rangesornull","description":"A comma separated string of risk ranges. \n`rangesornull` returns findings with unknown risk scores.","disabled":true},{"key":"Filter by: First Opened, Last Closed, Last Reopened, or Last Scanned (Subject to change)","value":"&first_opened__gte=2022-04-18T06:00:00.000Z &last_scanned__lte=2022-06-01T06:00:00.000Z","description":"Custom start and end dates for findings that fall between the min and max last seen dates","disabled":true},{"key":" Filter by Description (Subject to change)","value":"&search=”mysearch”","description":"Used to filter by description/name?","disabled":true},{"key":"Filter by Source","value":"&source_type__in=[”insight”]","description":"Possible Values:\n”insight”\n”policy_rule”","disabled":true},{"key":"Filter by Occurrence Counts","value":"&num_occurrences_open__gt=0\n&num_occurrences_closed__gte=3","description":"Use numerical operators","disabled":true},{"key":"Filter by Findings Status","value":"&status__in=[”open”]","description":"Possible Values:\n\"open\"\n\"closed\"\n","disabled":true},{"key":"Filter by General Tags (not currently enabled - available soon)","value":"&tags__in=[45]","description":"Filters by general tags","disabled":true},{"key":"Filter by Monitored Service and Environment Tags (not currently enabled - available soon)","value":"&monitored_service__tags__in=[46]","description":"Used to filter by environment tags applied to monitored services","disabled":true},{"key":"Filter by Risk Category","value":"&category__in=[“configActions”]","description":"Possible Values:\n”config_actions”\n”data_access”\n”other_security_settings”\n”permissions”\n”rbac_assignments”\n”rbac_controls”","disabled":true},{"key":"FIlter by Policy","value":"&policy__in=[123]","description":"Filter param is an array of policy ids","disabled":true},{"key":"FIlter by Assignee","value":"&assignee__in=[12]","description":"Filter param is an array of user ids","disabled":true},{"key":"Filter by Compliance Framework (Subject to change)","value":"\t\n&compliance_framework__in=[1]","disabled":true},{"key":"Filter by Whether has External Ticket","value":"&external_ticket_exists=true","description":"Possible values\ntrue\nfalse","disabled":true},{"key":"Filter by Detailed Status of Occurrences (Subject to change)","value":"&detailed_status__name__in=[“new”]","description":"Possible values\n”new”\n”in_research”\n”in_remediation”\n”done”\n”remediated”\n”allowed_by_exception”\n”monitoring_removed”","disabled":true},{"key":"Filter by Monitored Service","value":"&monitored_service__in","description":"Filter param is an array of monitored service ids ","disabled":true},{"key":"Filter by Service Type","value":"&service_type__in","description":"Filter param is an array of service type ids","disabled":true},{"key":"limit","value":"100","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1922,\n \"next\": \"https://[your_subdomain].appomni.com/api/v1/findings/finding/?limit=25&offset=25&ordering=-first_opened\",\n \"previous\": null,\n \"results\": [\n {\n \"appomni_risk_level\": \"Informational\",\n \"appomni_risk_score\": null,\n \"assignee\": null,\n \"compliance_controls\": [],\n \"compliance_frameworks\": [],\n \"description\": \"Detect improper access to Account\",\n \"external_id\": null,\n \"external_ticket_data\": [\n {\n \"id\": \"74859\",\n \"url\": \"https://dev144531.service-now.com/incident.do?sys_id=25f1c8534779ce50b38b0bdbd36d43a6\",\n \"ticket_id\": \"INC0017034\"\n },\n {\n \"id\": \"77593\",\n \"url\": \"https://dev144578.service-now.com/incident.do?sys_id=d0b4d4659713ced0d9e2fa67f053afb8\",\n \"ticket_id\": \"INC0100832\"\n },\n {\n \"id\": \"94839\",\n \"url\": \"https://dev243199.service-now.com/incident.do?sys_id=f4039c09832ed6d0e9aff696feaad348\",\n \"ticket_id\": \"INC0016036\"\n }\n ],\n \"first_opened\": \"2025-01-13T14:16:14.860715Z\",\n \"has_max_open_occurrences\": false,\n \"has_new_occurrences\": true,\n \"id\": \"0194600e-3cf0-7512-903f-cd01893a255c\",\n \"identity_hash\": \"01309b5b74daccdf68bc398ab4dd2589c0c047fc8f94cbb71559728bfc37eed4\",\n \"last_closed\": null,\n \"last_opened\": \"2025-01-13T14:16:14.860715Z\",\n \"last_scanned\": \"2025-01-13T14:17:54.036709Z\",\n \"legacy_finding_id\": 1653424,\n \"monitored_service_id\": 67448,\n \"monitored_service_name\": \"SFDC-Coretest-Scratch-Int\",\n \"monitored_service_connected\": true,\n \"monitored_service_tags\": [\n {\n \"id\": 115,\n \"name\": \"Production\",\n \"short_name\": null,\n \"type\": \"environment\"\n }\n ],\n \"monitored_service_owner\": {\n \"username\": \"test@appomni.com\",\n \"id\": 65,\n \"first_name\": \"Foo\",\n \"last_name\": \"Bar\"\n },\n \"notes\": null,\n \"num_occurrences_closed\": 0,\n \"num_occurrences_open\": 2,\n \"policy_id\": 679998,\n \"policy_name\": \"omni-test-united-sfdc-functional-policy-test\",\n \"remediation_description\": null,\n \"risk_description\": null,\n \"risk_level\": \"Informational\",\n \"risk_score\": 0,\n \"service_type\": \"sfdc\",\n \"source_id\": 1605359,\n \"source_internal_name\": \"sfdc.object.access\",\n \"source_name\": \"Account Object Access Rule\",\n \"source_type\": \"policy_rule\",\n \"status\": \"open\",\n \"tags\": []\n }\n ]\n }\n"}],"_postman_id":"f779095c-ff23-40a8-a3a0-aeb3d9e4dad0"},{"name":"Get finding details","id":"90c057d2-3b3f-4d7f-8804-56f60ddd8e12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Bearer}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/findings/finding/:id/","description":"Returns the details of a finding given the id. Findings are comprised of policy rule violations and Insights.
\n","urlObject":{"protocol":"https","path":["api","v1","findings","finding",":id",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[{"description":{"content":"id returned from List Findings. Type: UUID string
Returns a list of all finding occurrences and can be filtered. Findings are comprised of policy rule violations and Insights.
\nThe API schema will be enhanced and made extensible with dynamic metadata based on finding type.
\nThis endpoint returns paginated results, even if not specifically specified on the request by having limit/offset params..
\nThe default limit/offset for all requests is 100 with an offset of 0. These parameters can still be specified on the request by the user. The maximum allowed value for limit is 100. If the value exceeds this, an error response of 400 is returned.
\nAs a best practice for efficiency, AppOmni recommends retrieving all occurrences for a given monitored service in a single call using this endpoint, rather than retrieving occurrences one-by-one, which could result in hitting rate limits.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Integer; Zero-based offset of the first item to return
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Array[String]; Filter by detailed status names
\n","type":"text/plain"},"key":"detailed_status_name__in","value":"[\"new\", \"in_progress\", \"under_review\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences first opened on or after this date
\n","type":"text/plain"},"key":"first_opened__gte","value":"2024-01-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences first opened on or before this date
\n","type":"text/plain"},"key":"first_opened__lte","value":"2024-12-31T23:59:59Z"},{"disabled":true,"description":{"content":"String (UUID); Filter by specific finding ID
\n","type":"text/plain"},"key":"finding_id","value":"f123e4567-e89b-12d3-a456-426614174000"},{"disabled":true,"description":{"content":"Array[String]; Filter by multiple finding IDs
\n","type":"text/plain"},"key":"finding_id__in","value":"[\"f123e4567-e89b-12d3-a456-426614174000\", \"f223e4567-e89b-12d3-a456-426614174001\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last closed on or after this date
\n","type":"text/plain"},"key":"last_closed__gte","value":"2024-08-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last closed on or before this date
\n","type":"text/plain"},"key":"last_closed__lte","value":"2024-08-31T23:59:59Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last opened on or after this date
\n","type":"text/plain"},"key":"last_opened__gte","value":"2024-09-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last opened on or before this date
\n","type":"text/plain"},"key":"last_opened__lte","value":"2024-09-30T23:59:59Z"},{"disabled":true,"description":{"content":"Array[Integer]; Filter by monitored service IDs
\n","type":"text/plain"},"key":"monitored_service__in","value":"[1, 2, 5]"},{"disabled":true,"description":{"content":"String; Filter by occurrence status (open or closed)
\n","type":"text/plain"},"key":"status","value":"open"}],"variable":[]}},"response":[{"id":"0c1afade-875e-4cb7-b553-4b442524379c","name":"Get Finding Occurrences","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/findings/occurrence/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","findings","occurrence",""],"query":[{"key":"finding_id","value":"{}","description":"Required; `id` returned from \"List Findings\"","disabled":true},{"key":"Paging Offset","value":"&offset=25","description":"Specifies the (zero-based) offset of the first item in the collection to return. Default is zero.","disabled":true},{"key":"Limit","value":"50","description":"Defaults to 50, max 500","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 32818,\n \"next\": \"https://[your_subdomain].appomni.com/api/v1/findings/occurrence/?limit=500&offset=500\",\n \"previous\": null,\n \"results\": [\n {\n \"context\": {\n \"user_id\": \"00u4eiqzlpM0YNfpb5d7\",\n \"group_id\": \"00g2uvbqiq89VNgJe5d7\",\n \"user_name\": \"Test User 358 Mocked\",\n \"group_name\": \"Everyone\",\n \"user_email\": \"test358@example.com\",\n \"user_username\": \"test358@example.com\"\n },\n \"detailed_status_label\": \"New\",\n \"detailed_status_name\": \"new\",\n \"finding_id\": \"0193472c-68ac-7365-ae7a-9a0e70b4442e\",\n \"first_opened\": \"2024-08-29T01:12:21.528946Z\",\n \"id\": \"0193472c-6db5-72ce-b4ca-068181e76277\",\n \"identity_hash\": \"70ed419bc83ba09d003323fa3484956ec7cb9362516b513fb58116c9ad0035cc\",\n \"last_closed\": null,\n \"last_opened\": \"2024-08-29T01:12:21.528946Z\",\n \"monitored_service_id\": 19681,\n \"reasons\": [\n \"User test358@example.com is assigned the Everyone Group.\"\n ],\n \"status\": \"open\"\n },\n ...\n ]\n }"}],"_postman_id":"0d659fae-84f2-4e44-9802-dddcaa3a3cd5"},{"name":"Finding occurrences detail view","id":"02fd2684-e0aa-42cd-bb9a-66ebb8856699","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Bearer}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/findings/occurrence/{occurrence_id}/","description":"Returns the details of a finding occurrence by occurrence_ id and by monitored service.
Updates the status of a finding occurrence via occurrence_id. Findings are comprised of policy rule violations and Insights.
\nOnly detailed statuses of new, in_research, in_remediation, doneare allowed for the detailed_status properties values
The parent finding’s status must be open
Status Code: 204 No Content\n\nStatus Code: 400 Bad Request\n{\n \"ids\": [\n \"This field is required.\"\n ],\n \"detailed_status\": [\n \"This field is required.\"\n ]\n}\n\nStatus Code: 400 Bad Request\n\"At least one occurrence is Closed. Ensure that you are only updating Open occurrences in this request.\"\n\n400 Bad Request\n\"Invalid detailed status provided '{invalid detailed status}'\"\n\n","urlObject":{"protocol":"https","path":["api","v1","findings","occurrence","update_detailed_status",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2d762a4-fb5b-49b2-a3eb-5f491720f82c"},{"name":"Update fnding occurrence detailed status by filter","id":"706c67e2-7c56-41bd-95fe-52a02b5c3bb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Updates the status of a finding occurrence using filters. Findings are comprised of policy rule violations and Insights.
\nOnly detailed statuses of new, in_research, in_remediation, doneare allowed for the detailed_status properties values
The parent finding’s status must be open
Status Code: 204 No Content\n\nStatus Code: 400 Bad Request\n{\n \"ids\": [\n \"This field is required.\"\n ],\n \"detailed_status\": [\n \"This field is required.\"\n ]\n}\n\nStatus Code: 400 Bad Request\n\"At least one occurrence is Closed. Ensure that you are only updating Open occurrences in this request.\"\n\n400 Bad Request\n\"Invalid detailed status provided '{invalid detailed status}'\"\n\n","urlObject":{"protocol":"https","path":["api","v1","findings","occurrence","update_detailed_status_by_filter",""],"host":["[your_subdomain]","appomni","com"],"query":[{"disabled":true,"description":{"content":"Integer; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Array[String]; Filter by detailed status names
\n","type":"text/plain"},"key":"detailed_status_name__in","value":"[\"new\", \"in_progress\", \"under_review\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences first opened on or after this date
\n","type":"text/plain"},"key":"first_opened__gte","value":"2024-01-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences first opened on or before this date
\n","type":"text/plain"},"key":"first_opened__lte","value":"2024-12-31T23:59:59Z"},{"disabled":true,"description":{"content":"String (UUID); Filter by specific finding ID
\n","type":"text/plain"},"key":"finding_id","value":"f123e4567-e89b-12d3-a456-426614174000"},{"disabled":true,"description":{"content":"Array[String]; Filter by multiple finding IDs
\n","type":"text/plain"},"key":"finding_id__in","value":"[\"f123e4567-e89b-12d3-a456-426614174000\", \"f223e4567-e89b-12d3-a456-426614174001\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last closed on or after this date
\n","type":"text/plain"},"key":"last_closed__gte","value":"2024-08-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last closed on or before this date
\n","type":"text/plain"},"key":"last_closed__lte","value":"2024-08-31T23:59:59Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last opened on or after this date
\n","type":"text/plain"},"key":"last_opened__gte","value":"2024-09-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last opened on or before this date
\n","type":"text/plain"},"key":"last_opened__lte","value":"2024-09-30T23:59:59Z"},{"disabled":true,"description":{"content":"Array[Integer]; Filter by monitored service IDs
\n","type":"text/plain"},"key":"monitored_service__in","value":"[1, 2, 5]"}],"variable":[]}},"response":[],"_postman_id":"706c67e2-7c56-41bd-95fe-52a02b5c3bb7"},{"name":"Close occurrence by exception","id":"4bf97a97-aad2-4232-b892-5badee037120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Bearer}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"ids\": [\"0193651f-ae54-7e5f-8e60-befcbd2f497f\"],\n \"reason\": \"risk_accepted\",\n \"expires\": \"2025-04-25T22:30:00Z\",\n \"message\": \"Some string explaining why\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/findings/occurrence/close_by_exception/","description":"Close an occurrence by exception.
\nExample success response:
\n{\n \"closed_count\": 1\n}\n\nExample failure responses:
\n400 Bad Request { \"ids\": [ \"This field is required.\" ], \"expires\": [ \"This field is required.\" ] }
400 Bad Request \"At least one occurrence is Closed. Ensure that you are only creating an exception for Open occurrences in this request.\"
400 Bad Request \"{invalid reason} is not a valid choice.\"
400 Bad Request \"The occurrences of provided ids must exist in Open status for an Exception to be created.\"
400 Bad Request \"The occurrences of provided ids must exist in Open status for an Exception to be created.\"
Close an occurrence by exception by filter.
\nPass in any filters to the URL as query parameters to update all occurrences based on that filter set.
\nExample Success Response:
\n2Status Code: 200 OK
{ \"closed_count\": 500 }
Example Failure Responses:
\nStatus Code: 400 Bad Request
400 Bad Request
\"{invalid reason} is not a valid choice.\"
Restore an occurrence that has been closed by exception.
\nUtilize any parameters from the GET Finding Occurrences endpoint.
\nTo verify expected occurrences, you may want to execute a GET request on the /findings/occurrence/ endpoint with a query before attempting to restore any Occurrences.
If the request is made with NO query parameters, EVERY Occurrence will be queued for having an exception added.
\nExample Success Response:
\n{ \"restored_count\": 1 }
Example Failure Responses:
\n400 - Bad Request - {'non_field_error': 'The occurrences of provided `filters` must exist in `Closed by Exception` status for them to be restored.'}
500 - Internal Server Error
Restore an occurrence by filter for an occurrence that was closed by exception.
\nTo verify expected occurrences, you may want to execute a GET request on the /findings/occurrence/ endpoint with a query before attempting to restore any Occurrences.
Note: Including finding_id__in as a query parameter is strongly recommended, otherwise your request will restore many unintended occurrences. If the request is made with NO query parameters, EVERY Occurrence will be queued for having an exception added.
Example Success Response:
\n{ \"restored_count\": 1 }
Example Failure Responses:
\n200 - Returns 200 if auth is valid
404 - Not Found (if any of the ids are invalid)
500 - Internal Server Error
Integer; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Array[String]; Filter by detailed status names
\n","type":"text/plain"},"key":"detailed_status_name__in","value":"[\"new\", \"in_progress\", \"under_review\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences first opened on or after this date
\n","type":"text/plain"},"key":"first_opened__gte","value":"2024-01-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences first opened on or before this date
\n","type":"text/plain"},"key":"first_opened__lte","value":"2024-12-31T23:59:59Z"},{"disabled":true,"description":{"content":"String (UUID); Filter by specific finding ID
\n","type":"text/plain"},"key":"finding_id","value":"f123e4567-e89b-12d3-a456-426614174000"},{"disabled":true,"description":{"content":"Array[String]; Filter by multiple finding IDs
\n","type":"text/plain"},"key":"finding_id__in","value":"[\"f123e4567-e89b-12d3-a456-426614174000\", \"f223e4567-e89b-12d3-a456-426614174001\"]"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last closed on or after this date
\n","type":"text/plain"},"key":"last_closed__gte","value":"2024-08-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last closed on or before this date
\n","type":"text/plain"},"key":"last_closed__lte","value":"2024-08-31T23:59:59Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last opened on or after this date
\n","type":"text/plain"},"key":"last_opened__gte","value":"2024-09-01T00:00:00Z"},{"disabled":true,"description":{"content":"String (ISO 8601); Filter occurrences last opened on or before this date
\n","type":"text/plain"},"key":"last_opened__lte","value":"2024-09-30T23:59:59Z"},{"disabled":true,"description":{"content":"Array[Integer]; Filter by monitored service IDs
\n","type":"text/plain"},"key":"monitored_service__in","value":"[1, 2, 5]"},{"disabled":true,"description":{"content":"String; Filter by occurrence status (open or closed)
\n","type":"text/plain"},"key":"status","value":"open"}],"variable":[]}},"response":[{"id":"3f816d5a-f6c7-4acd-8627-f1f1f3deb9a5","name":"Restore Occurrences By Filter","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/findings/occurrence/restore_by_filter/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","findings","occurrence","restore_by_filter",""],"query":[{"key":"detailed_status_name__in","value":"","description":"Type: str Possible Values:\n`new`\n`in_research`\n`in_remediation`\n`done`\n`remediated`\n`allowed_by_exception`\n`monitoring_removed`\n`null`","disabled":true},{"key":"first_opened__gte","value":"","description":"Type: str (ISO 8601) Example: `first_opened__gte=2022-04-18T06:00:00.000Z` Custom start and end dates for findings that fall between the min and max last seen dates","disabled":true},{"key":"first_opened__lte","value":"","disabled":true},{"key":"finding_id","value":null,"description":"Type: str (uuid). Example: finding_id=01935061-de69-73c2-b8cd-b3dd385e2e115\n","disabled":true},{"key":"finding_id__in","value":null,"description":"Example: finding_id__in=[\"01938d1f-27bb-720f-b51c-cb9745e9ce3c\",\"01938d1f-27b7-77a5-b649-7c4a7221902d\"]","disabled":true},{"key":"last_closed__gte","value":"","disabled":true},{"key":"last_closed__lte","value":"","description":"\n","disabled":true},{"key":"last_opened__gte","value":"","disabled":true},{"key":"last_opened__lte","value":"","disabled":true},{"key":"limit","value":"","disabled":true},{"key":"monitored_service__in","value":"","description":"Filter occurrences related to specific monitored service(s). Enter a single id or a comma-separated list. ","disabled":true},{"key":"status","value":"","disabled":true}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"restored_count\": 1\n}"}],"_postman_id":"8f698a20-d0a6-49f0-b4b3-1b7fe445ef0d"},{"name":"Assign findings","id":"4c943911-6100-4222-8af6-6871b129e10b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"records\": [\n {\n \"id\": \"01951fab-7900-717f-b4f9-fb1d22d78c87\", // finding id\n \"assignee_id\": 2 // user id\n },\n {\n \"id\": \"01951fab-793d-7431-905d-fefbb80af82b\",\n \"assignee_id\": null // when null, the finding is unassigned\n },\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/findings/finding/assign/","description":"Assigns findings to users.
\nid - Finding ID. Required in request payload.
assignee_id - ID of the user. Required in request payload.
If the assignee_idis null, then the finding is unassigned.
Returns a list of integration accounts associated with your findings
\nReturns a list of monitored service service ids associated with your findings
\nPosture Findings consolidates policy issues and Insights into a single view, allowing you to efficiently manage and resolve alerts.
\nThe Posture Findings API will exist concurrently with Insights and policy issues API's for a period of time; at a later date Insights and policy issues API's will be deprecated.
\n","_postman_id":"797a77d0-59c2-4753-b9e8-1bafb97c657f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a list of Discovery apps.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field to order results by
\n","type":"text/plain"},"key":"ordering","value":"-cached_last_seen"},{"description":{"content":"String; Search term to filter results
\n","type":"text/plain"},"key":"search","value":"security"},{"description":{"content":"String; Filter by review status (approved, pending, rejected)
\n","type":"text/plain"},"key":"status","value":"approved"},{"description":{"content":"String; Filter by criticality level (high, medium, low)
\n","type":"text/plain"},"key":"criticality","value":"high"},{"description":{"content":"String; Filter by owner email address
\n","type":"text/plain"},"key":"owner","value":"{{user_email}}"}],"variable":[]}},"response":[{"id":"c2c1d267-5e0a-4704-a98f-aa327cb498ce","name":"List Discovery Apps","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":"https://[your_subdomain].appomni.com/api/v1/discovery/apps/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"saas_application\": {\n \"name\": \"AppOmni\",\n \"saas_domain\": \"appomni.com\",\n \"company_name\": \"AppOmni\",\n \"categories\": \"['Cloud Management', 'Cloud Security', 'Cyber Security', 'SaaS', 'Software']\",\n \"description\": \"AppOmni SaaS security helps security and IT teams protect and monitor their entire SaaS environment, from each vendor to every end-user.\",\n \"founded_on\": \"2018\",\n \"headquarters_city\": \"San Francisco\",\n \"headquarters_country\": \"United States\"\n },\n \"owner\": \"user1@example.com\",\n \"segments\": \"/example1 /example2\",\n \"subdomains\": \"example\",\n \"status\": \"approved\",\n \"criticality\": \"high\",\n \"cached_unique_users_count\": 3,\n \"cached_total_ingress_kb\": 100,\n \"cached_total_egress_kb\": 100,\n \"cached_total_duration_ms\": 60000,\n \"cached_first_seen\": \"1960-01-01T0:00:00.0000Z\",\n \"cached_last_seen\": \"2025-05-15T0:00:00.0000Z\",\n \"stats_last_updated\": \"2025-05-15T0:00:00.0000Z\"\n },\n {\n \"saas_application\": {\n \"name\": \"Omniscreen\",\n \"saas_domain\": \"omniscreen.io\",\n \"company_name\": \"Omniscreen\",\n \"categories\": \"['Cyber Security']\",\n \"description\": \"Omniscreen is the industry's most effective network security posture management (NSPM) tool, enabling organizations to apply open-source, third-party, or proprietary scanning methodologies against the web-facing infrastructure of their cloud implementations.\",\n \"founded_on\": \"2024\",\n \"headquarters_city\": \"Austin\",\n \"headquarters_country\": \"United States\"\n },\n \"owner\": \"user2@example.com\",\n \"segments\": \"\",\n \"subdomains\": \"\",\n \"status\": \"approved\",\n \"criticality\": \"high\",\n \"cached_unique_users_count\": 5,\n \"cached_total_ingress_kb\": 200,\n \"cached_total_egress_kb\": 200,\n \"cached_total_duration_ms\": 1200000,\n \"cached_first_seen\": \"1960-01-01T0:00:00.0000Z\",\n \"cached_last_seen\": \"2025-05-15T0:00:00.0000Z\",\n \"stats_last_updated\": \"2025-05-15T0:00:00.0000Z\"\n }\n]"}],"_postman_id":"6da38af3-fa19-4159-9608-c448f86cb401"},{"name":"Retrieve App Discovery App","id":"97a799c5-51f7-4f45-aa5d-2ab40cc69b7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/discovery/apps/?app={{app_name}}","description":"Returns a specific Discovery App.
\nSame fields as List Discovery apps endpoint, but returns a single object instead of an array.
\n","urlObject":{"protocol":"https","path":["api","v1","discovery","apps",""],"host":["[your_subdomain]","appomni","com"],"query":[{"description":{"content":"String; The name of the Discovery app
\n","type":"text/plain"},"key":"app","value":"{{app_name}}"}],"variable":[]}},"response":[{"id":"36143d8d-c777-4dc4-95a4-f6664fa953f1","name":"Retrieve Discovery App","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/discovery/apps/?app=appomni","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","discovery","apps",""],"query":[{"key":"app","value":"appomni"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"saas_application\": {\n \"name\": \"AppOmni\",\n \"saas_domain\": \"appomni.com\",\n \"company_name\": \"AppOmni\",\n \"categories\": \"['Cloud Management', 'Cloud Security', 'Cyber Security', 'SaaS', 'Software']\",\n \"description\": \"AppOmni SaaS security helps security and IT teams protect and monitor their entire SaaS environment, from each vendor to every end-user.\",\n \"founded_on\": \"2018\",\n \"headquarters_city\": \"San Francisco\",\n \"headquarters_country\": \"United States\"\n },\n \"owner\": \"user1@example.com\",\n \"segments\": \"/example1 /example2\",\n \"subdomains\": \"example\",\n \"status\": \"approved\",\n \"criticality\": \"high\",\n \"cached_unique_users_count\": 3,\n \"cached_total_ingress_kb\": 100,\n \"cached_total_egress_kb\": 100,\n \"cached_total_duration_ms\": 60000,\n \"cached_first_seen\": \"1960-01-01T0:00:00.0000Z\",\n \"cached_last_seen\": \"2025-05-15T0:00:00.0000Z\",\n \"stats_last_updated\": \"2025-05-15T0:00:00.0000Z\"\n}"}],"_postman_id":"97a799c5-51f7-4f45-aa5d-2ab40cc69b7b"}],"id":"8d2dc4a9-168c-4785-a9f6-2359dd97144e","_postman_id":"8d2dc4a9-168c-4785-a9f6-2359dd97144e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a list of Discovery UserAppPages.
\nA Discovery UserAppPage contains data about a given Discovery user's activity on a given Discovery app.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field to order results by
\n","type":"text/plain"},"key":"ordering","value":"-last_visited_at"},{"description":{"content":"String; Filter by user email address
\n","type":"text/plain"},"key":"user","value":"{{user_email}}"},{"description":{"content":"String; Filter by app name
\n","type":"text/plain"},"key":"app","value":"{{app_name}}"},{"description":{"content":"Integer; Minimum number of visits
\n","type":"text/plain"},"key":"min_visits","value":"5"}],"variable":[]}},"response":[{"id":"d65fb544-929d-4c67-b23c-9994649d680d","name":"List Discovery UserAppPages","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":"https://[your_subdomain].appomni.com/api/v1/discovery/user-app-pages/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"identity\": {\n \"email\": \"user1@example.com\",\n \"user_agents_seen\": \"[\\\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\\\"]\"\n },\n \"org_saas_application\": {\n \"saas_application\": {\n \"name\": \"AppOmni\",\n \"saas_domain\": \"appomni.com\",\n \"company_name\": \"AppOmni\",\n \"categories\": \"['Cloud Management', 'Cloud Security', 'Cyber Security', 'SaaS', 'Software']\",\n \"description\": \"AppOmni SaaS security helps security and IT teams protect and monitor their entire SaaS environment, from each vendor to every end-user.\",\n \"founded_on\": \"2018\",\n \"headquarters_city\": \"San Francisco\",\n \"headquarters_country\": \"United States\"\n },\n \"owner\": \"user1@example.com\",\n \"segments\": \"/example1 /example2\",\n \"subdomains\": \"example\",\n \"status\": \"approved\",\n \"criticality\": \"high\",\n \"cached_unique_users_count\": 3,\n \"cached_total_ingress_kb\": 100,\n \"cached_total_egress_kb\": 100,\n \"cached_total_duration_ms\": 60000,\n \"cached_first_seen\": \"1960-01-01T0:00:00.0000Z\",\n \"cached_last_seen\": \"2025-05-15T0:00:00.0000Z\",\n \"stats_last_updated\": \"2025-05-15T0:00:00.0000Z\"\n },\n \"segments\": \"/example1\",\n \"subdomains\": \"example\",\n \"duration_ms\": 30000,\n \"data_ingress_kb\": 50,\n \"data_egress_kb\": 50,\n \"visits_count\": 12,\n \"first_visited_at\": \"1960-01-01T0:00:00.0000Z\",\n \"last_visited_at\": \"2025-05-15T0:00:00.0000Z\"\n },\n {\n \"identity\": {\n \"email\": \"user2@example.com\",\n \"user_agents_seen\": \"[\\\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\\\"]\"\n },\n \"org_saas_application\": {\n \"saas_application\": {\n \"name\": \"AppOmni\",\n \"saas_domain\": \"appomni.com\",\n \"company_name\": \"AppOmni\",\n \"categories\": \"['Cloud Management', 'Cloud Security', 'Cyber Security', 'SaaS', 'Software']\",\n \"description\": \"AppOmni SaaS security helps security and IT teams protect and monitor their entire SaaS environment, from each vendor to every end-user.\",\n \"founded_on\": \"2018\",\n \"headquarters_city\": \"San Francisco\",\n \"headquarters_country\": \"United States\"\n },\n \"owner\": \"user1@example.com\",\n \"segments\": \"/example1 /example2\",\n \"subdomains\": \"example\",\n \"status\": \"approved\",\n \"criticality\": \"high\",\n \"cached_unique_users_count\": 3,\n \"cached_total_ingress_kb\": 100,\n \"cached_total_egress_kb\": 100,\n \"cached_total_duration_ms\": 60000,\n \"cached_first_seen\": \"1960-01-01T0:00:00.0000Z\",\n \"cached_last_seen\": \"2025-05-15T0:00:00.0000Z\",\n \"stats_last_updated\": \"2025-05-15T0:00:00.0000Z\"\n },\n \"segments\": \"/example2\",\n \"subdomains\": \"example\",\n \"duration_ms\": 30000,\n \"data_ingress_kb\": 50,\n \"data_egress_kb\": 50,\n \"visits_count\": 4,\n \"first_visited_at\": \"1960-01-01T0:00:00.0000Z\",\n \"last_visited_at\": \"2025-05-15T0:00:00.0000Z\"\n },\n {\n \"identity\": {\n \"email\": \"user1@example.com\",\n \"user_agents_seen\": \"[\\\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\\\"]\"\n },\n \"org_saas_application\": {\n \"saas_application\": {\n \"name\": \"Omniscreen\",\n \"saas_domain\": \"omniscreen.io\",\n \"company_name\": \"Omniscreen\",\n \"categories\": \"['Cyber Security']\",\n \"description\": \"Omniscreen is the industry's most effective network security posture management (NSPM) tool, enabling organizations to apply open-source, third-party, or proprietary scanning methodologies against the web-facing infrastructure of their cloud implementations.\",\n \"founded_on\": \"2024\",\n \"headquarters_city\": \"Austin\",\n \"headquarters_country\": \"United States\"\n },\n \"owner\": \"user2@example.com\",\n \"segments\": \"\",\n \"subdomains\": \"\",\n \"status\": \"approved\",\n \"criticality\": \"high\",\n \"cached_unique_users_count\": 5,\n \"cached_total_ingress_kb\": 200,\n \"cached_total_egress_kb\": 200,\n \"cached_total_duration_ms\": 1200000,\n \"cached_first_seen\": \"1960-01-01T0:00:00.0000Z\",\n \"cached_last_seen\": \"2025-05-15T0:00:00.0000Z\",\n \"stats_last_updated\": \"2025-05-15T0:00:00.0000Z\"\n },\n \"segments\": \"\",\n \"subdomains\": \"\",\n \"duration_ms\": 10000,\n \"data_ingress_kb\": 100,\n \"data_egress_kb\": 100,\n \"visits_count\": 50,\n \"first_visited_at\": \"1960-01-01T0:00:00.0000Z\",\n \"last_visited_at\": \"2025-05-15T0:00:00.0000Z\"\n }\n]"}],"_postman_id":"07caeba3-bf5a-45be-9307-375fa477e4b6"},{"name":"Retrieve App Discovery UserAppPage","id":"e5cc0687-cccd-4feb-a4e6-51ca7817b422","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/discovery/user-app-pages/?user={{user_email}}&app={{app_name}}","description":"Returns Discovery UserAppPages filtered by user and/or app.
\nReturns an array of UserAppPage objects with the same fields as List Discovery UserAppPages endpoint.
\n","urlObject":{"protocol":"https","path":["api","v1","discovery","user-app-pages",""],"host":["[your_subdomain]","appomni","com"],"query":[{"description":{"content":"String; The email address of the Discovery user
\n","type":"text/plain"},"key":"user","value":"{{user_email}}"},{"description":{"content":"String; The name of the Discovery app
\n","type":"text/plain"},"key":"app","value":"{{app_name}}"}],"variable":[]}},"response":[{"id":"e4548121-97bd-4475-81b3-085c74ec0108","name":"Retrieve Discovery UserAppPage","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/discovery/user-app-pages/?user=user1@example.com&app=appomni","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","discovery","user-app-pages",""],"query":[{"key":"user","value":"user1@example.com"},{"key":"app","value":"appomni"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"identity\": {\n \"email\": \"user1@example.com\",\n \"user_agents_seen\": \"[\\\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\\\"]\"\n },\n \"org_saas_application\": {\n \"saas_application\": {\n \"name\": \"AppOmni\",\n \"saas_domain\": \"appomni.com\",\n \"company_name\": \"AppOmni\",\n \"categories\": \"['Cloud Management', 'Cloud Security', 'Cyber Security', 'SaaS', 'Software']\",\n \"description\": \"AppOmni SaaS security helps security and IT teams protect and monitor their entire SaaS environment, from each vendor to every end-user.\",\n \"founded_on\": \"2018\",\n \"headquarters_city\": \"San Francisco\",\n \"headquarters_country\": \"United States\"\n },\n \"owner\": \"user1@example.com\",\n \"segments\": \"/example1 /example2\",\n \"subdomains\": \"example\",\n \"status\": \"approved\",\n \"criticality\": \"high\",\n \"cached_unique_users_count\": 3,\n \"cached_total_ingress_kb\": 100,\n \"cached_total_egress_kb\": 100,\n \"cached_total_duration_ms\": 60000,\n \"cached_first_seen\": \"1960-01-01T0:00:00.0000Z\",\n \"cached_last_seen\": \"2025-05-15T0:00:00.0000Z\",\n \"stats_last_updated\": \"2025-05-15T0:00:00.0000Z\"\n },\n \"segments\": \"/example1\",\n \"subdomains\": \"example\",\n \"duration_ms\": 30000,\n \"data_ingress_kb\": 50,\n \"data_egress_kb\": 50,\n \"visits_count\": 12,\n \"first_visited_at\": \"1960-01-01T0:00:00.0000Z\",\n \"last_visited_at\": \"2025-05-15T0:00:00.0000Z\"\n },\n {\n \"identity\": {\n \"email\": \"user1@example.com\",\n \"user_agents_seen\": \"[\\\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\\\"]\"\n },\n \"org_saas_application\": {\n \"saas_application\": {\n \"name\": \"Omniscreen\",\n \"saas_domain\": \"omniscreen.io\",\n \"company_name\": \"Omniscreen\",\n \"categories\": \"['Cyber Security']\",\n \"description\": \"Omniscreen is the industry's most effective network security posture management (NSPM) tool, enabling organizations to apply open-source, third-party, or proprietary scanning methodologies against the web-facing infrastructure of their cloud implementations.\",\n \"founded_on\": \"2024\",\n \"headquarters_city\": \"Austin\",\n \"headquarters_country\": \"United States\"\n },\n \"owner\": \"user2@example.com\",\n \"segments\": \"\",\n \"subdomains\": \"\",\n \"status\": \"approved\",\n \"criticality\": \"high\",\n \"cached_unique_users_count\": 5,\n \"cached_total_ingress_kb\": 200,\n \"cached_total_egress_kb\": 200,\n \"cached_total_duration_ms\": 1200000,\n \"cached_first_seen\": \"1960-01-01T0:00:00.0000Z\",\n \"cached_last_seen\": \"2025-05-15T0:00:00.0000Z\",\n \"stats_last_updated\": \"2025-05-15T0:00:00.0000Z\"\n },\n \"segments\": \"\",\n \"subdomains\": \"\",\n \"duration_ms\": 10000,\n \"data_ingress_kb\": 100,\n \"data_egress_kb\": 100,\n \"visits_count\": 50,\n \"first_visited_at\": \"1960-01-01T0:00:00.0000Z\",\n \"last_visited_at\": \"2025-05-15T0:00:00.0000Z\"\n }\n]"}],"_postman_id":"e5cc0687-cccd-4feb-a4e6-51ca7817b422"}],"id":"ec5ffdf3-b2c7-4019-9aa9-cb6e1f28dcff","_postman_id":"ec5ffdf3-b2c7-4019-9aa9-cb6e1f28dcff","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a list of Discovery users.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field to order results by
\n","type":"text/plain"},"key":"ordering","value":"email"},{"description":{"content":"String; Search term to filter by email
\n","type":"text/plain"},"key":"search","value":"example.com"}],"variable":[]}},"response":[{"id":"2403bdc1-4198-428c-a803-8768452b59d4","name":"List Discovery Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":"https://[your_subdomain].appomni.com/api/v1/discovery/users/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"email\": \"user1@example.com\",\n \"user_agents_seen\": \"[\\\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\\\"]\"\n },\n {\n \"email\": \"user2@example.com\",\n \"user_agents_seen\": \"[\\\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\\\"]\"\n }\n]"}],"_postman_id":"f25f496f-d759-4bd4-865c-1e6f5c9a77a3"},{"name":"Retrieve App Discovery User","id":"15e07049-6718-4f2c-b072-f6b14e869939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/discovery/users/?user={{user_email}}","description":"Returns a specific Discovery user.
\nString; The email address of the Discovery user
\n","type":"text/plain"},"key":"user","value":"{{user_email}}"}],"variable":[]}},"response":[{"id":"ad78b7db-bbe7-4f81-9653-5e1b0108f42b","name":"Retrieve Discovery User","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer [your_api_token]","description":"AppOmni API Token","type":"text"}],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/discovery/users/?user=user1@example.com","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","discovery","users",""],"query":[{"key":"user","value":"user1@example.com"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"user1@example.com\",\n \"user_agents_seen\": \"[\\\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36\\\"]\"\n}"}],"_postman_id":"15e07049-6718-4f2c-b072-f6b14e869939"}],"id":"30ea001a-21b2-4aa9-9abd-c0bca194a798","_postman_id":"30ea001a-21b2-4aa9-9abd-c0bca194a798","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a list of custom fields.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Array[String]; Fields used to order the results. Leading \"-\" symbols denotes descending ordering
\n","type":"text/plain"},"key":"ordering","value":"id"},{"description":{"content":"String; Restrict results to objects matching the search criteria
\n","type":"text/plain"},"key":"search","value":"field"},{"description":{"content":"Array[UUID]; Filter items by matching their ids
\n","type":"text/plain"},"key":"id__in","value":"[\"e6a1993f-52c4-4e82-b734-7772ed551aa1\",\"1d0dccb1-b3c3-462e-a95f-a4a2dba72d15\"]"},{"description":{"content":"String; Filter items by partially matching display_name
\n","type":"text/plain"},"key":"display_name__icontains","value":"example"},{"description":{"content":"String; Filter items by partially matching field_name
\n","type":"text/plain"},"key":"field_name__icontains","value":"example"},{"description":{"content":"String; Filter items by matching field_type
\n","type":"text/plain"},"key":"field_type","value":"string"},{"description":{"content":"Array[Integer]; Filter items by those without a link to a specific parent id (monitored service id)
\n","type":"text/plain"},"key":"unassigned_parent_id","value":"[1]"}],"variable":[]}},"response":[{"id":"db512dd3-c70f-4934-8eaf-5a64b96de3a5","name":"List Custom Fields","originalRequest":{"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/custom_field/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"next\": null,\n \"prev\": null,\n \"count\": 2,\n \"results\": [\n {\n \"display_name\": \"First Field\",\n \"field_name\": \"field_1\",\n \"field_type\": \"string\",\n \"description\": \"My first field\",\n \"id\": \"864b35f9-b042-4a9d-b6a4-f293e8ea7fda\",\n \"created\": \"2024-07-03T15:08:32.502585Z\",\n \"modified\": \"2024-07-03T15:08:32.502607Z\",\n \"external_id\": null\n },\n {\n \"display_name\": \"Second Field\",\n \"field_name\": \"field_2\",\n \"field_type\": \"string\",\n \"description\": \"My second field\",\n \"id\": \"98bb896d-5bfc-4ff2-968e-1054df7d9ee3\",\n \"created\": \"2024-07-03T18:31:52.247665Z\",\n \"modified\": \"2024-07-03T18:31:52.247707Z\",\n \"external_id\": null\n }\n ]\n}"}],"_postman_id":"7fec834e-7356-4040-9394-c0db399691c5"},{"name":"Retrieve a custom field","id":"284be47d-f1f9-4552-8e68-18b1efe313d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/custom_field/:custom_field_id/","description":"Returns a specific custom field.
\nCustom Field id
\n","type":"text/plain"},"type":"any","value":"","key":"custom_field_id"}]}},"response":[{"id":"c9ff5d9e-6c55-4bb1-9a97-c683fc9ca12e","name":"Retrieve Custom Field","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/custom_field/:custom_field_id/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","custom_field",":custom_field_id",""],"variable":[{"key":"custom_field_id","value":"","description":"Custom Field id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"display_name\": \"First Field\",\n \"field_name\": \"field_1\",\n \"field_type\": \"string\",\n \"description\": \"My first field\",\n \"id\": \"864b35f9-b042-4a9d-b6a4-f293e8ea7fda\",\n \"created\": \"2024-07-03T15:08:32.502585Z\",\n \"modified\": \"2024-07-03T15:08:32.502607Z\",\n \"external_id\": null\n}"}],"_postman_id":"284be47d-f1f9-4552-8e68-18b1efe313d5"},{"name":"List custom field types","id":"dd2484d4-22fb-4cf1-ab2c-8ca109956696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/custom_field/types","description":"Returns a list of custom field types.
\nCreates a custom field.
\nUpdates a custom field.
\nNote: Only the description and external_id fields can be updated. The display_name, field_name, and field_type are immutable after creation.
\nCustom Field id
\n","type":"text/plain"},"type":"any","value":"","key":"custom_field_id"}]}},"response":[{"id":"45187d40-5a1a-43f2-bf80-198919416202","name":"Update Custom Field","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"New description\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/custom_field/:custom_field_id/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","custom_field",":custom_field_id",""],"variable":[{"key":"custom_field_id","value":"","description":"Custom Field id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"display_name\": \"Example Field\",\n \"field_name\": \"example_field\",\n \"field_type\": \"string\",\n \"description\": \"New description\",\n \"id\": \"864b35f9-b042-4a9d-b6a4-f293e8ea7fda\",\n \"created\": \"2024-07-03T15:08:32.502585Z\",\n \"modified\": \"2024-07-03T15:08:32.502607Z\",\n \"external_id\": null\n}"}],"_postman_id":"c0f08b5b-98a2-4fdd-8f2a-8581c04dd15c"}],"id":"2812623b-94dd-4d4e-b7d9-3c5c78c64634","description":"The Custom Fields API controls the tenant-wide fields that can be custom-created and assigned to different monitored services.
\nNote: Delete operations for custom fields is disabled in this API for all users.
\nReference information for the custom fields endpoints:
\n","_postman_id":"2812623b-94dd-4d4e-b7d9-3c5c78c64634","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns the values associated with the custom fields for a monitored service.
\nInteger; Limits number of items returned
\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"Integer; Zero-based offset of the first item returned in the collection
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Array[String]; Fields used to order the results. Leading minus \"-\" symbol denotes descending ordering
\n","type":"text/plain"},"key":"ordering","value":"id"},{"description":{"content":"String; Restricts results to objects matching the search criteria
\n","type":"text/plain"},"key":"search","value":"test"},{"description":{"content":"String; Filter items by value
\n","type":"text/plain"},"key":"value__icontains","value":"value"},{"description":{"content":"Array[UUID]; Filter items by their custom_field_id
\n","type":"text/plain"},"key":"custom_field_id__in","value":"[\"586c7ec5-8a22-4f9e-b20f-1c32c17c6466\",\"9d1ec864-3700-453f-8bd0-038284da11db\"]"}],"variable":[{"description":{"content":"Monitored Service id
\n","type":"text/plain"},"type":"any","value":"{{ms_id}}","key":"ms_id"}]}},"response":[{"id":"29e6c820-cfc0-4ea6-ac2c-64824cd0fed1","name":"List MS Custom Field Value","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","monitoredservice",":ms_id","custom_fields",""],"variable":[{"key":"ms_id","value":"","description":"Monitored Service id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"next\": null,\n \"prev\": null,\n \"count\": 2,\n \"results\": [\n {\n \"value\": \"test_value\",\n \"custom_field_id\": \"bcd705b3-8de2-4e10-9de4-4c9a27d05060\",\n \"custom_field\": {\n \"display_name\": \"test_field_1\",\n \"field_name\": \"test_field_1\",\n \"field_type\": \"string\",\n \"description\": \"This is a test\",\n \"id\": \"bcd705b3-8de2-4e10-9de4-4c9a27d05060\",\n \"created\": \"2024-07-23T18:11:51.855378Z\",\n \"modified\": \"2024-07-23T18:11:51.855425Z\",\n \"external_id\": null\n },\n \"id\": \"485c31ec-e906-409e-81f0-9fdb0f42f4fa\",\n \"parent_id\": 1,\n \"created\": \"2024-07-23T18:12:56.348662Z\",\n \"modified\": \"2024-07-23T18:12:56.348700Z\",\n \"external_id\": null\n },\n {\n \"value\": \"test_value\",\n \"custom_field_id\": \"8fd819e0-4ecf-4d2b-95f4-e64e3eb18785\",\n \"custom_field\": {\n \"display_name\": \"test_field_2\",\n \"field_name\": \"test_field_2\",\n \"field_type\": \"string\",\n \"description\": \"\",\n \"id\": \"8fd819e0-4ecf-4d2b-95f4-e64e3eb18785\",\n \"created\": \"2024-07-23T18:27:49.891064Z\",\n \"modified\": \"2024-07-23T18:27:49.891086Z\",\n \"external_id\": null\n },\n \"id\": \"a880ea80-f055-4397-a5b1-375bbedc9758\",\n \"parent_id\": 1,\n \"created\": \"2024-07-23T18:28:00.737541Z\",\n \"modified\": \"2024-07-23T18:28:00.737569Z\",\n \"external_id\": null\n }\n ]\n}"}],"_postman_id":"f030d6a2-0caa-453e-a5fe-ec1f84600b64"},{"name":"Retrieve a MS custom field value","id":"72a14349-a379-4dc5-99c2-e133c2b84430","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/:custom_field_value_id/","description":"Returns the value associated with a specific custom field.
\nMonitored Service id
\n","type":"text/plain"},"type":"any","value":"{{ms_id}}","key":"ms_id"},{"description":{"content":"Custom Field Value id
\n","type":"text/plain"},"type":"any","value":"{{custom_field_value_id}}","key":"custom_field_value_id"}]}},"response":[{"id":"e9438feb-da6f-4964-b000-df8d491e03a6","name":"Retrieve MS Custom Field Value","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/:custom_field_value_id/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","monitoredservice",":ms_id","custom_fields",":custom_field_value_id",""],"variable":[{"key":"ms_id","value":"","description":"Monitored Service id"},{"key":"custom_field_value_id","value":"","description":"Custom Field Value id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"test_value\",\n \"custom_field_id\": \"bcd705b3-8de2-4e10-9de4-4c9a27d05060\",\n \"custom_field\": {\n \"display_name\": \"test_field_1\",\n \"field_name\": \"test_field_1\",\n \"field_type\": \"string\",\n \"description\": \"This is a test\",\n \"id\": \"bcd705b3-8de2-4e10-9de4-4c9a27d05060\",\n \"created\": \"2024-07-23T18:11:51.855378Z\",\n \"modified\": \"2024-07-23T18:11:51.855425Z\",\n \"external_id\": null\n },\n \"id\": \"485c31ec-e906-409e-81f0-9fdb0f42f4fa\",\n \"parent_id\": 1,\n \"created\": \"2024-07-23T18:12:56.348662Z\",\n \"modified\": \"2024-07-23T18:12:56.348700Z\",\n \"external_id\": null\n}"}],"_postman_id":"72a14349-a379-4dc5-99c2-e133c2b84430"},{"name":"Create MS custom field value","id":"d4e1c640-8eee-4b18-8938-5e042b14f27e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"value\": \"test_value\",\n \"custom_field_id\": \"{{Custom Field id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/","description":"Creates a new custom field value for a monitored service.
\nMonitored Service id
\n","type":"text/plain"},"type":"any","value":"{{ms_id}}","key":"ms_id"}]}},"response":[{"id":"81092a10-795a-45a5-af7f-53118f06d36c","name":"Create MS Custom Field Value","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"value\": \"test_value\",\n \"custom_field_id\": \"{{Custom Field id}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","monitoredservice",":ms_id","custom_fields",""],"variable":[{"key":"ms_id","value":"","description":"Monitored Service id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"test_value\",\n \"custom_field_id\": \"e308a3db-4527-4c6f-9bfd-02eb580a10e2\",\n \"custom_field\": {\n \"display_name\": \"test_field_3\",\n \"field_name\": \"test_field_3\",\n \"field_type\": \"string\",\n \"description\": \"\",\n \"id\": \"e308a3db-4527-4c6f-9bfd-02eb580a10e2\",\n \"created\": \"2024-07-23T19:02:26.139111Z\",\n \"modified\": \"2024-07-23T19:02:26.139141Z\",\n \"external_id\": null\n },\n \"id\": \"d2da8cfb-6cdb-4ba6-b02c-1ec85a1c32f4\",\n \"parent_id\": 1,\n \"created\": \"2024-07-23T19:02:33.705217Z\",\n \"modified\": \"2024-07-23T19:02:33.705245Z\",\n \"external_id\": null\n}"}],"_postman_id":"d4e1c640-8eee-4b18-8938-5e042b14f27e"},{"name":"Update MS custom field value","id":"86665965-7485-4589-adc2-0177eebaf522","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"value\": \"new_value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/:custom_field_value_id/","description":"Updates a custom field value for a specified monitored service.
\nMonitored Service id
\n","type":"text/plain"},"type":"any","value":"{{ms_id}}","key":"ms_id"},{"description":{"content":"Custom Field Value id
\n","type":"text/plain"},"type":"any","value":"{{custom_field_value_id}}","key":"custom_field_value_id"}]}},"response":[{"id":"1e3d097a-b7f8-49ec-8f2f-793a7dd791be","name":"Update MS Custom Field Value","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"value\": \"new_value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/:custom_field_value_id/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","monitoredservice",":ms_id","custom_fields",":custom_field_value_id",""],"variable":[{"key":"ms_id","value":"","description":"Monitored Service id"},{"key":"custom_field_value_id","value":"","description":"Custom Field Value id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"new_value\",\n \"custom_field_id\": \"e308a3db-4527-4c6f-9bfd-02eb580a10e2\",\n \"custom_field\": {\n \"display_name\": \"test_field_3\",\n \"field_name\": \"test_field_3\",\n \"field_type\": \"string\",\n \"description\": \"\",\n \"id\": \"e308a3db-4527-4c6f-9bfd-02eb580a10e2\",\n \"created\": \"2024-07-23T19:02:26.139111Z\",\n \"modified\": \"2024-07-23T19:02:26.139141Z\",\n \"external_id\": null\n },\n \"id\": \"d2da8cfb-6cdb-4ba6-b02c-1ec85a1c32f4\",\n \"parent_id\": 1,\n \"created\": \"2024-07-23T19:02:33.705217Z\",\n \"modified\": \"2024-07-23T19:17:11.457099Z\",\n \"external_id\": null\n}"}],"_postman_id":"86665965-7485-4589-adc2-0177eebaf522"},{"name":"Delete MS custom field value","id":"608a7a64-adf3-4d15-9455-b1ac01862220","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/:custom_field_value_id/","description":"Deletes a custom field value for a specified monitored service.
\nReturns HTTP 204 No Content on successful deletion.
\n","urlObject":{"protocol":"https","path":["api","v1","core","monitoredservice",":ms_id","custom_fields",":custom_field_value_id",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[{"description":{"content":"Monitored Service id
\n","type":"text/plain"},"type":"any","value":"{{ms_id}}","key":"ms_id"},{"description":{"content":"Custom Field Value id
\n","type":"text/plain"},"type":"any","value":"{{custom_field_value_id}}","key":"custom_field_value_id"}]}},"response":[{"id":"5c3eb314-7b17-4378-93a7-3bfc2f539d2c","name":"Delete MS custom field value","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://[your_subdomain].appomni.com/api/v1/core/monitoredservice/:ms_id/custom_fields/:custom_field_value_id/","protocol":"https","host":["[your_subdomain]","appomni","com"],"path":["api","v1","core","monitoredservice",":ms_id","custom_fields",":custom_field_value_id",""],"variable":[{"key":"ms_id","value":"","description":"Monitored Service id"},{"key":"custom_field_value_id","value":"","description":"Custom Field Value id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"608a7a64-adf3-4d15-9455-b1ac01862220"}],"id":"096c8bda-58fd-416d-b1a7-4df927ccea65","description":"The Custom Field Values API accesses the value of the custom field associated with a given monitored service.
\n","_postman_id":"096c8bda-58fd-416d-b1a7-4df927ccea65","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"List all settings modeling data with pagination and filtering support.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field to order results by
\n","type":"text/plain"},"key":"ordering","value":"name"},{"description":{"content":"String; Search term to filter results
\n","type":"text/plain"},"key":"search","value":"timeout"},{"description":{"content":"String; Filter by setting category
\n","type":"text/plain"},"key":"category","value":"Security"},{"description":{"content":"String; Filter by setting data type
\n","type":"text/plain"},"key":"type","value":"string"}],"variable":[]}},"response":[{"id":"93a8a7a8-6f51-4b44-971c-8dc93ad01d13","name":"Settings - List all modeling data","originalRequest":{"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 15:11:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"10/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 23:11:27 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 5,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"api_name\": \"allowed_email_domains\",\n \"value_type\": \"list_str\",\n \"label\": \"Allowed Email Domains\",\n \"description\": \"List of email domains allowed when users register\",\n \"choices\": null,\n \"default_risk\": \"medium\",\n \"default_category\": \"system_config\"\n },\n {\n \"api_name\": \"lockout_duration\",\n \"value_type\": \"picklist\",\n \"label\": \"Lockout Duration\",\n \"description\": \"Number of minutes a user is locked out after invalid login attempts\",\n \"choices\": {\n \"5\": \"5 Minutes\",\n \"10\": \"10 Minutes\"\n },\n \"default_risk\": \"medium\",\n \"default_category\": \"system_config\"\n },\n {\n \"api_name\": \"max_invalid_login_attempts\",\n \"value_type\": \"int\",\n \"label\": \"Max Invalid Login Attempts\",\n \"description\": \"The number of invalid login attempts before the user is locked out\",\n \"choices\": null,\n \"default_risk\": \"high\",\n \"default_category\": \"system_config\"\n },\n {\n \"api_name\": \"mfa_enforced\",\n \"value_type\": \"bool\",\n \"label\": \"MFA Enforced\",\n \"description\": \"Requires the use of MFA\",\n \"choices\": null,\n \"default_risk\": \"critical\",\n \"default_category\": \"system_config\"\n },\n {\n \"api_name\": \"password_change_interval\",\n \"value_type\": \"int\",\n \"label\": \"Password Change Interval\",\n \"description\": \"How many days until a user is required to change their password\",\n \"choices\": null,\n \"default_risk\": \"medium\",\n \"default_category\": \"system_config\"\n }\n ]\n}"}],"_postman_id":"c812f09b-a897-44b9-8546-dcb8af3a01e8"},{"name":"Settings - Add single modeling data","id":"b7c03780-1110-4644-bbc2-66708676a6e8","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_name\": \"password_change_interval\",\n \"value_type\": \"int\",\n \"label\": \"Password Change Interval\",\n \"description\": \"How many days until a user is required to change their password\",\n \"choices\": null,\n \"default_risk\": \"medium\",\n \"default_category\": \"system_config\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/","description":"Add a single setting to the modeling data.
\nAdd multiple settings to the modeling data.
\nReturns an array of created setting objects with the same fields as single setting creation.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}","settings","bulk_create",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"dea7107f-e36a-4026-9eae-df1c10c97f14","name":"Settings - Add multiple modeling data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"api_name\": \"allowed_email_domains\",\n \"value_type\": \"list_str\",\n \"label\": \"Allowed Email Domains\",\n \"description\": \"List of email domains allowed when users register\",\n \"choices\": null,\n \"default_risk\": \"medium\",\n \"default_category\": \"system_config\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/bulk_create/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 15:09:58 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Allow","value":"POST, PUT, OPTIONS"},{"key":"X-RateLimit","value":"9/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 23:09:58 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8bd0827e-915b-448d-a2c8-61a1e97705f6"},{"name":"Settings - Update modeling data","id":"03ae39c7-717a-4436-a88c-af6b592db934","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"api_name\": \"password_change_interval\",\n \"value_type\": \"int\",\n \"label\": \"Password Change Interval\",\n \"description\": \"How many days until a user is required to change their password\",\n \"choices\": null,\n \"default_risk\": \"high\",\n \"default_category\": \"system_config\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/","description":"Update an existing setting in the modeling data.
\nNote: name and type cannot be updated after creation.
\nReturns the updated setting object with the same fields as single setting creation.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}","settings",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"be93f7ed-84f1-4e29-bbb5-8a216284b6e4","name":"Settings - Update modeling data","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"api_name\": \"password_change_interval\",\n \"value_type\": \"int\",\n \"label\": \"Password Change Interval\",\n \"description\": \"How many days until a user is required to change their password\",\n \"choices\": null,\n \"default_risk\": \"high\",\n \"default_category\": \"system_config\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 15:12:38 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"11/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 23:12:38 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"03ae39c7-717a-4436-a88c-af6b592db934"},{"name":"Settings - Replace all modeling data","id":"5faab443-cdc9-49a7-9eb8-bab61bfb61b0","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"api_name\": \"mfa_enforced\",\n \"value_type\": \"bool\",\n \"label\": \"MFA Enforced\",\n \"description\": \"Requires the use of MFA\",\n \"choices\": null,\n \"default_risk\": \"critical\",\n \"default_category\": \"system_config\"\n },\n {\n \"api_name\": \"max_invalid_login_attempts\",\n \"value_type\": \"int\",\n \"label\": \"Max Invalid Login Attempts\",\n \"description\": \"The number of invalid login attempts before the user is locked out\",\n \"choices\": null,\n \"default_risk\": \"high\",\n \"default_category\": \"system_config\"\n },\n {\n \"api_name\": \"lockout_duration\",\n \"value_type\": \"picklist\",\n \"label\": \"Lockout Duration\",\n \"description\": \"Number of minutes a user is locked out after invalid login attempts\",\n \"choices\": {\"5\": \"5 Minutes\", \"10\": \"10 Minutes\"},\n \"default_risk\": \"medium\",\n \"default_category\": \"system_config\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/bulk_create/","description":"Replace all settings modeling data. This operation will delete all existing entries and create new ones.
\nReturns HTTP 200 with the created settings data.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}","settings","bulk_create",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"4764db1b-c3a2-4fad-aeb8-b64934d4f1ef","name":"Settings - Replace all modeling data","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"api_name\": \"mfa_enforced\",\n \"value_type\": \"bool\",\n \"label\": \"MFA Enforced\",\n \"description\": \"Requires the use of MFA\",\n \"choices\": null,\n \"default_risk\": \"critical\",\n \"default_category\": \"system_config\"\n },\n {\n \"api_name\": \"max_invalid_login_attempts\",\n \"value_type\": \"int\",\n \"label\": \"Max Invalid Login Attempts\",\n \"description\": \"The number of invalid login attempts before the user is locked out\",\n \"choices\": null,\n \"default_risk\": \"high\",\n \"default_category\": \"system_config\"\n },\n {\n \"api_name\": \"lockout_duration\",\n \"value_type\": \"picklist\",\n \"label\": \"Lockout Duration\",\n \"description\": \"Number of minutes a user is locked out after invalid login attempts\",\n \"choices\": {\"5\": \"5 Minutes\", \"10\": \"10 Minutes\"},\n \"default_risk\": \"medium\",\n \"default_category\": \"system_config\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/bulk_create/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 14:58:51 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Allow","value":"POST, PUT, OPTIONS"},{"key":"X-RateLimit","value":"10/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 22:58:51 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5faab443-cdc9-49a7-9eb8-bab61bfb61b0"},{"name":"Settings - Delete multiple modeling data","id":"6df36525-dfcd-4d95-a7f1-17c4e3705472","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"setting_names\": [\"password_change_interval\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/","description":"Delete multiple settings from the modeling data.
\nReturns HTTP 204 No Content on successful deletion.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}","settings",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"d621e119-7a49-4380-8c7c-69e868987af2","name":"Settings - Delete multiple modeling data","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"setting_names\": [\"password_change_interval\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/settings/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 15:13:08 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"12/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 23:13:08 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6df36525-dfcd-4d95-a7f1-17c4e3705472"},{"name":"Permissions - List all modeling data","id":"78e778f3-fb82-4175-881b-0fd5dc7347c9","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/?limit=50&offset=0&ordering=id&search=document&category=Document Management","description":"List all permissions modeling data with pagination and filtering support.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field to order results by
\n","type":"text/plain"},"key":"ordering","value":"id"},{"description":{"content":"String; Search term to filter results
\n","type":"text/plain"},"key":"search","value":"document"},{"description":{"content":"String; Filter by permission category
\n","type":"text/plain"},"key":"category","value":"Document Management"}],"variable":[]}},"response":[{"id":"67fc7639-32b3-4652-8414-f6efb8767ab2","name":"Permissions - List all modeling data","originalRequest":{"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 14:24:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"9/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 22:24:13 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 7,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"api_name\": \"create-group\",\n \"label\": \"Create Group\",\n \"description\": \"Allows user to create a new group\",\n \"default_risk\": \"medium\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": false\n },\n {\n \"api_name\": \"create-project\",\n \"label\": \"Create Project\",\n \"description\": \"Allows user to create a new project\",\n \"default_risk\": \"medium\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": false\n },\n {\n \"api_name\": \"edit-all\",\n \"label\": \"Edit All\",\n \"description\": \"Allows user to edit all records\",\n \"default_risk\": \"high\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": false,\n \"indicates_admin\": true\n },\n {\n \"api_name\": \"edit_groups\",\n \"label\": \"Edit Groups\",\n \"description\": \"Allows user to edit existing groups\",\n \"default_risk\": \"critical\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": false\n },\n {\n \"api_name\": \"manage-users\",\n \"label\": \"Manage Users\",\n \"description\": \"Allows user to manage other user accounts\",\n \"default_risk\": \"critical\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": true\n },\n {\n \"api_name\": \"read-all\",\n \"label\": \"Read All\",\n \"description\": \"Allows user to read all records\",\n \"default_risk\": \"medium\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": false,\n \"indicates_admin\": false\n },\n {\n \"api_name\": \"write-all\",\n \"label\": \"Write All\",\n \"description\": \"Allows user to write all records\",\n \"default_risk\": \"critical\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": true\n }\n ]\n}"}],"_postman_id":"78e778f3-fb82-4175-881b-0fd5dc7347c9"},{"name":"Permissions - Add single modeling data","id":"2906eb87-0afa-4445-b413-01a8d3d419d7","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_name\": \"edit-all\",\n \"label\": \"Edit All\",\n \"description\": \"Allows user to edit all records\",\n \"default_risk\": \"high\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": false,\n \"indicates_admin\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/","description":"Add a single permission to the modeling data.
\nAdd multiple permissions to the modeling data.
\nReturns an array of created permission objects with the same fields as single permission creation.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}","permissions","bulk_create",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"2bd6af71-b777-4e69-b982-e6fb5ba06e63","name":"Permissions - Add multiple modeling data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"api_name\": \"create-group\",\n \"label\": \"Create Group\",\n \"description\": \"Allows user to create a new group\",\n \"default_risk\": \"medium\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": false\n },\n {\n \"api_name\": \"create-project\",\n \"label\": \"Create Project\",\n \"description\": \"Allows user to create a new project\",\n \"default_risk\": \"medium\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/bulk_create/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 14:04:46 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Allow","value":"POST, PUT, OPTIONS"},{"key":"X-RateLimit","value":"8/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 22:04:46 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"13ff05af-4b76-4595-9f55-fcc4b284bc66"},{"name":"Permissions - Update modeling data","id":"0ceb8143-be29-4dae-9f53-cd6e810194a5","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"api_name\": \"create-group\",\n \"label\": \"Create New Group\",\n \"description\": \"Allows user to create a new group\",\n \"default_risk\": \"low\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": false,\n \"indicates_admin\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/","description":"Update an existing permission in the modeling data.
\nNote: technical_name cannot be updated after creation.
\nReturns the updated permission object with the same fields as single permission creation.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}","permissions",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"a67ff62a-6edd-436b-9243-2f182fcf7b97","name":"Permissions - Update modeling data","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"api_name\": \"create-group\",\n \"label\": \"Create New Group\",\n \"description\": \"Allows user to create a new group\",\n \"default_risk\": \"low\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": false,\n \"indicates_admin\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 14:45:35 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"12/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 22:45:35 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0ceb8143-be29-4dae-9f53-cd6e810194a5"},{"name":"Permissions - Replace all modeling data","id":"71ac336c-9236-4e87-acab-5e42e7fe89e3","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"api_name\": \"read-all\",\n \"label\": \"Read All\",\n \"description\": \"Allows user to read all records\",\n \"default_risk\": \"medium\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": false,\n \"indicates_admin\": false\n },\n {\n \"api_name\": \"write-all\",\n \"label\": \"Write All\",\n \"description\": \"Allows user to write all records\",\n \"default_risk\": \"critical\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": true\n },\n {\n \"api_name\": \"manage-users\",\n \"label\": \"Manage Users\",\n \"description\": \"Allows user to manage other user accounts\",\n \"default_risk\": \"critical\",\n \"default_category\": \"administrative_permissions\",\n \"indicates_elevated\": true,\n \"indicates_admin\": true\n },\n {\n \"api_name\": \"edit_groups\",\n \"label\": \"Edit Groups\",\n \"description\": \"Allows user to edit existing groups\",\n \"default_risk\": \"high\",\n \"default_category\": \"rbac_controls\",\n \"indicates_elevated\": true,\n \"indicates_admin\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/bulk_create/","description":"Replace all permissions modeling data. This operation will delete all existing entries and create new ones.
\nReturns HTTP 200 with the created permissions data.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}","permissions","bulk_create",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"3b0fe8ae-fa43-4c84-9512-aee1bb6a9b0a","name":"Permissions - Replace all modeling data","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"api_name\": \"read-all\",\n \"label\": \"Read All\",\n \"description\": \"Allows user to read all records\",\n \"default_risk\": \"medium\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": false,\n \"indicates_admin\": false\n },\n {\n \"api_name\": \"write-all\",\n \"label\": \"Write All\",\n \"description\": \"Allows user to write all records\",\n \"default_risk\": \"critical\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": true\n },\n {\n \"api_name\": \"manage-users\",\n \"label\": \"Manage Users\",\n \"description\": \"Allows user to manage other user accounts\",\n \"default_risk\": \"critical\",\n \"default_category\": \"administrative_permissions\",\n \"indicates_elevated\": true,\n \"indicates_admin\": true\n },\n {\n \"api_name\": \"edit_groups\",\n \"label\": \"Edit Groups\",\n \"description\": \"Allows user to edit existing groups\",\n \"default_risk\": \"high\",\n \"default_category\": \"rbac_controls\",\n \"indicates_elevated\": true,\n \"indicates_admin\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/bulk_create/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 17 Sep 2025 18:31:09 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Allow","value":"POST, PUT, OPTIONS"},{"key":"X-RateLimit","value":"1/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Thu, 18 Sep 2025 02:31:09 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"71ac336c-9236-4e87-acab-5e42e7fe89e3"},{"name":"Permissions - Delete multiple modeling data","id":"cb87ee2e-6aef-4d38-a63f-e1552df5c9f2","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"permission_names\": [\"create-group\", \"create-project\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/","description":"Delete multiple permissions from the modeling data.
\nReturns HTTP 204 No Content on successful deletion.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}","permissions",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"0a463f0f-3662-466d-995b-a086c5c29267","name":"Permissions - Delete multiple modeling data","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"permission_names\": [\"create-group\", \"create-project\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/permissions/"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 14:33:55 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"close"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"9/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 22:33:55 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cb87ee2e-6aef-4d38-a63f-e1552df5c9f2"},{"name":"Scopes - List all modeling data","id":"b54ceb12-a9ec-4152-85dc-af0954dfab72","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/scopes/?limit=25&offset=0&ordering=api_name","description":"List all scopes modeling data with pagination and filtering support.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field to order results by
\n","type":"text/plain"},"key":"ordering","value":"api_name"}],"variable":[]}},"response":[{"id":"b3002aeb-2684-4099-8b57-f540a9a8ad2a","name":"Scopes - List all modeling data","originalRequest":{"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/scopes/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 22 Sep 2025 14:24:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"Allow","value":"GET, POST, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"9/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Mon, 22 Sep 2025 22:24:13 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 3,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"api_name\": \"system_admin\",\n \"label\": \"System Admin\",\n \"description\": \"An admin of the application\",\n \"default_risk\": \"critical\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": true\n },\n {\n \"api_name\": \"billing_admin\",\n \"label\": \"Billing Admin\",\n \"description\": \"A billing admin of the application\",\n \"default_risk\": \"high\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": true,\n \"indicates_admin\": false\n },\n\t\t\t\t{\n \"api_name\": \"read_only\",\n \"label\": \"Read-Only User\",\n \"description\": \"A read-only user of the application\",\n \"default_risk\": \"low\",\n \"default_category\": \"data_access\",\n \"indicates_elevated\": false,\n \"indicates_admin\": false\n }\n ]\n}"}],"_postman_id":"b54ceb12-a9ec-4152-85dc-af0954dfab72"},{"name":"Scopes - Add single modeling data","id":"2cb5e63c-080a-48c5-9ae7-c68afc2ef014","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/scopes/","description":"Add a single scope to the modeling data.
\nAdd multiple scopes to the modeling data.
\nUpdate an existing scope in the modeling data.
\nReplace all scope modeling data. This operation will delete all existing entries and create new ones.
\nDelete multiple permissions from the modeling data.
\nModeling data is what adds the contextual information to permissions and settings such as their risk level or category that is displayed within Posture Explorer and other areas of AppOmni's UI.
\nFor permissions, the modeling data is also what defines if a user having a certain permission qualifies them as either an elevated or admin user.
\nIf the custom monitored service type is configured to expect RBAC and/or settings data, you must also configure the modeling data for the permissions or settings you want to monitor within your application.
\nThe modeling data only needs to be set once unless you wish to make changes to it. You are not required to update or send the modeling data each time you send AppOmni the RBAC elements or settings for a monitored service that uses a custom monitored service type.
\n","_postman_id":"caddfaac-3572-4f25-805f-bdcbbfce7e00","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Sends the current values of your application's security settings (e.g., MFA enabled, session timeout) for posture evaluation.
\nSystem settings data represents the security-relevant configuration of your SaaS application. Each setting is identified by a unique name and its current value. Examples include MFA enforcement toggles, session timeout durations, password complexity requirements, and API access controls.
\nWhen you ingest system settings, AppOmni compares the current values against your expected values (if configured) and evaluates them using posture rules to generate findings. The settings and their values are displayed within Posture Explorer.
\nSystem settings should be sent on a regular cadence to reflect the current state of your application's configuration. Each submission replaces the previous set of settings for that monitored service.
\nDefines the expected or baseline values for each security setting so AppOmni can flag deviations.
\nWhen AppOmni evaluates your system configuration, it compares the actual setting values (from system_config_v2) against these expected values to determine compliance and generate findings.
Each expected value entry references a setting by its name (which must match a setting previously ingested via system_config_v2) and specifies the expected_value that setting should have. An optional external_id can be included to map the setting to an external compliance framework or control identifier.
Expected values only need to be set once unless your compliance baseline changes. You are not required to resend expected values each time you submit updated system settings.
\nSubmits the inventory of user accounts in your application, including their profile information, status, and optionally their role assignments.
\nUser data represents the full inventory of user accounts in your SaaS application. Each user record includes identifying information such as username, email, and display name, along with security-relevant attributes like whether MFA is enabled, whether the account is active, and when the user last logged in.
\nUser records can optionally include inline RBAC references (primary_rbac_ids, secondary_rbac_ids, other_rbac_ids) as a convenience, which associates users with roles without requiring separate RBAC assignment submissions. Alternatively, RBAC assignments can be sent as dedicated jobs.
User data should be sent on a regular cadence to reflect the current state of your application's user population. Each submission replaces the previous set of users for that monitored service.
\nSends the list of primary/secondary/other roles and the permissions each role grants.
\nRBAC elements represent the roles, profiles, permission sets, or groups that exist within your application. These are the structural building blocks of your application's access control model.
\nThe three tiers -- primary, secondary, and other -- allow you to model hierarchical or layered access control systems. For example, primary elements might represent top-level roles (e.g., \"System Admin\"), secondary elements might represent permission sets or groups, and other elements can capture any additional RBAC constructs. All three tiers share the same data schema; only the data_type value differs.
RBAC elements should be sent on a regular cadence to reflect the current set of roles and permissions in your application. The observed_permissions on each element should reference permission names that match entries previously ingested via system_permissions_options.
Maps which users are assigned to which roles.
\nEach assignment is a pairing of a rbac_id (referencing an element ingested via the corresponding RBAC elements data type) and a user_id (referencing a user ingested via user_data_v2).
The three tiers correspond to the RBAC element tiers: primary assignments link users to primary elements, secondary assignments to secondary elements, and so on. All three tiers share the same data schema; only the data_type value differs.
RBAC assignments are an alternative to including primary_rbac_ids, secondary_rbac_ids, and other_rbac_ids inline on user data records. Using dedicated assignment jobs is recommended when the number of assignments is large or when assignments change independently of user attributes. Assignments should be sent on a regular cadence to reflect current access.
Submits the inventory of third-party applications and integrations installed in your application, including their granted scopes.
\nThird party apps data represents the inventory of applications, integrations, and OAuth clients installed or connected within your SaaS application.
\nAdditional optional fields allow you to capture version information, whether the app is a first-party default, whether it was internally developed, the publisher identity, and installation details such as who installed it and when.
\nThird party app data should be sent on a regular cadence to reflect the current set of installed applications and their granted permissions. Each submission replaces the previous app inventory for that monitored service.
\nFor use after submission of ingestion data via POST /platform/ingest/v2/ingest
Response Fields:
\n","urlObject":{"protocol":"https","path":["api","v1","custom","datajob","status",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"3c4145c5-0154-40e6-940a-486f9fc9e622","name":"Job Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_id\": \"550e8400-e29b-41d4-a716-446655440040\",\n \"ingest_token\": \"dccc49c0-43e6-40c8-a826-724984887af6\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/datajob/status/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Fri, 13 Mar 2026 16:11:01 GMT"},{"key":"content-type","value":"application/json"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie, origin"},{"key":"allow","value":"POST, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"content-security-policy","value":"frame-ancestors 'self'"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"job_id\": \"550e8400-e29b-41d4-a716-446655440040\",\n \"status\": \"completed\",\n \"as_of\": \"2026-03-13T16:08:50.073805Z\",\n \"details\": null,\n \"failed_required_jobs\": [],\n \"failure_errors\": []\n}"}],"_postman_id":"e174c7e1-6fb7-4ea4-bc73-8eb63205b12f"}],"id":"7540e300-3b59-4c99-ba6d-1fbfd5e22efb","description":"The Custom Ingest endpoint (/platform/ingest/v2/ingest/) allows you to push security-relevant data from any SaaS application into AppOmni for posture evaluation and threat detection. It is the primary data ingestion mechanism for Custom Monitored Services.
Each request submits a batch of data for a specific custom monitored service, authenticated by the service's service_id and ingest_token. The job_type field determines which category of data is being submitted (e.g., users, roles, settings, apps), and the data array contains the records matching that type's schema.
{\n \"service_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"ingest_token\": \"dccc49c0-43e6-40c8-a826-724984887af6\",\n \"job_type\": \"data_type\",\n \"job_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"data\": []\n}\n\n\nThe endpoint supports paginated submissions for large datasets. Multiple requests can be correlated into a single logical job using a shared job_identifier, with page_offset tracking position and complete signaling the final page. AppOmni begins processing the data once all pages have been received or the job is marked complete.
The response returns the job_identifier, which can be used to check processing status via the Data Job Status API.
{\n \"job_identifier\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"complete\": true\n}\n\n\n","_postman_id":"7540e300-3b59-4c99-ba6d-1fbfd5e22efb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Create a new custom monitored service type.
\nUpload a logo image for a custom monitored service type.
\nThe request should be sent as multipart/form-data with the following field:
\nMaximum file size: 5MB
\nSupported formats: PNG, JPG, JPEG, SVG
\nRecommended dimensions: 256x256 pixels
\nUpdate an existing custom monitored service type.
\nNote: The service type name/id cannot be changed after creation.
\nReturns the updated service type object with the same fields as creation response.
\n","urlObject":{"protocol":"https","path":["api","v1","custom","custommonitoredservicetype","{{cmst_id}}",""],"host":["[your_subdomain]","appomni","com"],"query":[],"variable":[]}},"response":[{"id":"a875e1dd-dad0-4b69-a373-c41d2caae7bf","name":"Update a custom monitored service type","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"Updated description\",\n \"expect_security_settings_data\": true,\n \"expect_rbac_data\": true,\n \"expect_user_data\": true,\n \"expect_apps_data\": false,\n \"primary_rbac_term\": \"Role\",\n \"secondary_rbac_term\": \"Group\",\n \"other_rbac_term\": \"Project\",\n \"supports_last_login\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Wed, 17 Sep 2025 14:40:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Authorization, Cookie, origin"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-RateLimit","value":"4/2000"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Set-Cookie","value":"sessionid=x; expires=Wed, 17 Sep 2025 22:40:14 GMT; Max-Age=28800; Path=/; SameSite=Lax; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 7585,\n \"created\": \"2025-09-17T12:28:29.835670Z\",\n \"modified\": \"2025-09-17T14:40:14.524475Z\",\n \"external_id\": null,\n \"name\": \"AcmeSaas\",\n \"slug\": \"yourtenant__acmesaas\",\n \"description\": \"Updated description\",\n \"logo\": \"https://storage.googleapis.com/path-to-logo\",\n \"major_version\": 1,\n \"minor_version\": 0,\n \"patch_version\": 0,\n \"primary_rbac_term\": \"Role\",\n \"secondary_rbac_term\": \"Group\",\n \"other_rbac_term\": \"Project\",\n \"instance_term\": null,\n \"expect_security_settings_data\": true,\n \"expect_rbac_data\": true,\n \"expect_user_data\": true,\n \"expect_apps_data\": false,\n \"supports_last_login\": true\n}"}],"_postman_id":"cc89c97a-b343-48ec-8b38-dae9d69bff86"},{"name":"Get custom monitored service type details","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"requests":{},"id":"aa8bec4d-8e79-45e0-961b-9e868a08bfa6"}}],"id":"d5fa4898-3070-49a8-93be-8dc04c108383","protocolProfileBehavior":{"disableCookies":true,"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://[your_subdomain].appomni.com/api/v1/custom/custommonitoredservicetype/{{cmst_id}}/","description":"Retrieve details of a specific custom monitored service type.
\nThe AppOmni Developer Platform (AODP) enables the creation of custom service types allowing you to monitor the security posture of any application, including custom or proprietary apps that AppOmni does not natively support.
\nExample use cases include:
\nCreate a custom service type for applications that AppOmni does not natively support
\nCreate a custom service type for custom or in-house apps not accessible to AppOmni over the internet
\nExtend AppOmni's natively supported applications by adding unsupported or custom settings to existing monitored services
\nA crucial difference between custom service types created with AODP and the applications AppOmni natively supports is that AODP requires you to regularly push data to AppOmni instead of relying on AppOmni's automated syncs that pull data into the platform.
\nAdditionally, monitored services created using custom service types have the following limitations:
\nOnly universal insights are applied and scanned for.
\nSnapshotting of system settings to convert them to policy rules is not supported.
\nOnly custom policies can be used. For further information on creating custom policy settings and rules, see the Create Custom Security Posture Policies documentation page.
\nThreat detection is not supported.
\nThe API endpoints documented here allow you to create a custom monitored service type and define all of its applicable metadata and modeling data.
\nAfter you onboard a new monitored service using your custom monitored service type, you will need to begin sending AppOmni the required data the monitored service is expected to monitor (settings, users, RBAC elements, etc).
\nSee the AppOmni Developer Platform page in our documentation for how to obtain the AODP SDK (written in Python) and how to use it to send AppOmni the required data for your custom monitored services.
\n","_postman_id":"7884bab2-d5c2-4d20-807e-8872fcc008b7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"BETA - The policy_stats endpoint retrieves policy assessment statistics for a specified policy ID.
\nThis endpoint only works for posture policies. It will return a 404 for functional and data security policies.
\nThe stats are not realtime; they are based on the last recalculation, which happens once per day.
\nInteger; Policy ID to retrieve stats for
\n","type":"text/plain"},"type":"any","value":"{{policy_id}}","key":"policy_id"}]}},"response":[{"id":"0b8d3650-5279-456e-97c7-6ee91793cb04","name":"Get policy stats","originalRequest":{"method":"GET","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"93\",\n \"name\": \"O365 - Prod\",\n \"stats\": {\n \"critical\": {\n \"count_passing\": 35,\n \"count_failing\": 35\n },\n \"high\": {\n \"count_passing\": 30,\n \"count_failing\": 30\n },\n \"medium\": {\n \"count_passing\": 25,\n \"count_failing\": 25\n }\n }\n },\n {\n \"id\": \"94\",\n \"name\": \"SFDCOrg 1f51478c-d96f-1324-a228-d78187f07dc4\",\n \"stats\": {\n \"critical\": {\n \"count_passing\": 30,\n \"count_failing\": 30\n },\n \"high\": {\n \"count_passing\": 25,\n \"count_failing\": 25\n },\n \"medium\": {\n \"count_passing\": 20,\n \"count_failing\": 20\n }\n }\n }\n]"}],"_postman_id":"a39a2403-cfae-44fa-a3ea-b16579208309"}],"id":"2785d32e-a433-4a19-a74f-8ed282f654b8","description":"THIS FEATURE IS IN BETA - Please contact Customer Success to enable this early access API
\nProvides a granular breakdown of policy assessments across monitored services, allowing you to identify areas of compliance and risk.
\nThe response returns a nested dictionary structure mapping monitored services to their associated risk levels, and providing passing/failing counts for each risk level.
\n","_postman_id":"2785d32e-a433-4a19-a74f-8ed282f654b8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Returns a list of value lists.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field to order results by (name, -name, created, -created)
\n","type":"text/plain"},"key":"ordering","value":"name"},{"description":{"content":"String; Search term to filter results by name
\n","type":"text/plain"},"key":"search","value":"power"},{"description":{"content":"String; Filter by list type (strings, integers, etc.)
\n","type":"text/plain"},"key":"list_type","value":"strings"},{"description":{"content":"String; Filter by list usage identifier
\n","type":"text/plain"},"key":"list_usage","value":"o365_power_platform_domains"}],"variable":[]}},"response":[],"_postman_id":"d42c270c-d722-43ba-af7f-af3b53eebb68"},{"name":"Create Value List","id":"4fc4ed62-6e04-4ab1-afa1-b7423a3040e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Power Platform Domains\",\n \"list_type\": \"strings\",\n \"list_usage\": \"o365_power_platform_domains\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/valuelist/","description":"Creates a new value list.
\nReturns a list of value list elements.
\nInteger; Maximum number of results to return
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Integer; Zero-based offset of the item page returned
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"String; Field to order results by (value, -value, created, -created)
\n","type":"text/plain"},"key":"ordering","value":"value"},{"description":{"content":"Integer; Filter by parent value list ID
\n","type":"text/plain"},"key":"parent","value":"{{valuelist_id}}"},{"description":{"content":"String; Filter by element type
\n","type":"text/plain"},"key":"element_type","value":"strings"},{"description":{"content":"String; Filter elements containing this value
\n","type":"text/plain"},"key":"value__icontains","value":"dynamics"}],"variable":[]}},"response":[],"_postman_id":"5a378f25-cc33-43a6-8e1a-9aaed612fb3a"},{"name":"Create Value List Element","id":"298f96db-905a-4911-977e-ac51bb157249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"parent\": {{valuelist_id}},\n \"element_type\": \"strings\",\n \"value\": \"https://example.crm.dynamics.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://[your_subdomain].appomni.com/api/v1/core/valuelistelement/","description":"Creates a new value list element.
\nValueList and ValueListElement are used to manage lists of items used by Insights. ValueLists have a type designation and will be used by Insights on convention based on their type.
\nReturns a paginated list of the latest Marlin AI results in your environment.
\nEach entry includes metadata such as playbook_id, playbook_name, playbook_description, created_at, risk_classification, ms_types, final_analysis, remediation_suggestions, summary
\nMarlin AI is an autonomous SaaS security AI that runs platform-wide deep analyses and correlations automatically across security observations in the AppOmni platform
\n","_postman_id":"7417b5d4-062b-4f1c-9a86-554791bd6925","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"