Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.opal.dev/llms.txt

Use this file to discover all available pages before exploring further.

Opal’s admin auditing MCP provides a set of tools that enables admins to use AI agents to view Opal events and syncs to investigate access and audit changes. Use cases include:
  • Investigate historical access patterns and anomalous access
  • Audit changes in organizational structure or role assignments
  • Review sync errors and propagation status
  • Monitor access requests and approvals
  • Track user access reviews and compliance activities

Installation

First, create an API Token in your Opal environment. Then, select a method and follow the instructions below.
If you run self-hosted, remember to replace https://app.opal.dev to your own domain.
To install, run the following command in your shell:
claude mcp add --transport http opal-admin-auditing https://app.opal.dev/mcp/admin-auditing --header "Authorization: Bearer ${OPAL_API_TOKEN}" 
Then authenticate with Opal.
claude /mcp
To learn more, see Claude Code documentation.

Available Tools

ToolDescription
opal_get_resourceRetrieves a resource.
opal_get_resourcesReturns a list of resources for your organization.
opal_get_sync_errorsReturns a list of recent sync errors that have occurred since the last successful sync.
opal_get_resource_visibilityGets the visibility of this resource.
opal_get_uarRetrieves a specific UAR.
opal_get_ua_rsReturns a list of UAR objects.
opal_get_on_call_schedulesReturns a list of OnCallSchedule objects.
opal_get_message_channelsReturns a list of MessageChannel objects.
opal_get_tagsReturns a list of tags created by your organization.
opal_sessionsReturns a list of Session objects.
opal_get_user_tagsReturns all tags applied to the user.
opal_get_usersReturns a list of users for your organization.
opal_get_resource_scoped_role_permissionsReturns all the scoped role permissions that apply to the given resource. Only OPAL_SCOPED_ROLE resource type supports this field.
opal_get_resource_tagsReturns all tags applied to the resource.
opal_get_resource_nhisGets the list of non-human identities with access to this resource.
opal_get_resource_usersGets the list of users for this resource.
opal_get_nhisReturns a list of non-human identities for your organization.
opal_get_resource_reviewer_stagesGets the list of reviewer stages for a resource.
opal_get_resource_reviewersGets the list of owner IDs of the reviewers for a resource.
opal_get_resource_message_channelsGets the list of audit message channels attached to a resource.
opal_get_requestsReturns a list of requests for your organization that is visible by the admin.
opal_get_requestReturns a request by ID.
opal_get_owner_usersGets the list of users for this owner, in escalation priority order if applicable.
opal_get_ownersReturns a list of Owner objects.
opal_get_idp_group_mappingsReturns the configured set of available IdpGroupMapping objects for an Okta app.
opal_get_group_usersGets the list of users for this group.
opal_get_group_visibilityGets the visibility of this group.
opal_eventsReturns a list of Event objects.
opal_get_groupsReturns a list of groups for your organization.
opal_get_group_containing_groupsGets the list of groups that the group gives access to.
opal_get_group_on_call_schedulesGets the list of on call schedules attached to a group.
opal_get_group_resourcesGets the list of resources that the group gives access to.
opal_get_group_message_channelsGets the list of audit and reviewer message channels attached to a group.
opal_get_bundle_groupsReturns a list of Group objects in a given bundle.
opal_get_bundle_visibilityGets the visibility of the bundle.
opal_get_bundle_resourcesReturns a list of Resource objects in a given bundle.
opal_get_appsReturns a list of App objects.
opal_get_configuration_templatesReturns a list of ConfigurationTemplate objects.
opal_get_bundlesReturns a list of Bundle objects.
Last modified on May 14, 2026