> For the complete documentation index, see [llms.txt](https://documentation.opencrvs.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.opencrvs.org/v2.0/technical/guides/configuration/users/roles-and-scopes.md).
# Roles and scopes
Each user has an assigned role. A role determines which actions the user can take. Scopes are the mechanism that grants users access to perform role-specific actions. Learn [more about scopes here](/v2.0/technical/guides/configuration/users/how-to-configure-scopes.md)
At a high level, a scope has two properties:
* **Type** — which action the user can take with the scope (e.g. `record.create`, `record.read`, `user.create`).
* **Options** — the limitations under which the action can be performed (e.g. a user can only search birth events that took place in their administrativeArea: `{ type: 'record.search', options: { event: ['birth'], placeOfEvent: 'administrativeArea' } }`).
A user is always assigned to a location. The location's position in the administrative hierarchy determines the jurisdiction the scope grants. Learn [how to configure place of event](/v2.0/technical/guides/configuration/administrative-hierarchy/how-to-configure-place-of-event.md).\
\
**Example 1: Jurisdiction based on administrative area** `{ placeOfEvent: 'administrativeArea' }`
The dotted lines illustrate jurisdiction. An `administrativeArea` scope covers the administrative area itself, all locations within it, and all descending areas.
\
**Example 2: Jurisdiction based on location** — `{ placeOfEvent: 'location' }`
A location scope limits the user to a single location. For example, users in District Hospital A with scope `{ type: 'record.read', placeOfEvent: 'location' }` will only see events from District Hospital A. Events from District Hospital B and C would only be visible with the `{ placeOfEvent: 'administrativeArea' }` option.
**Example 3: Different roles directly under country**
In cases such as an embassy, it is safer to create a separate role with more limited scopes. If the same roles are reused, locations outside the country will inherit the same jurisdiction as HQ Office by default.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://documentation.opencrvs.org/v2.0/technical/guides/configuration/users/roles-and-scopes.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
