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 provisioning MCP provides a set of tools that enables admins to use AI agents to manage user access in Opal. They can view user permissions and add or remove access to resources and groups. Use cases include:
  • Generate an overview of a user’s access across resources and groups
  • Add or remove users from resources and groups
  • Update user access levels and durations
  • Manage group memberships

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-user-provisioning https://app.opal.dev/mcp/admin-user-provisioning --header "Authorization: Bearer ${OPAL_API_TOKEN}" 
Then authenticate with Opal.
claude /mcp
To learn more, see Claude Code documentation.

Available Tools

ToolDescription
opal_userRetrieves detailed user information from Opal. This endpoint is designed to fetch user details by either user ID (UUID) or email address. The endpoint follows a strict precedence rule where user_id takes priority.
opal_get_user_tagsReturns all tags applied to the user.
opal_get_usersReturns a list of users for your organization.
opal_update_resource_userUpdates a user’s access level or duration on this resource.
opal_delete_resource_userRemoves a user’s direct access from this resource.
opal_set_owner_usersSets the list of users for this owner. If escalation is enabled, the order of this list is the escalation priority order of the users. If the owner has a source group, adding or removing users from this list won’t be possible.
opal_get_owner_usersGets the list of users for this owner, in escalation priority order if applicable.
opal_add_group_userAdds a user to this group.
opal_update_group_userUpdates a user’s access level or duration in this group.
opal_delete_group_userRemoves a user’s access from this group.
opal_get_group_usersGets the list of users for this group.
Last modified on May 14, 2026