---
title: "Use the ACCESSRIGHTS Function to Return Access Right Values"
slug: "accessrights-function"
description: "Learn to use ACCESSRIGHTS to return access control values based on read and write Booleans in your Pigment model."
updated: 2026-04-16T12:53:31Z
published: 2026-04-16T12:53:31Z
---

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

# ACCESSRIGHTS function

## Description

Returns an Access Right typed value corresponding to the read and write Boolean options.

> [!WARNING]
> Users must have the Define Application security [permission](/v1/docs/pigment-access-basics) to be able to use this function.

## Syntax

```plaintext
ACCESSRIGHTS(Read, Write)
```

- `Read`**(Boolean).**Corresponds to the Read option. TRUE allows Members to read data, FALSE prevents reading, BLANK prevents reading.
- `Write`**(Boolean).** Corresponds to the Write option. TRUE allows Members to write data, FALSE prevents write, BLANK prevents write.

## Return type

`Access Rights`

## Examples

| **Case** | **Results** | **Return Type** |
| --- | --- | --- |
| `ACCESSRIGHTS(true, true)` | `read/write` | `Access Rights` |
| `ACCESSRIGHTS(true, false)` | `read/no write` | `Access Rights` |
| `ACCESSRIGHTS(blank, false )` | `no write` | `Access Rights` |
| `ACCESSRIGHTS(true, blank)` | `read` | `Access Rights` |

> We recommend to use the BLANK in your formula instead of FALSE where possible in order to benefit from Pigment’s sparse engine. Computations on Pigment are faster on datasets that are sparse; meaning Access Rights metrics that use BLANK in their formulas instead of a value (TRUE/ FALSE) will benefit from this.
> 
> See [Leverage sparsity for optimal performance](/v1/docs/leverage-sparsity-for-optimal-performance) for more details.

**Excel equivalent**: none

**See also**: [RESETACCESSRIGHTS](/v1/docs/resetaccessrights-function)

> [!TIP]
> **More of a hands-on learner?**
> 
> Talk to your Customer Success Manager about downloading the Functions and Modifiers in Pigment Application into your workspace. It includes examples of every Function and Modifier in Pigment!