diff --git a/docs/api-reference/v2/endpoints/activities/get-fireworkv2activities--ai_assistance.mdx b/docs/api-reference/v2/endpoints/activities/get-fireworkv2activities--ai_assistance.mdx index 6ff2417c..07c546f1 100644 --- a/docs/api-reference/v2/endpoints/activities/get-fireworkv2activities--ai_assistance.mdx +++ b/docs/api-reference/v2/endpoints/activities/get-fireworkv2activities--ai_assistance.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/activities/{index}/{source}/{id}/ai_assistance title: Retrieve Event AI Assistance ---- \ No newline at end of file +--- + +import PermissionReadAll from '/snippets/permission-read-all.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/activities/get-fireworkv2activities-.mdx b/docs/api-reference/v2/endpoints/activities/get-fireworkv2activities-.mdx index 4f0ce774..9641605c 100644 --- a/docs/api-reference/v2/endpoints/activities/get-fireworkv2activities-.mdx +++ b/docs/api-reference/v2/endpoints/activities/get-fireworkv2activities-.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi get /firework/v2/activities/ title: Retrieve Event --- +import PermissionReadAll from '/snippets/permission-read-all.mdx' + + + This response changes based on the event type, for more information the various possible responses, see [Event Types ](/event-types/overview). diff --git a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets-alerts.mdx b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets-alerts.mdx index 525657b9..f42bf79c 100644 --- a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets-alerts.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets-alerts.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi delete /firework/v2/assets/{asset_id}/alerts/{alert_id} title: Delete Identifier Alerts ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets.mdx b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets.mdx index af3c1084..0792fc9c 100644 --- a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi delete /firework/v2/assets/{asset_id} title: Delete Identifier --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/identifiers/\{identifier_id\} ](/api-reference/v4/endpoints/delete-identifier) diff --git a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assetsgroups-alerts.mdx b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assetsgroups-alerts.mdx index 40261650..7ad5805c 100644 --- a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assetsgroups-alerts.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assetsgroups-alerts.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi delete /firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id} title: Delete Identifier Group Alert ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assetsgroups.mdx b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assetsgroups.mdx index dde735ae..ece4bae3 100644 --- a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assetsgroups.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assetsgroups.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi delete /firework/v2/assets/groups/{assets_group_id} title: Delete Identifier Group ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assets-alerts.mdx b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assets-alerts.mdx index 4b292c60..961b7710 100644 --- a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assets-alerts.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assets-alerts.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/assets/{asset_id}/alerts title: List Identifier Alerts ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assets-feed.mdx b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assets-feed.mdx index 5ffcfdb7..b096c4cf 100644 --- a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assets-feed.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assets-feed.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi get /firework/v2/assets/{asset_id}/feed title: List Identifier Events --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/events/identifiers/\{identifier_id\}/_search ](/api-reference/v4/endpoints/identifier-feed) diff --git a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-1.mdx b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-1.mdx index e4540f2c..4019e2ec 100644 --- a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-1.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-1.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/assets/groups/{assets_group_id} title: Retrieve Identifier Group ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-alerts.mdx b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-alerts.mdx index cc7e9fa2..eb12a7ed 100644 --- a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-alerts.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-alerts.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/assets/groups/{assets_group_id}/alerts title: List Identifier Group Alerts ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-feed.mdx b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-feed.mdx index 96dc5336..aa2835cd 100644 --- a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-feed.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-feed.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi get /firework/v2/assets/groups/{assets_group_id}/fe title: List Identifier Groups Events --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/events/identifier_groups/\{identifier_group_id\}/_search ](/api-reference/v4/endpoints/identifier-group-feed) diff --git a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups.mdx b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups.mdx index 7d69d596..7b590f90 100644 --- a/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/assets/groups/ title: List Identifier Groups ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-alerts.mdx b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-alerts.mdx index 9e0ba427..846ceca0 100644 --- a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-alerts.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-alerts.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/assets/{asset_id}/alerts title: Create Identifier Alert ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle.mdx b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle.mdx index 2a90c839..8257d94a 100644 --- a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi post /firework/v2/assets/{asset_id}/toggle title: Enable/Disable Identifier --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/identifiers/\{identifier_id\} ](/api-reference/v4/endpoints/update-identifier) diff --git a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets.mdx b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets.mdx index d8242367..c8c2c03e 100644 --- a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi post /firework/v2/assets/ title: Create Identifier --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/identifiers/ ](/api-reference/v4/endpoints/create-identifier) diff --git a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assetsgroups-alerts.mdx b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assetsgroups-alerts.mdx index daf297c8..1f45e814 100644 --- a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assetsgroups-alerts.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assetsgroups-alerts.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/assets/groups/{assets_group_id}/alerts title: Create Identifier Group Alerts ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assetsgroups.mdx b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assetsgroups.mdx index 7ff1b51b..66ae82fd 100644 --- a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assetsgroups.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assetsgroups.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/assets/groups/ title: Create Identifier Groups ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets-alerts.mdx b/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets-alerts.mdx index 746065a0..2ed5ced6 100644 --- a/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets-alerts.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets-alerts.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi put /firework/v2/assets/{asset_id}/alerts/{alert_id} title: Update Identifier Alert ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets.mdx b/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets.mdx index 5dc875f1..0c2e13e9 100644 --- a/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi put /firework/v2/assets/{asset_id} title: Update Identifier --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/identifiers/\{identifier_id\} ](/api-reference/v4/endpoints/update-identifier) diff --git a/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assetsgroups-alerts.mdx b/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assetsgroups-alerts.mdx index 9c969857..caf3230d 100644 --- a/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assetsgroups-alerts.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assetsgroups-alerts.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi put /firework/v2/assets/groups/{assets_group_id}/alerts/{alert_id} title: Update Identifier Group Alert ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/me/get-fireworkv2mefeed.mdx b/docs/api-reference/v2/endpoints/me/get-fireworkv2mefeed.mdx index e529a819..7d65d10d 100644 --- a/docs/api-reference/v2/endpoints/me/get-fireworkv2mefeed.mdx +++ b/docs/api-reference/v2/endpoints/me/get-fireworkv2mefeed.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi get /firework/v2/me/feed title: List Tenant Events --- +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/events/tenant/_search ](/api-reference/v4/endpoints/current-tenant-feed) diff --git a/docs/api-reference/v2/endpoints/me/get-fireworkv2mefeedcredentials.mdx b/docs/api-reference/v2/endpoints/me/get-fireworkv2mefeedcredentials.mdx index 65bb6dae..bb939e6f 100644 --- a/docs/api-reference/v2/endpoints/me/get-fireworkv2mefeedcredentials.mdx +++ b/docs/api-reference/v2/endpoints/me/get-fireworkv2mefeedcredentials.mdx @@ -3,4 +3,8 @@ openapi: firework-v2-openapi get /firework/v2/me/feed/credentials title: List Tenant Credentials --- +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + + This endpoint will list all credentials that match the current tenant's monitored identifiers. diff --git a/docs/api-reference/v2/endpoints/me/get-fireworkv2meprofile.mdx b/docs/api-reference/v2/endpoints/me/get-fireworkv2meprofile.mdx index ea678a9a..73b83167 100644 --- a/docs/api-reference/v2/endpoints/me/get-fireworkv2meprofile.mdx +++ b/docs/api-reference/v2/endpoints/me/get-fireworkv2meprofile.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/me/profile title: Retrieve User Profile ---- \ No newline at end of file +--- + +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/me/get-fireworkv2metenants.mdx b/docs/api-reference/v2/endpoints/me/get-fireworkv2metenants.mdx index 9de65b0f..5c305b95 100644 --- a/docs/api-reference/v2/endpoints/me/get-fireworkv2metenants.mdx +++ b/docs/api-reference/v2/endpoints/me/get-fireworkv2metenants.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/me/tenants title: List User Tenants ---- \ No newline at end of file +--- + +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/me/put-fireworkv2meprofile.mdx b/docs/api-reference/v2/endpoints/me/put-fireworkv2meprofile.mdx index 9e06b541..e7998e0f 100644 --- a/docs/api-reference/v2/endpoints/me/put-fireworkv2meprofile.mdx +++ b/docs/api-reference/v2/endpoints/me/put-fireworkv2meprofile.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi put /firework/v2/me/profile title: Update User Profile ---- \ No newline at end of file +--- + +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members-1.mdx b/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members-1.mdx index ab905407..b1b1374d 100644 --- a/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members-1.mdx +++ b/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members-1.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/organizations/{organization_id}/members/{user_id} title: Retrieve Organization Member ---- \ No newline at end of file +--- + +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members-tenants.mdx b/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members-tenants.mdx index 486dbf39..629d7c2e 100644 --- a/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members-tenants.mdx +++ b/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members-tenants.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/organizations/{organization_id}/members/{user_id}/tenants title: List Organization Member Tenants ---- \ No newline at end of file +--- + +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members.mdx b/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members.mdx index e0c90f1b..307a15ac 100644 --- a/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members.mdx +++ b/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-members.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/organizations/{organization_id}/members title: List Organization Members ---- \ No newline at end of file +--- + +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-tenants.mdx b/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-tenants.mdx index 075eb8f9..45cf285d 100644 --- a/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-tenants.mdx +++ b/docs/api-reference/v2/endpoints/organizations/get-fireworkv2organizations-tenants.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/organizations/{organization_id}/tenants title: List Organization Tenants ---- \ No newline at end of file +--- + +import PermissionReadOrganizationAdmin from '/snippets/permission-read-organization-admin.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-disable.mdx b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-disable.mdx index 053eb4d7..caa70ab7 100644 --- a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-disable.mdx +++ b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-disable.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/members/{user_id}/disable title: Disable Organization Member ---- \ No newline at end of file +--- + +import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-enable.mdx b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-enable.mdx index dd9c43ae..17b0046f 100644 --- a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-enable.mdx +++ b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-enable.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/members/{user_id}/enable title: Enable Organization Member ---- \ No newline at end of file +--- + +import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-permissions.mdx b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-permissions.mdx index 61f65637..f02deb4a 100644 --- a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-permissions.mdx +++ b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members-permissions.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/members/{user_id}/permissions title: Update Organization Member Permissions ---- \ No newline at end of file +--- + +import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members.mdx b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members.mdx index d99da570..6e68c39e 100644 --- a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members.mdx +++ b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-members.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/members title: Create Organization Member ---- \ No newline at end of file +--- + +import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-tenants.mdx b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-tenants.mdx index d16191a9..ca595be4 100644 --- a/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-tenants.mdx +++ b/docs/api-reference/v2/endpoints/organizations/post-fireworkv2organizations-tenants.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/organizations/{organization_id}/tenants title: Create Organization Tenant ---- \ No newline at end of file +--- + +import PermissionWriteOrganizationAdmin from '/snippets/permission-write-organization-admin.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/organizations/put-fireworkv2organizations-members.mdx b/docs/api-reference/v2/endpoints/organizations/put-fireworkv2organizations-members.mdx index ef5866f7..f610c5d2 100644 --- a/docs/api-reference/v2/endpoints/organizations/put-fireworkv2organizations-members.mdx +++ b/docs/api-reference/v2/endpoints/organizations/put-fireworkv2organizations-members.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi put /firework/v2/organizations/{organization_id}/members/{user_id} title: Update Organization Member ---- \ No newline at end of file +--- + +import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/reporting/delete-fireworkv2reportingreports.mdx b/docs/api-reference/v2/endpoints/reporting/delete-fireworkv2reportingreports.mdx index 9e9f450b..96f2e2de 100644 --- a/docs/api-reference/v2/endpoints/reporting/delete-fireworkv2reportingreports.mdx +++ b/docs/api-reference/v2/endpoints/reporting/delete-fireworkv2reportingreports.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi delete /firework/v2/reporting/reports/{report_id} title: Delete Report ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports-1.mdx b/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports-1.mdx index 03a9eff7..80d73846 100644 --- a/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports-1.mdx +++ b/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports-1.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/reporting/reports/{report_id} title: Retrieve Report ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports-download.mdx b/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports-download.mdx index f6070937..8fa9beab 100644 --- a/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports-download.mdx +++ b/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports-download.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/reporting/reports/{report_id}/download title: Download Report ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports.mdx b/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports.mdx index ce6f9181..b390b13c 100644 --- a/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports.mdx +++ b/docs/api-reference/v2/endpoints/reporting/get-fireworkv2reportingreports.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/reporting/reports title: List Reports ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/reporting/patch-fireworkv2reportingreports.mdx b/docs/api-reference/v2/endpoints/reporting/patch-fireworkv2reportingreports.mdx index 2dd23970..a27e97e4 100644 --- a/docs/api-reference/v2/endpoints/reporting/patch-fireworkv2reportingreports.mdx +++ b/docs/api-reference/v2/endpoints/reporting/patch-fireworkv2reportingreports.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi patch /firework/v2/reporting/reports/{report_id} title: Update Report ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/reporting/post-fireworkv2reportingreports-archive.mdx b/docs/api-reference/v2/endpoints/reporting/post-fireworkv2reportingreports-archive.mdx index 2cf77662..a8d9d828 100644 --- a/docs/api-reference/v2/endpoints/reporting/post-fireworkv2reportingreports-archive.mdx +++ b/docs/api-reference/v2/endpoints/reporting/post-fireworkv2reportingreports-archive.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/reporting/reports/{report_id}/archive title: Archive Report ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/reporting/post-fireworkv2reportingreports.mdx b/docs/api-reference/v2/endpoints/reporting/post-fireworkv2reportingreports.mdx index 44d3c608..bb58500a 100644 --- a/docs/api-reference/v2/endpoints/reporting/post-fireworkv2reportingreports.mdx +++ b/docs/api-reference/v2/endpoints/reporting/post-fireworkv2reportingreports.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/reporting/reports title: Create Report ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/search/get-fireworkv2search.mdx b/docs/api-reference/v2/endpoints/search/get-fireworkv2search.mdx index f10713ec..d51a9bf4 100644 --- a/docs/api-reference/v2/endpoints/search/get-fireworkv2search.mdx +++ b/docs/api-reference/v2/endpoints/search/get-fireworkv2search.mdx @@ -3,6 +3,10 @@ title: "Search" openapi: firework-v2-openapi get /firework/v2/search/ --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/events/global/_search ](/api-reference/v4/endpoints/global-search) diff --git a/docs/api-reference/v2/endpoints/search/post-fireworkv2search.mdx b/docs/api-reference/v2/endpoints/search/post-fireworkv2search.mdx index a836748c..2c812467 100644 --- a/docs/api-reference/v2/endpoints/search/post-fireworkv2search.mdx +++ b/docs/api-reference/v2/endpoints/search/post-fireworkv2search.mdx @@ -3,6 +3,10 @@ openapi: firework-v2-openapi post /firework/v2/search/ title: Search --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/events/global/_search ](/api-reference/v4/endpoints/global-search) diff --git a/docs/api-reference/v2/endpoints/tenants/delete-fireworkv2tenants-users.mdx b/docs/api-reference/v2/endpoints/tenants/delete-fireworkv2tenants-users.mdx index 5207fb5c..6377cbcd 100644 --- a/docs/api-reference/v2/endpoints/tenants/delete-fireworkv2tenants-users.mdx +++ b/docs/api-reference/v2/endpoints/tenants/delete-fireworkv2tenants-users.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi delete /firework/v2/tenants/{tenant_id}/users/{user_id} title: Delete Tenant Membership ---- \ No newline at end of file +--- + +import PermissionWriteTenantAdmin from '/snippets/permission-write-tenant-admin.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/tenants/get-fireworkv2tenants-users.mdx b/docs/api-reference/v2/endpoints/tenants/get-fireworkv2tenants-users.mdx index a0f58cd4..5d426e2e 100644 --- a/docs/api-reference/v2/endpoints/tenants/get-fireworkv2tenants-users.mdx +++ b/docs/api-reference/v2/endpoints/tenants/get-fireworkv2tenants-users.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/tenants/{tenant_id}/users title: List Tenant Memberships ---- \ No newline at end of file +--- + +import PermissionReadTenantAdmin from '/snippets/permission-read-tenant-admin.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/tenants/get-fireworkv2tenants.mdx b/docs/api-reference/v2/endpoints/tenants/get-fireworkv2tenants.mdx index 039a5eb6..581c96cb 100644 --- a/docs/api-reference/v2/endpoints/tenants/get-fireworkv2tenants.mdx +++ b/docs/api-reference/v2/endpoints/tenants/get-fireworkv2tenants.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi get /firework/v2/tenants/{tenant_id} title: Retrieve Tenant ---- \ No newline at end of file +--- + +import PermissionReadOrganization from '/snippets/permission-read-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/tenants/post-fireworkv2tenants-archive.mdx b/docs/api-reference/v2/endpoints/tenants/post-fireworkv2tenants-archive.mdx index 8d0ebae7..e177b729 100644 --- a/docs/api-reference/v2/endpoints/tenants/post-fireworkv2tenants-archive.mdx +++ b/docs/api-reference/v2/endpoints/tenants/post-fireworkv2tenants-archive.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/tenants/{tenant_id}/archive title: Archive Organization Tenant ---- \ No newline at end of file +--- + +import PermissionWriteOrganizationAdminReadOrganization from '/snippets/permission-write-organization-admin-read-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/tenants/post-fireworkv2tenants-users.mdx b/docs/api-reference/v2/endpoints/tenants/post-fireworkv2tenants-users.mdx index 9a55f05b..ed2a626e 100644 --- a/docs/api-reference/v2/endpoints/tenants/post-fireworkv2tenants-users.mdx +++ b/docs/api-reference/v2/endpoints/tenants/post-fireworkv2tenants-users.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi post /firework/v2/tenants/{tenant_id}/users title: Create Tenant Membership ---- \ No newline at end of file +--- + +import PermissionWriteTenantAdmin from '/snippets/permission-write-tenant-admin.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/tenants/put-fireworkv2tenants.mdx b/docs/api-reference/v2/endpoints/tenants/put-fireworkv2tenants.mdx index 948cd2e8..8f8e7b21 100644 --- a/docs/api-reference/v2/endpoints/tenants/put-fireworkv2tenants.mdx +++ b/docs/api-reference/v2/endpoints/tenants/put-fireworkv2tenants.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v2-openapi put /firework/v2/tenants/{tenant_id} title: Update Tenant ---- \ No newline at end of file +--- + +import PermissionWriteOrganization from '/snippets/permission-write-organization.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1.mdx b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1.mdx index 708d9471..a044f396 100644 --- a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1.mdx +++ b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1.mdx @@ -3,6 +3,10 @@ openapi: firework-v3-openapi get /firework/v3/identifiers/{identifier_id} title: Retrieve Identifier --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/identifiers/\{identifier_id\} ](/api-reference/v4/endpoints/retrieve-identifier) diff --git a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-feedcredentials.mdx b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-feedcredentials.mdx index 41b79b90..c57de85b 100644 --- a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-feedcredentials.mdx +++ b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-feedcredentials.mdx @@ -2,3 +2,7 @@ openapi: firework-v3-openapi get /firework/v3/identifiers/{identifier_id}/feed/credentials title: List Identifier Credentials --- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + diff --git a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers.mdx b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers.mdx index cc326484..83fb9a19 100644 --- a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers.mdx +++ b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers.mdx @@ -3,6 +3,10 @@ openapi: firework-v3-openapi get /firework/v3/identifiers/ title: List Identifiers --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/identifiers/ ](/api-reference/v4/endpoints/list-identifiers) diff --git a/docs/api-reference/v4/endpoints/assign-policy.mdx b/docs/api-reference/v4/endpoints/assign-policy.mdx index b1748d12..81972578 100644 --- a/docs/api-reference/v4/endpoints/assign-policy.mdx +++ b/docs/api-reference/v4/endpoints/assign-policy.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi post /firework/v4/matching-policies/{policy_uuid}/a title: Assign Policy (Beta) --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-action-for-identifier-recommendations.mdx b/docs/api-reference/v4/endpoints/create-action-for-identifier-recommendations.mdx index df818381..cc7dcae3 100644 --- a/docs/api-reference/v4/endpoints/create-action-for-identifier-recommendations.mdx +++ b/docs/api-reference/v4/endpoints/create-action-for-identifier-recommendations.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v4-openapi post /firework/v4/identifier-recommendations/actions title: Identifier Recommendation Actions (accept, reject) ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-identifier.mdx b/docs/api-reference/v4/endpoints/create-identifier.mdx index af57f746..ae64017c 100644 --- a/docs/api-reference/v4/endpoints/create-identifier.mdx +++ b/docs/api-reference/v4/endpoints/create-identifier.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v4-openapi post /firework/v4/identifiers/ title: Create Identifier ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-intel-request.mdx b/docs/api-reference/v4/endpoints/create-intel-request.mdx index d01cf3e0..68b2fda1 100644 --- a/docs/api-reference/v4/endpoints/create-intel-request.mdx +++ b/docs/api-reference/v4/endpoints/create-intel-request.mdx @@ -2,8 +2,10 @@ openapi: firework-v4-openapi post /firework/v4/threat_flow/intel/requests --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' import GatedAccessFeature from '/snippets/gated-access-feature.mdx'; + ## Guides diff --git a/docs/api-reference/v4/endpoints/create-matching-policy.mdx b/docs/api-reference/v4/endpoints/create-matching-policy.mdx index d1fc77d3..78a5276b 100644 --- a/docs/api-reference/v4/endpoints/create-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/create-matching-policy.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi post /firework/v4/matching-policies title: Create Matching Policy (Beta) --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/create-report-request.mdx b/docs/api-reference/v4/endpoints/create-report-request.mdx index c966a698..a3d05e86 100644 --- a/docs/api-reference/v4/endpoints/create-report-request.mdx +++ b/docs/api-reference/v4/endpoints/create-report-request.mdx @@ -2,6 +2,10 @@ openapi: firework-v4-openapi post /firework/v4/threat_flow/reports/requests --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/threat_flow/intel/requests ](/api-reference/v4/endpoints/create-intel-request) diff --git a/docs/api-reference/v4/endpoints/credentials-global-search.mdx b/docs/api-reference/v4/endpoints/credentials-global-search.mdx index b6563228..03d518cd 100644 --- a/docs/api-reference/v4/endpoints/credentials-global-search.mdx +++ b/docs/api-reference/v4/endpoints/credentials-global-search.mdx @@ -3,12 +3,14 @@ openapi: firework-v4-openapi post /firework/v4/credentials/global/_search title: Search Credentials --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import CrendentialEndpointsNote from '/snippets/credentials/astp-and-global-search-note.mdx'; import CrendentialSearchCommon from '/snippets/credentials/astp-and-global-search-common.mdx'; import CrendentialSearchQueryAndFilters from '/snippets/credentials/astp-and-global-search-query-and-filters.mdx'; import GlobalSearchApiQuotaNote from '/snippets/global-search-api-quota-note.mdx'; import CrendentialSearchDescription from '/snippets/credentials/astp-and-global-search-description.mdx'; + diff --git a/docs/api-reference/v4/endpoints/delete-identifier.mdx b/docs/api-reference/v4/endpoints/delete-identifier.mdx index ef3d3c2b..9d171eaa 100644 --- a/docs/api-reference/v4/endpoints/delete-identifier.mdx +++ b/docs/api-reference/v4/endpoints/delete-identifier.mdx @@ -2,6 +2,10 @@ openapi: firework-v4-openapi delete /firework/v4/identifiers/{identifier_id} --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + + The deletion process for an identifier and its related resources may require up to one hour to complete. \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/delete-matching-policy.mdx b/docs/api-reference/v4/endpoints/delete-matching-policy.mdx index 548b9d3c..440656aa 100644 --- a/docs/api-reference/v4/endpoints/delete-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/delete-matching-policy.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi delete /firework/v4/matching-policies/{policy_uuid} title: Delete Matching Policy (Beta) --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/expand-event-field.mdx b/docs/api-reference/v4/endpoints/expand-event-field.mdx index e8cc5277..513ca952 100644 --- a/docs/api-reference/v4/endpoints/expand-event-field.mdx +++ b/docs/api-reference/v4/endpoints/expand-event-field.mdx @@ -3,6 +3,10 @@ title: "Expand Event V2 Field (Beta)" openapi: firework-v4-openapi get /firework/v4/events/_expand --- +import PermissionReadAll from '/snippets/permission-read-all.mdx' + + + import EventExpandFieldExamples from '/snippets/event_expand_field_examples.mdx' import EventExpandFieldValidFields from '/snippets/event_expand_field_valid_fields.mdx' diff --git a/docs/api-reference/v4/endpoints/explain-identifier-event.mdx b/docs/api-reference/v4/endpoints/explain-identifier-event.mdx index 05afab65..f6d0324f 100644 --- a/docs/api-reference/v4/endpoints/explain-identifier-event.mdx +++ b/docs/api-reference/v4/endpoints/explain-identifier-event.mdx @@ -2,4 +2,8 @@ openapi: firework-v4-openapi get /firework/v4/events/identifiers/{identifier_id}/_explain --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + + Provides evidence as to how an event matches to an identifier, clarifying why an event is or is not found within a feed. \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/fetch-identifier-recommendations.mdx b/docs/api-reference/v4/endpoints/fetch-identifier-recommendations.mdx index 89c1ec99..63d53121 100644 --- a/docs/api-reference/v4/endpoints/fetch-identifier-recommendations.mdx +++ b/docs/api-reference/v4/endpoints/fetch-identifier-recommendations.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v4-openapi get /firework/v4/identifier-recommendations/ title: List Identifier Recommendations ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-event.mdx b/docs/api-reference/v4/endpoints/get-event.mdx index 264fa2ec..e94efb3d 100644 --- a/docs/api-reference/v4/endpoints/get-event.mdx +++ b/docs/api-reference/v4/endpoints/get-event.mdx @@ -3,6 +3,10 @@ title: "Retrieve Event V2 (Beta)" openapi: firework-v4-openapi get /firework/v4/events/ --- +import PermissionReadAll from '/snippets/permission-read-all.mdx' + + + import EventResponses from '/snippets/event_model_examples/events_overview.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' diff --git a/docs/api-reference/v4/endpoints/get-intel-request.mdx b/docs/api-reference/v4/endpoints/get-intel-request.mdx index 3807cf8f..1e1579ca 100644 --- a/docs/api-reference/v4/endpoints/get-intel-request.mdx +++ b/docs/api-reference/v4/endpoints/get-intel-request.mdx @@ -2,8 +2,10 @@ openapi: firework-v4-openapi get /firework/v4/threat_flow/intel/requests/{id} --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import GatedAccessFeature from '/snippets/gated-access-feature.mdx'; + ## Guides diff --git a/docs/api-reference/v4/endpoints/get-matching-policy.mdx b/docs/api-reference/v4/endpoints/get-matching-policy.mdx index 582e6f2a..60da5ae7 100644 --- a/docs/api-reference/v4/endpoints/get-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/get-matching-policy.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi get /firework/v4/matching-policies/{policy_uuid} title: Retrieve Matching Policy (Beta) --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/get-report-request.mdx b/docs/api-reference/v4/endpoints/get-report-request.mdx index ebe9deeb..32bae06b 100644 --- a/docs/api-reference/v4/endpoints/get-report-request.mdx +++ b/docs/api-reference/v4/endpoints/get-report-request.mdx @@ -2,6 +2,10 @@ openapi: firework-v4-openapi get /firework/v4/threat_flow/reports/requests/{request_info_id} --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + + **DEPRECATED:** This endpoint should be replaced by [/firework/v4/threat_flow/intel/requests/\{id\} ](/api-reference/v4/endpoints/get-intel-request) diff --git a/docs/api-reference/v4/endpoints/global-search.mdx b/docs/api-reference/v4/endpoints/global-search.mdx index 6251fd19..5bcb885c 100644 --- a/docs/api-reference/v4/endpoints/global-search.mdx +++ b/docs/api-reference/v4/endpoints/global-search.mdx @@ -4,9 +4,11 @@ api: "POST https://api.flare.io/firework/v4/events/global/_search" authMethod: "bearer" --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import GlobalSearchEvent from '/snippets/endpoint-global-search-event.mdx'; import GlobalSearchApiQuotaNote from '/snippets/global-search-api-quota-note.mdx'; + ## Guides diff --git a/docs/api-reference/v4/endpoints/identifier-feed.mdx b/docs/api-reference/v4/endpoints/identifier-feed.mdx index 21000a7c..d3e48262 100644 --- a/docs/api-reference/v4/endpoints/identifier-feed.mdx +++ b/docs/api-reference/v4/endpoints/identifier-feed.mdx @@ -4,8 +4,11 @@ api: "POST https://api.flare.io/firework/v4/events/identifiers/{identifier_id}/_ authMethod: "bearer" --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import EventSearchCommon from '/snippets/endpoint-event-search-common.mdx'; + + Returns a list of events matching an identifier. ## Guides diff --git a/docs/api-reference/v4/endpoints/identifier-group-feed.mdx b/docs/api-reference/v4/endpoints/identifier-group-feed.mdx index dc199328..8e14cb4f 100644 --- a/docs/api-reference/v4/endpoints/identifier-group-feed.mdx +++ b/docs/api-reference/v4/endpoints/identifier-group-feed.mdx @@ -4,8 +4,11 @@ api: "POST https://api.flare.io/firework/v4/events/identifier_groups/{identifier authMethod: "bearer" --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import EventSearchCommon from '/snippets/endpoint-event-search-common.mdx'; + + Returns a list of events matching the identifiers of an identifier group. ## Guides diff --git a/docs/api-reference/v4/endpoints/list-identifiers.mdx b/docs/api-reference/v4/endpoints/list-identifiers.mdx index 34367881..627a1952 100644 --- a/docs/api-reference/v4/endpoints/list-identifiers.mdx +++ b/docs/api-reference/v4/endpoints/list-identifiers.mdx @@ -1,3 +1,7 @@ --- openapi: firework-v4-openapi get /firework/v4/identifiers/ ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx b/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx index 965198d1..db04c00c 100644 --- a/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx +++ b/docs/api-reference/v4/endpoints/list-matching-policies-by-identifier-id.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi get /firework/v4/matching-policies/by_identifier_id title: List Matching Policies By Identifier Id (Beta) --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-matching-policies.mdx b/docs/api-reference/v4/endpoints/list-matching-policies.mdx index 92aebe93..98311506 100644 --- a/docs/api-reference/v4/endpoints/list-matching-policies.mdx +++ b/docs/api-reference/v4/endpoints/list-matching-policies.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi get /firework/v4/matching-policies title: List Matching Policies (Beta) --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/list-policy-assignments.mdx b/docs/api-reference/v4/endpoints/list-policy-assignments.mdx index 55d57c3e..c8a6e8b9 100644 --- a/docs/api-reference/v4/endpoints/list-policy-assignments.mdx +++ b/docs/api-reference/v4/endpoints/list-policy-assignments.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi get /firework/v4/matching-policies/{policy_uuid}/as title: List Policy Assignments (Beta) --- +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/retrieve-identifier.mdx b/docs/api-reference/v4/endpoints/retrieve-identifier.mdx index 80e49270..51b19e69 100644 --- a/docs/api-reference/v4/endpoints/retrieve-identifier.mdx +++ b/docs/api-reference/v4/endpoints/retrieve-identifier.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v4-openapi get /firework/v4/identifiers/{identifier_id} title: Retrieve Identifier ---- \ No newline at end of file +--- + +import PermissionReadTenant from '/snippets/permission-read-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/unassign-policy.mdx b/docs/api-reference/v4/endpoints/unassign-policy.mdx index 80b5f728..8203a6cd 100644 --- a/docs/api-reference/v4/endpoints/unassign-policy.mdx +++ b/docs/api-reference/v4/endpoints/unassign-policy.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi delete /firework/v4/matching-policies/{policy_uuid} title: Unassign Policy (Beta) --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-identifier.mdx b/docs/api-reference/v4/endpoints/update-identifier.mdx index 3861aec7..2c36051c 100644 --- a/docs/api-reference/v4/endpoints/update-identifier.mdx +++ b/docs/api-reference/v4/endpoints/update-identifier.mdx @@ -1,4 +1,8 @@ --- openapi: firework-v4-openapi put /firework/v4/identifiers/{identifier_id} title: Update Identifier ---- \ No newline at end of file +--- + +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' + + \ No newline at end of file diff --git a/docs/api-reference/v4/endpoints/update-matching-policy.mdx b/docs/api-reference/v4/endpoints/update-matching-policy.mdx index e9a026a1..23e28f55 100644 --- a/docs/api-reference/v4/endpoints/update-matching-policy.mdx +++ b/docs/api-reference/v4/endpoints/update-matching-policy.mdx @@ -3,6 +3,8 @@ openapi: firework-v4-openapi put /firework/v4/matching-policies/{policy_uuid} title: Update Matching Policy (Beta) --- +import PermissionWriteTenant from '/snippets/permission-write-tenant.mdx' import BetaEndpoint from '/snippets/beta-endpoint.mdx' + \ No newline at end of file diff --git a/docs/snippets/permission-read-all.mdx b/docs/snippets/permission-read-all.mdx new file mode 100644 index 00000000..c8c6a002 --- /dev/null +++ b/docs/snippets/permission-read-all.mdx @@ -0,0 +1 @@ + Required API key permission: **Read All** diff --git a/docs/snippets/permission-read-organization-admin.mdx b/docs/snippets/permission-read-organization-admin.mdx new file mode 100644 index 00000000..07807087 --- /dev/null +++ b/docs/snippets/permission-read-organization-admin.mdx @@ -0,0 +1 @@ + Required API key permission: **Read Organization Admin** diff --git a/docs/snippets/permission-read-organization.mdx b/docs/snippets/permission-read-organization.mdx new file mode 100644 index 00000000..a3ddd100 --- /dev/null +++ b/docs/snippets/permission-read-organization.mdx @@ -0,0 +1 @@ + Required API key permission: **Read Organization** diff --git a/docs/snippets/permission-read-tenant-admin.mdx b/docs/snippets/permission-read-tenant-admin.mdx new file mode 100644 index 00000000..e6d566fa --- /dev/null +++ b/docs/snippets/permission-read-tenant-admin.mdx @@ -0,0 +1 @@ + Required API key permission: **Read Tenant Admin** diff --git a/docs/snippets/permission-read-tenant.mdx b/docs/snippets/permission-read-tenant.mdx new file mode 100644 index 00000000..39dc58c2 --- /dev/null +++ b/docs/snippets/permission-read-tenant.mdx @@ -0,0 +1 @@ + Required API key permission: **Read Tenant** diff --git a/docs/snippets/permission-write-organization-admin-read-organization.mdx b/docs/snippets/permission-write-organization-admin-read-organization.mdx new file mode 100644 index 00000000..95b5512a --- /dev/null +++ b/docs/snippets/permission-write-organization-admin-read-organization.mdx @@ -0,0 +1 @@ + Required API key permissions: **Write Organization Admin** and **Read Organization** diff --git a/docs/snippets/permission-write-organization-admin.mdx b/docs/snippets/permission-write-organization-admin.mdx new file mode 100644 index 00000000..b5579c36 --- /dev/null +++ b/docs/snippets/permission-write-organization-admin.mdx @@ -0,0 +1 @@ + Required API key permission: **Write Organization Admin** diff --git a/docs/snippets/permission-write-organization.mdx b/docs/snippets/permission-write-organization.mdx new file mode 100644 index 00000000..7101fc49 --- /dev/null +++ b/docs/snippets/permission-write-organization.mdx @@ -0,0 +1 @@ + Required API key permission: **Write Organization** diff --git a/docs/snippets/permission-write-tenant-admin.mdx b/docs/snippets/permission-write-tenant-admin.mdx new file mode 100644 index 00000000..1f11d099 --- /dev/null +++ b/docs/snippets/permission-write-tenant-admin.mdx @@ -0,0 +1 @@ + Required API key permission: **Write Tenant Admin** diff --git a/docs/snippets/permission-write-tenant.mdx b/docs/snippets/permission-write-tenant.mdx new file mode 100644 index 00000000..5d198e67 --- /dev/null +++ b/docs/snippets/permission-write-tenant.mdx @@ -0,0 +1 @@ + Required API key permission: **Write Tenant**