> 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/accesspolicy.md).

# AccessPolicy

AccessPolicy Type

Represents an access control policy that defines permissions for resources and actions within the system. AccessPolicies are used for role-based access control (RBAC) to secure the application.

## Fields

| Field       | Type      | Description                                         |
| ----------- | --------- | --------------------------------------------------- |
| `id`        | `ID!`     | Unique identifier of the access policy              |
| `createdAt` | `Time!`   | Creation timestamp                                  |
| `createdBy` | `UUID!`   | User identifier who created the policy              |
| `updatedAt` | `Time`    | Last update timestamp                               |
| `updatedBy` | `UUID`    | User identifier who last updated the policy         |
| `deletedAt` | `Time`    | Deletion timestamp                                  |
| `deletedBy` | `UUID`    | User identifier who deleted the policy              |
| `tenantID`  | `UUID!`   | Tenant identifier                                   |
| `resource`  | `String!` | Resource identifier (e.g., 'inventory.item')        |
| `action`    | `String!` | Action to perform (e.g., 'read', 'write', 'delete') |
| `effect`    | `String!` | Effect of the policy: 'allow' or 'deny'             |

## Interfaces

* `Node`

## Usage Example

```graphql
query {
  accessPolicies(first: 10) {
    edges {
      node {
        id
        resource
        action
        effect
        tenantID
        createdAt
        updatedAt
      }
    }
  }
}
```

## Policy Structure

AccessPolicies follow a resource-action-effect pattern:

* **Resource**: Identifies what is being accessed (e.g., `inventory.item`, `management.user`)
* **Action**: Specifies the operation being performed (e.g., `read`, `write`, `delete`, `create`)
* **Effect**: Determines whether to `allow` or `deny` the access

## Common Use Cases

* Restricting user access to specific inventory items
* Controlling who can create or modify users
* Implementing fine-grained permissions for different tenant resources
* Setting up role-based access control across the application


---

# 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/accesspolicy.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.