{"id":7782,"date":"2026-05-17T06:20:58","date_gmt":"2026-05-17T03:20:58","guid":{"rendered":"http:\/\/mohamed"},"modified":"2026-05-18T15:00:00","modified_gmt":"2026-05-18T12:00:00","slug":"api-key-scopes-explained","status":"publish","type":"docs","link":"https:\/\/docs.tawarly.com\/ar\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/api-key-scopes-explained\/","title":{"rendered":"API Key Scopes Explained"},"content":{"rendered":"

Overview<\/h2>\n

Scopes define what an API key is allowed to access. Use the smallest scope set possible.<\/p>\n

Suggested scope model<\/h2>\n\n\n\n\n\n\n\n\n\n\n
Scope<\/th>\nPurpose<\/th>\n<\/tr>\n<\/thead>\n
read_activity<\/code><\/td>\nRead Activity Log events.<\/td>\n<\/tr>\n
read_auth<\/code><\/td>\nRead Auth Log events.<\/td>\n<\/tr>\n
read_views<\/code><\/td>\nRead View Log events.<\/td>\n<\/tr>\n
read_reports<\/code><\/td>\nRead summary reports.<\/td>\n<\/tr>\n
manage_notes<\/code><\/td>\nAdd notes to audit records if supported.<\/td>\n<\/tr>\n
manage_tags<\/code><\/td>\nAdd or remove tags if supported.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Use the actual scope names from your plugin implementation if they differ.<\/p>\n

Best practice<\/h2>\n
    \n
  • Create one key per integration.<\/li>\n
  • Give read-only integrations read scopes only.<\/li>\n
  • Do not give purge\/archive scopes to external systems unless absolutely required.<\/li>\n
  • Review keys every month or after staff\/vendor changes.<\/li>\n<\/ul>\n

    Example<\/h2>\n

    A dashboard that only reads failed logins should not receive activity, GDPR, purge, or settings scopes.<\/p>\n

    Screenshot<\/h2>\n
    \n Screenshot required
    \n Capture from: Rise Audit Pro \u2192 API Keys\n<\/div>","protected":false},"excerpt":{"rendered":"

    Overview Scopes define what an API key is allowed to access. Use the smallest scope set possible. Suggested scope model Scope Purpose read_activity Read Activity Log events. read_auth Read Auth Log events. read_views Read View Log events. read_reports Read summary reports. manage_notes Add notes to audit records if supported. manage_tags Add or remove tags if […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":8292,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"doc_badge":[],"class_list":["post-7782","docs","type-docs","status-publish","hentry"],"acf":[],"yoast_head":"\nAPI Key Scopes Explained - Tawarly Ltd<\/title>\n<meta name=\"robots\" content=\"noindex, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta property=\"og:locale\" content=\"ar_AR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API Key Scopes Explained - Tawarly Ltd\" \/>\n<meta property=\"og:description\" content=\"Overview Scopes define what an API key is allowed to access. Use the smallest scope set possible. Suggested scope model Scope Purpose read_activity Read Activity Log events. read_auth Read Auth Log events. read_views Read View Log events. read_reports Read summary reports. manage_notes Add notes to audit records if supported. manage_tags Add or remove tags if […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.tawarly.com\/ar\/docs\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/api-key-scopes-explained\/\" \/>\n<meta property=\"og:site_name\" content=\"Tawarly Ltd\" \/>\n<meta property=\"article:modified_time\" content=\"2026-05-18T12:00:00+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"\u0648\u0642\u062a \u0627\u0644\u0642\u0631\u0627\u0621\u0629 \u0627\u0644\u0645\u064f\u0642\u062f\u0651\u0631\" \/>\n\t<meta name=\"twitter:data1\" content=\"\u062f\u0642\u064a\u0642\u0629 \u0648\u0627\u062d\u062f\u0629\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/docs\\\/rise-audit-pro-documentation\\\/api-webhooks-and-audit-record-management\\\/api-key-scopes-explained\\\/\",\"url\":\"https:\\\/\\\/docs.tawarly.com\\\/docs\\\/rise-audit-pro-documentation\\\/api-webhooks-and-audit-record-management\\\/api-key-scopes-explained\\\/\",\"name\":\"API Key Scopes Explained - Tawarly Ltd\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/#website\"},\"datePublished\":\"2026-05-17T03:20:58+00:00\",\"dateModified\":\"2026-05-18T12:00:00+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/docs\\\/rise-audit-pro-documentation\\\/api-webhooks-and-audit-record-management\\\/api-key-scopes-explained\\\/#breadcrumb\"},\"inLanguage\":\"ar\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/docs.tawarly.com\\\/docs\\\/rise-audit-pro-documentation\\\/api-webhooks-and-audit-record-management\\\/api-key-scopes-explained\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/docs\\\/rise-audit-pro-documentation\\\/api-webhooks-and-audit-record-management\\\/api-key-scopes-explained\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/docs.tawarly.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Rise Audit Pro Documentation\",\"item\":\"https:\\\/\\\/docs.tawarly.com\\\/docs\\\/rise-audit-pro-documentation\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"API, Webhooks and Audit Record Management\",\"item\":\"https:\\\/\\\/docs.tawarly.com\\\/docs\\\/rise-audit-pro-documentation\\\/api-webhooks-and-audit-record-management\\\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"API Key Scopes Explained\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/#website\",\"url\":\"https:\\\/\\\/docs.tawarly.com\\\/\",\"name\":\"Tawarly Ltd\",\"description\":\"inspired by the future\",\"publisher\":{\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/docs.tawarly.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"ar\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/#organization\",\"name\":\"Tawarly Ltd\",\"url\":\"https:\\\/\\\/docs.tawarly.com\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"ar\",\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/docs.tawarly.com\\\/wp-content\\\/uploads\\\/2021\\\/03\\\/logo-full.png\",\"contentUrl\":\"https:\\\/\\\/docs.tawarly.com\\\/wp-content\\\/uploads\\\/2021\\\/03\\\/logo-full.png\",\"width\":300,\"height\":81,\"caption\":\"Tawarly Ltd\"},\"image\":{\"@id\":\"https:\\\/\\\/docs.tawarly.com\\\/#\\\/schema\\\/logo\\\/image\\\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API Key Scopes Explained - Tawarly Ltd","robots":{"index":"noindex","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"og_locale":"ar_AR","og_type":"article","og_title":"API Key Scopes Explained - Tawarly Ltd","og_description":"Overview Scopes define what an API key is allowed to access. Use the smallest scope set possible. Suggested scope model Scope Purpose read_activity Read Activity Log events. read_auth Read Auth Log events. read_views Read View Log events. read_reports Read summary reports. manage_notes Add notes to audit records if supported. manage_tags Add or remove tags if […]","og_url":"https:\/\/docs.tawarly.com\/ar\/docs\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/api-key-scopes-explained\/","og_site_name":"Tawarly Ltd","article_modified_time":"2026-05-18T12:00:00+00:00","twitter_card":"summary_large_image","twitter_misc":{"\u0648\u0642\u062a \u0627\u0644\u0642\u0631\u0627\u0621\u0629 \u0627\u0644\u0645\u064f\u0642\u062f\u0651\u0631":"\u062f\u0642\u064a\u0642\u0629 \u0648\u0627\u062d\u062f\u0629"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.tawarly.com\/docs\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/api-key-scopes-explained\/","url":"https:\/\/docs.tawarly.com\/docs\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/api-key-scopes-explained\/","name":"API Key Scopes Explained - Tawarly Ltd","isPartOf":{"@id":"https:\/\/docs.tawarly.com\/#website"},"datePublished":"2026-05-17T03:20:58+00:00","dateModified":"2026-05-18T12:00:00+00:00","breadcrumb":{"@id":"https:\/\/docs.tawarly.com\/docs\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/api-key-scopes-explained\/#breadcrumb"},"inLanguage":"ar","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.tawarly.com\/docs\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/api-key-scopes-explained\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.tawarly.com\/docs\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/api-key-scopes-explained\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.tawarly.com\/"},{"@type":"ListItem","position":2,"name":"Rise Audit Pro Documentation","item":"https:\/\/docs.tawarly.com\/docs\/rise-audit-pro-documentation\/"},{"@type":"ListItem","position":3,"name":"API, Webhooks and Audit Record Management","item":"https:\/\/docs.tawarly.com\/docs\/rise-audit-pro-documentation\/api-webhooks-and-audit-record-management\/"},{"@type":"ListItem","position":4,"name":"API Key Scopes Explained"}]},{"@type":"WebSite","@id":"https:\/\/docs.tawarly.com\/#website","url":"https:\/\/docs.tawarly.com\/","name":"Tawarly Ltd","description":"inspired by the future","publisher":{"@id":"https:\/\/docs.tawarly.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.tawarly.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"ar"},{"@type":"Organization","@id":"https:\/\/docs.tawarly.com\/#organization","name":"Tawarly Ltd","url":"https:\/\/docs.tawarly.com\/","logo":{"@type":"ImageObject","inLanguage":"ar","@id":"https:\/\/docs.tawarly.com\/#\/schema\/logo\/image\/","url":"https:\/\/docs.tawarly.com\/wp-content\/uploads\/2021\/03\/logo-full.png","contentUrl":"https:\/\/docs.tawarly.com\/wp-content\/uploads\/2021\/03\/logo-full.png","width":300,"height":81,"caption":"Tawarly Ltd"},"image":{"@id":"https:\/\/docs.tawarly.com\/#\/schema\/logo\/image\/"}}]}},"author_avatar":"https:\/\/secure.gravatar.com\/avatar\/08585f715052565fc38d5f512ef098033f30c14d4c14becefded93819a77543c?s=96&d=mm&r=g","author_name":"mohamed","_links":{"self":[{"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/docs\/7782","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/comments?post=7782"}],"version-history":[{"count":1,"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/docs\/7782\/revisions"}],"predecessor-version":[{"id":8252,"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/docs\/7782\/revisions\/8252"}],"up":[{"embeddable":true,"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/docs\/8292"}],"wp:attachment":[{"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/media?parent=7782"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/doc_tag?post=7782"},{"taxonomy":"doc_badge","embeddable":true,"href":"https:\/\/docs.tawarly.com\/ar\/wp-json\/wp\/v2\/doc_badge?post=7782"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}