> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/types/role.md).

# Role

Role Type

Represents a role in the system's role-based access control (RBAC) model. Roles define sets of permissions through access policies and can be assigned to users and groups.

## Fields

| Field         | Type      | Description                               |
| ------------- | --------- | ----------------------------------------- |
| `id`          | `ID!`     | Unique identifier of the role             |
| `createdAt`   | `Time!`   | Creation timestamp                        |
| `createdBy`   | `UUID!`   | User identifier who created the role      |
| `updatedAt`   | `Time`    | Last update timestamp                     |
| `updatedBy`   | `UUID`    | User identifier who last updated the role |
| `deletedAt`   | `Time`    | Deletion timestamp                        |
| `deletedBy`   | `UUID`    | User identifier who deleted the role      |
| `tenantID`    | `UUID!`   | Tenant identifier                         |
| `name`        | `String!` | Name of the role                          |
| `description` | `String`  | Description of the role                   |

## Connection Fields

The `users`, `groups`, and `policies` fields return Connection objects that support pagination, filtering, and ordering.

### users Connection

```graphql
users(
  after: Cursor
  first: Int
  before: Cursor
  last: Int
  orderBy: UserOrder
  where: UserWhereInput
): UserConnection!
```

### groups Connection

```graphql
groups(
  after: Cursor
  first: Int
  before: Cursor
  last: Int
  orderBy: GroupOrder
  where: GroupWhereInput
): GroupConnection!
```

### policies Connection

```graphql
policies(
  after: Cursor
  first: Int
  before: Cursor
  last: Int
  orderBy: AccessPolicyOrder
  where: AccessPolicyWhereInput
): AccessPolicyConnection!
```

| Argument  | Type          | Description                                     |
| --------- | ------------- | ----------------------------------------------- |
| `after`   | `Cursor`      | Returns elements after this cursor              |
| `first`   | `Int`         | Returns the first n elements                    |
| `before`  | `Cursor`      | Returns elements before this cursor             |
| `last`    | `Int`         | Returns the last n elements                     |
| `orderBy` | `*Order`      | Ordering options (specific to each connection)  |
| `where`   | `*WhereInput` | Filtering options (specific to each connection) |

## Interfaces

* `Node`

## Usage Example

```graphql
query {
  roles(first: 10) {
    edges {
      node {
        id
        name
        description
        users(first: 50) {
          edges {
            node {
              id
              username
              email
            }
          }
          totalCount
        }
        groups(first: 20) {
          edges {
            node {
              id
              name
            }
          }
          totalCount
        }
        policies(first: 50) {
          edges {
            node {
              id
              resource
              action
              effect
            }
          }
          pageInfo {
            hasNextPage
            endCursor
          }
          totalCount
        }
        createdAt
        updatedAt
      }
    }
  }
}
```

### Query with Filtering on Policies

```graphql
query {
  roles(first: 10) {
    edges {
      node {
        id
        name
        policies(
          first: 20
          where: { action: "read" }
          orderBy: { direction: ASC, field: RESOURCE }
        ) {
          edges {
            node {
              id
              resource
              action
              effect
            }
          }
          totalCount
        }
      }
    }
  }
}
```

## Relations

* **Role** `M:N` **User**: A role can be assigned to multiple users, and users can have multiple roles
* **Role** `M:N` **Group**: A role can be assigned to multiple groups, and groups can have multiple roles
* **Role** `1:N` **AccessPolicy**: A role has multiple access policies that define its permissions

## Purpose

Roles are central to the system's RBAC implementation. They act as containers for access policies, which define what resources users can access and what actions they can perform. By assigning roles to users or groups, administrators can efficiently manage permissions across the system. The `policies` relationship connects roles to specific access controls defined in AccessPolicy entities.


---

# 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://docs.pyck.cloud/graphql-api/types/role.md?ask=<question>&goal=<user_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.