Skip to content

DOCS-1767 - Update Search Job API required capabilities and Manage Access Keys - #6934

Open
JV0812 wants to merge 6 commits into
mainfrom
DOCS-1767-role-capabilities-update
Open

DOCS-1767 - Update Search Job API required capabilities and Manage Access Keys#6934
JV0812 wants to merge 6 commits into
mainfrom
DOCS-1767-role-capabilities-update

Conversation

@JV0812

@JV0812 JV0812 commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

This pull request updates the required role capabilities for the Search Job API and clarifies the Manage Access Keys capability, per DOCS-1767:

  • docs/api/search-job.md — remove the Data Management capability requirement (Download Search Results, View Collectors); keep only Security (Manage Access Keys).
  • docs/manage/users-roles/roles/role-capabilities.md — clarify the Manage Access Keys description: it creates access keys, and if the key uses a customized scope, Run Log Search must be added to the scope.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1767

@JV0812 JV0812 self-assigned this Jul 21, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Jul 21, 2026
…keys

Remove the Data Management capability requirement (Download Search Results,
View Collectors) from the Search Job API page, keeping only Security
(Manage Access Keys). Clarify the Manage Access Keys description in the
Role Capabilities doc (create access keys; add Run Log Search to a
customized scope).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@JV0812
JV0812 force-pushed the DOCS-1767-role-capabilities-update branch from c590a35 to d44098b Compare July 21, 2026 10:17
@JV0812 JV0812 changed the title DOCS-1767 - Enhance the Role Capabilities doc DOCS-1767 - Update Search Job API required capabilities and Manage Access Keys Jul 21, 2026
JV0812 and others added 3 commits July 21, 2026 15:53
Only one capability remains, so change the heading to "Required role capability".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The customized-scope requirement is API-specific, so move it from the
Manage Access Keys capability description to a note on the Search Job API
page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Comment thread docs/manage/users-roles/roles/role-capabilities.md
@kimsauce

Copy link
Copy Markdown
Collaborator

Suggestion: revert the heading back to plural — ## Required role capabilities instead of singular.

Every API doc in docs/api/ uses this exact heading verbatim (30+ files), regardless of how many capabilities are actually listed under it. It's a standardized section heading for the API doc template, not a description of item count — same convention as always writing ## Prerequisites even when there's only one. Keeping it plural here preserves consistency across the API docs section.

@kimsauce kimsauce left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving with the suggestion above to revert the heading back to plural (Required role capabilities) for consistency with other API docs.

Comment thread docs/api/search-job.md Outdated
Fix cell spacing in the Manage Access Keys row and revert the
Required role capabilities heading to plural for consistency with
other API docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants