> ## Documentation Index
> Fetch the complete documentation index at: https://phidatainc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom Scope Mappings

> Map custom scopes to AgentOS routes instead of the defaults.

Define custom scope mappings for your AgentOS endpoints to create your own permission structure.

<Note>
  Custom mappings merge with the defaults: routes you list use your scopes, and unlisted routes keep their default requirements. On agent, team, and workflow paths that include a resource ID (like `POST /agents/{id}/runs`), the middleware rewrites each required scope into the native namespace, keeping only the action. Mapping `app:run` there means the token needs `agents:run` for that agent; the custom namespace is ignored. The route handlers check the same native scopes. Custom scopes apply as written on all other paths, such as sessions, memories, and config. Tokens with the configured `admin_scope` bypass every check.
</Note>

<Steps>
  <Step title="Create a Python file">
    ```python custom_scope_mappings.py theme={null}
    import os
    from datetime import UTC, datetime, timedelta

    import jwt
    from agno.agent import Agent
    from agno.db.postgres import PostgresDb
    from agno.models.openai import OpenAIResponses
    from agno.os import AgentOS
    from agno.os.middleware import JWTMiddleware
    from agno.tools.hackernews import HackerNewsTools

    JWT_SECRET = os.getenv("JWT_VERIFICATION_KEY", "your-secret-key-at-least-256-bits-long")

    db = PostgresDb(db_url="postgresql+psycopg://ai:ai@localhost:5532/ai")

    research_agent = Agent(
        id="research-agent",
        name="Research Agent",
        model=OpenAIResponses(id="gpt-5.2"),
        db=db,
        tools=[HackerNewsTools()],
        markdown=True,
    )

    # Define custom scope mappings
    # Format: "METHOD /path": ["scope1", "scope2"]
    custom_scopes = {
        # On paths with an agent ID, the middleware rewrites each scope
        # into the agents namespace: "app:read" requires agents:read
        # and "app:run" requires agents:run.
        "GET /agents": ["app:read"],
        "GET /agents/*": ["app:read"],
        "POST /agents/*/runs": ["app:run"],

        # Session endpoints - only admins can list
        "GET /sessions": ["app:admin"],
        "GET /sessions/*": ["app:read", "sessions:read"],  # Multiple scopes: the token needs both

        # Memory endpoints with custom scopes
        "GET /memories": ["memory:admin"],
        "POST /memories": ["memory:write"],

        # Config endpoint - system admins only
        "GET /config": ["app:admin"],
    }

    # Create AgentOS without built-in authorization
    agent_os = AgentOS(
        id="my-agent-os",
        description="Custom Scope Mappings AgentOS",
        agents=[research_agent],
    )

    app = agent_os.get_app()

    # Add JWT middleware with custom scope mappings
    app.add_middleware(
        JWTMiddleware,
        verification_keys=[JWT_SECRET],
        algorithm="HS256",
        scope_mappings=custom_scopes,  # Custom scopes enable RBAC automatically
        admin_scope="app:superadmin",  # Custom admin scope
    )


    if __name__ == "__main__":
        # Basic user - can only read
        # agents:read is required on agent ID paths
        basic_user_token = jwt.encode(
            {
                "sub": "user_123",
                "scopes": ["app:read", "agents:read"],
                "exp": datetime.now(UTC) + timedelta(hours=24),
            },
            JWT_SECRET,
            algorithm="HS256",
        )

        # Power user - can read and run agents
        # agents:read and agents:run are required on agent ID paths
        power_user_token = jwt.encode(
            {
                "sub": "user_456",
                "scopes": ["app:read", "app:run", "agents:read", "agents:run"],
                "exp": datetime.now(UTC) + timedelta(hours=24),
            },
            JWT_SECRET,
            algorithm="HS256",
        )

        # Admin user - has admin scope
        admin_token = jwt.encode(
            {
                "sub": "admin_789",
                "scopes": ["app:admin", "app:read", "app:run", "agents:read", "agents:run"],
                "exp": datetime.now(UTC) + timedelta(hours=24),
            },
            JWT_SECRET,
            algorithm="HS256",
        )

        # Super admin - bypasses all checks
        superadmin_token = jwt.encode(
            {
                "sub": "superadmin",
                "scopes": ["app:superadmin"],
                "exp": datetime.now(UTC) + timedelta(hours=24),
            },
            JWT_SECRET,
            algorithm="HS256",
        )

        print("Basic User (app:read + agents:read):")
        print(basic_user_token)
        print("\nPower User (custom scopes + agents:read, agents:run):")
        print(power_user_token)
        print("\nAdmin (app:admin + all permissions):")
        print(admin_token)
        print("\nSuper Admin (app:superadmin - bypasses all):")
        print(superadmin_token)

        agent_os.serve(app="custom_scope_mappings:app", port=7777, reload=True)
    ```
  </Step>

  <Snippet file="create-venv-step.mdx" />

  <Step title="Install dependencies">
    ```bash theme={null}
    uv pip install -U agno openai pyjwt "fastapi[standard]" uvicorn sqlalchemy pgvector psycopg
    ```
  </Step>

  <Step title="Export your OpenAI API key">
    <CodeGroup>
      ```bash Mac/Linux theme={null}
      export OPENAI_API_KEY="your_openai_api_key_here"
      ```

      ```bash Windows theme={null}
      $Env:OPENAI_API_KEY="your_openai_api_key_here"
      ```
    </CodeGroup>
  </Step>

  <Step title="Setup PostgreSQL Database">
    ```bash theme={null}
    docker run -d \
      --name agno-postgres \
      -e POSTGRES_DB=ai \
      -e POSTGRES_USER=ai \
      -e POSTGRES_PASSWORD=ai \
      -p 5532:5432 \
      pgvector/pgvector:pg17
    ```
  </Step>

  <Step title="Run the AgentOS">
    ```bash theme={null}
    python custom_scope_mappings.py
    ```
  </Step>

  <Step title="Test Custom Scopes">
    ```bash theme={null}
    # Basic user can read agents
    export BASIC_TOKEN="<basic_user_token>"
    curl -H "Authorization: Bearer $BASIC_TOKEN" http://localhost:7777/agents

    # Basic user cannot run agents (missing agents:run)
    curl -X POST -H "Authorization: Bearer $BASIC_TOKEN" \
      -F "message=test" http://localhost:7777/agents/research-agent/runs

    # Power user can run agents
    export POWER_TOKEN="<power_user_token>"
    curl -X POST -H "Authorization: Bearer $POWER_TOKEN" \
      -F "message=Search for news" \
      http://localhost:7777/agents/research-agent/runs

    # Only admin can view sessions
    export ADMIN_TOKEN="<admin_token>"
    curl -H "Authorization: Bearer $ADMIN_TOKEN" http://localhost:7777/sessions
    ```
  </Step>
</Steps>