---
source_url: https://www.pubnub.com/docs/sdks/unity/api-reference/access-manager
title: Access Manager v3 API for Unity SDK
updated_at: 2026-06-16T12:52:43.569Z
sdk_name: PubNub Unity SDK
sdk_version: v9.4.0
---

> Documentation Index
> For a curated overview of PubNub documentation, see: https://www.pubnub.com/docs/llms.txt
> For the full list of all documentation pages, see: https://www.pubnub.com/docs/llms-full.txt


# Access Manager v3 API for Unity SDK

PubNub Unity SDK, use the latest version: v9.4.0

:::warning Access Manager isn't enabled by default
Without it, PubNub resources on this keyset have no access controls and clients can reach
channels
and metadata without permission checks. Enable Access Manager in
[Admin Portal](https://admin.pubnub.com/)
before deploying to production.
:::

Access Manager allows you to enforce security controls for client access to resources within the PubNub Platform. With Access Manager, your servers can grant their clients tokens with embedded permissions that provide access to individual PubNub resources:

* For a limited period of time.
* Through resource lists or patterns (regular expressions).
* In a single API request, even if permission levels differ (`read` to `channel1` and `write` to `channel2`).

You can add the [authorizedUuid](https://www.pubnub.com/docs/general/security/access-control#authorized-uuid) parameter to the grant request to restrict the token usage to one client with a given `userId`. Once specified, only this `authorizedUuid` will be able to use the token to make API requests for the specified resources, according to permissions given in the grant request.

:::note User ID / UUID
User ID is also referred to as **UUID/uuid** in some APIs and server responses but **holds the value** of the **userId** parameter you [set during initialization](https://www.pubnub.com/docs/general/setup/users-and-devices#set-the-user-id).
:::

## Grant token

:::note Requires Access Manager add-on
This method requires that the *Access Manager* add-on is enabled for your key in the [Admin Portal](https://admin.pubnub.com/). Read the [support page](https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-) on enabling add-on features on your keys.
:::

:::warning Requires Secret Key authentication
Granting permissions to resources should be done by administrators whose SDK instance has been [initialized](https://www.pubnub.com/docs/sdks/unity/api-reference/configuration) with a **Secret Key** (available on the [Admin Portal](https://admin.pubnub.com/) on your app's keyset).
:::

The `GrantToken()` method generates a time-limited authorization token with an embedded access control list. The token defines time to live (`TTL`), `AuthorizedUuid`, and a set of permissions giving access to one or more resources:

* `Channels`
* `ChannelGroups`
* `Uuids` (other users' object metadata, such as their names or avatars)

Only this `AuthorizedUuid` will be able to use the token with the defined permissions. The authorized client will send the token to PubNub with each request until the token's `TTL` expires. Any unauthorized request or a request made with an invalid token will return a `403` with a respective error message.

###### Permissions

The grant request allows your server to securely grant clients access to resources on the PubNub platform. Each resource type supports a specific set of operations:

| Resource | Permissions |
| --- | --- |
| `channels` | `read`, `write`, `get`, `manage`, `update`, `join`, `delete` |
| `groups` | `read`, `manage` |
| `uuids` | `get`, `update`, `delete` |

For a full mapping of permissions to API operations, refer to [Manage Permissions with Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#permissions).

###### TTL (time to live)

The `ttl` (time to live) parameter defines how many minutes the permissions remain valid. After expiration, the client must get a new token to maintain access.

* `ttl` is required for every grant call.
* There is no default value.
* The maximum allowed value is 43,200 (30 days).

For more details, see [TTL in Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#ttl).

###### RegEx patterns

Use regular expression (RegEx) patterns to set permissions without listing each resource. Define RegEx permissions for a given resource type in the grant request. Patterns are evaluated on the server using [RE2-style syntax](https://github.com/google/re2/wiki/Syntax); backreferences and lookaround assertions are not supported.

For more details, see [RegEx in Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#regex).

###### Authorized UUID

The `AuthorizedUuid` parameter restricts token usage to a specific client. Only requests from this UUID are authorized by PubNub. If you do not set `AuthorizedUuid`, any client with any UUID can use the token. For security, restrict tokens to a single `AuthorizedUuid` to prevent impersonation.

For more details, see [Authorized UUID in Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#authorized-uuid).

### Method(s)

```csharp
pubnub.GrantToken()
    .TTL(int)
    .Meta(Dictionary<string, object>)
    .AuthorizedUuid(string)
    .Resources(PNTokenResources)
    .Patterns(PNTokenPatterns)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNAccessManagerTokenResult, PNStatus>)
```

| Parameter | Description |
| --- | --- |
| `TTL` *Type: `int`Default: n/a | Total number of minutes for which the token is valid. The minimum allowed value is 1., The maximum is 43,200 minutes (30 days). |
| `Meta`Type: Dictionary`<string, object>`Default: n/a | Extra metadata to be published with the request. Values must be scalar only; arrays or objects aren't supported. |
| `AuthorizedUuid`Type: `string`Default: n/a | Single `Uuid` which is authorized to use the token to make API requests to PubNub. |
| `Resources`Type: `PNTokenResources`Default: n/a | Object containing channel, channel group, and UUID metadata permissions. |
| `Patterns`Type: `PNTokenPatterns`Default: n/a | Object containing permissions to apply to all channel, channel group, and UUID metadata matching the RegEx pattern. |
| `QueryParam`Type: Dictionary`<string, object>`Default: n/a | Dictionary `object` to pass name/value pairs as query `string` params with PubNub URL request for debug purposes. |
| `Execute`Type: `System.Action`Default: n/a | `System.Action` of type `PNAccessManagerTokenResult`. |
| `ExecuteAsync`Type: NoneDefault: n/a | Returns `Task<PNResult<PNAccessManagerTokenResult>>`. |

`PNTokenResources` contains the following properties:

| Parameter | Description |
| --- | --- |
| `Channels`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing channel permissions. |
| `ChannelGroups`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing channel group permissions. |
| `Uuids`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing UUID metadata permissions. |

`PNTokenPatterns` contains the following properties:

| Parameter | Description |
| --- | --- |
| `Channels`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing permissions to apply to all channels matching the RegEx pattern. |
| `ChannelGroups`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing permissions to apply to all channel groups matching the RegEx pattern. |
| `Uuids`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing permissions to apply to all UUID metadata matching the RegEx pattern. |

`PNTokenAuthValues` contains the following properties:

| Property Name | Type | Description |
| --- | --- | --- |
| `Read` | `bool` | Read permission. Applies to Subscribe, History, and Presence. |
| `Write` | `bool` | Write permission. Applies to Publish. |
| `Manage` | `bool` | Manage permission. Applies to Channel Groups and App Context. |
| `Delete` | `bool` | Delete permission. Applies to History and App Context. |
| `Get` | `bool` | Get permission. Applies to App Context. |
| `Update` | `bool` | Update permission. Applies to App Context. |
| `Join` | `bool` | Join permission. Applies to App Context. |

:::note Required key/value mappings
For a successful grant request, you must specify permissions for at least one UUID, channel, or group, either as a resource list or as a pattern (RegEx).
:::

### Sample code

:::tip Reference code
This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.
:::

```csharp
using System.Collections.Generic;
using PubnubApi;
using PubnubApi.Unity;
using UnityEngine;

public class GrantTokenExample : MonoBehaviour {
	//Reference to a pubnub manager previously setup in Unity Editor
	//For more details see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
	//NOTE: For Access Management to work the keyset must have PAM enabled
	[SerializeField] private PNManagerBehaviour pubnubManager;

	//An editor-serialized string with the test channel ID
	[SerializeField] private string testChannelId = "test_channel_id";

	private async void Start() {
		//Getting a reference to the Pubnub instance
		var pubnub = pubnubManager.pubnub;

		// Note that you can also initialize Pubnub instance for Unity directly from code:
		/*
		PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
		{
			SubscribeKey = "demo",
			PublishKey = "demo",
		};
		Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);
		*/

		//Creating a full access set for the sake of demonstration
		var fullAccess = new PNTokenAuthValues() {
			Read = true,
			Write = true,
			Create = true,
			Get = true,
			Delete = true,
			Join = true,
			Update = true,
			Manage = true
		};

		//Asynchronously executing a full-access grant operation for the test channel for user ID specified in the config
		//The $"{testChannelId}{Constants.Pnpres}" addition ensured full access to the channel with PubNub Presence operations
		var grantResult = await pubnub.GrantToken().TTL(30).AuthorizedUuid(pubnub.PNConfig.UserId).Resources(
				new PNTokenResources() {
					Channels = new Dictionary<string, PNTokenAuthValues>() {
						{
							testChannelId, fullAccess
						},
						{
							$"{testChannelId}{Constants.Pnpres}", fullAccess
						}
					}
				})
			.ExecuteAsync();

		//Doing simple error handling in case something went wrong during the grant operation
		if (grantResult.Status.Error) {
			Debug.LogError($"Error in grant operation: {grantResult.Status.ErrorData.Information}");
		}
	}
}
```

### Returns

The `GrantToken()` operation returns `PNResult<PNAccessManagerTokenResult>` which contains the following properties:

| Property | Description |
| --- | --- |
| `Result`Type: `PNAccessManagerTokenResult` | Returns a `PNAccessManagerTokenResult` object. |
| `Status`Type: `PNStatus` | Returns a `PNStatus` object. |

`PNAccessManagerTokenResult` contains the following properties:

| Parameter | Description |
| --- | --- |
| `Token` *Type: `String` | Current token with embedded permissions. |

```json
{ "Token":"p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI"}
```

### Other examples

#### Grant an authorized client different levels of access to various resources in a single call

The code below grants `my-authorized-uuid`:

* Read access to `channel-a`, `channel-group-b`, and get to `uuid-c`.
* Read/write access to `channel-b`, `channel-c`, `channel-d`, and get/update to `uuid-d`.

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

PNResult<PNAccessManagerTokenResult> grantTokenResponse = await pubnub.GrantToken()
    .TTL(15)
    .AuthorizedUuid("my-authorized-uuid")
    .Resources(new PNTokenResources()
    {
        Channels = new Dictionary<string, PNTokenAuthValues>() {
            { "channel-a", new PNTokenAuthValues() { Read = true } },
            { "channel-b", new PNTokenAuthValues() { Read = true, Write = true } },
            { "channel-c", new PNTokenAuthValues() { Read = true, Write = true } },
            { "channel-d", new PNTokenAuthValues() { Read = true, Write = true } }},
        ChannelGroups = new Dictionary<string, PNTokenAuthValues>() {
            { "channel-group-b", new PNTokenAuthValues() { Read = true } } },
        Uuids = new Dictionary<string, PNTokenAuthValues>() {
            { "uuid-c", new PNTokenAuthValues() { Get = true } },
            { "uuid-d", new PNTokenAuthValues() { Get = true, Update = true } }}
    })
    .ExecuteAsync();
PNAccessManagerTokenResult grantTokenResult = grantTokenResponse.Result;
PNStatus grantTokenStatus = grantTokenResponse.Status;
if (!grantTokenStatus.Error && grantTokenResult != null)
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
else
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenStatus));
}
```

#### Grant an authorized client read access to multiple channels using RegEx

The code below grants `my-authorized-uuid` read access to all channels that match the `channel-[A-Za-z0-9]` RegEx pattern.

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

PNResult<PNAccessManagerTokenResult> grantTokenResponse = await pubnub.GrantToken()
    .TTL(15)
    .AuthorizedUuid("my-authorized-uuid")
    .Patterns(new PNTokenPatterns()
    {
        Channels = new Dictionary<string, PNTokenAuthValues>() {
            { "channel-[A-Za-z0-9]", new PNTokenAuthValues() { Read = true } }}
    })
    .ExecuteAsync();
PNAccessManagerTokenResult grantTokenResult = grantTokenResponse.Result;
PNStatus grantTokenStatus = grantTokenResponse.Status;
if (!grantTokenStatus.Error && grantTokenResult != null)
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
else
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenStatus));
}
```

#### Grant an authorized client different levels of access to various resources and read access to channels using RegEx in a single call

The code below grants the `my-authorized-uuid`:

* Read access to `channel-a`, `channel-group-b`, and get to `uuid-c`.
* Read/write access to `channel-b`, `channel-c`, `channel-d`, and get/update to `uuid-d`.
* Read access to all channels that match the `channel-[A-Za-z0-9]` RegEx pattern.

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

PNResult<PNAccessManagerTokenResult> grantTokenResponse = await pubnub.GrantToken()
    .TTL(15)
    .AuthorizedUuid("my-authorized-uuid")
    .Resources(new PNTokenResources()
    {
        Channels = new Dictionary<string, PNTokenAuthValues>() {
            { "channel-a", new PNTokenAuthValues() { Read = true } },
            { "channel-b", new PNTokenAuthValues() { Read = true, Write = true } },
            { "channel-c", new PNTokenAuthValues() { Read = true, Write = true } },
            { "channel-d", new PNTokenAuthValues() { Read = true, Write = true } }},
        ChannelGroups = new Dictionary<string, PNTokenAuthValues>() {
            { "channel-group-b", new PNTokenAuthValues() { Read = true } } },
        Uuids = new Dictionary<string, PNTokenAuthValues>() {
            { "uuid-c", new PNTokenAuthValues() { Get = true } },
            { "uuid-d", new PNTokenAuthValues() { Get = true, Update = true } }}
    })
    .Patterns(new PNTokenPatterns()
    {
        Channels = new Dictionary<string, PNTokenAuthValues>() {
            { "channel-[A-Za-z0-9]", new PNTokenAuthValues() { Read = true } }}
    })
    .ExecuteAsync();
PNAccessManagerTokenResult grantTokenResult = grantTokenResponse.Result;
PNStatus grantTokenStatus = grantTokenResponse.Status;
if (!grantTokenStatus.Error && grantTokenResult != null)
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
else
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenStatus));
}
```

### Error responses

If you submit an invalid request, the server returns HTTP 400 with a message that identifies the missing or incorrect argument. Causes can include a RegEx issue, an [invalid timestamp](https://support.pubnub.com/hc/en-us/articles/360051973331-Why-do-I-get-Invalid-Timestamp-when-I-try-to-grant-permission-using-Access-Manager-), or incorrect permissions.

## Revoke token

:::note Requires Access Manager add-on
This method requires that the *Access Manager* add-on is enabled for your key in the [Admin Portal](https://admin.pubnub.com/). Read the [support page](https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-) on enabling add-on features on your keys.
:::

:::note Enable token revoke
To revoke tokens, you must first enable this feature on the [Admin Portal](https://admin.pubnub.com/). To do that, navigate to your app's keyset and mark the *Revoke v3 Token* checkbox in the *ACCESS MANAGER* section.
:::

The `RevokeToken()` method allows you to disable an existing token and revoke all permissions embedded within. You can only revoke a valid token previously obtained using the `GrantToken()` method.

Use this method for tokens with `TTL` less than or equal to 30 days. If you need to revoke a token with a longer `TTL`, [contact support](https://www.pubnub.com/docs/mailto:support@pubnub.com).

For more information, refer to [Revoke permissions](https://www.pubnub.com/docs/general/security/access-control#revoke-permissions).

### Method(s)

```csharp
pubnub.RevokeToken()
    .Token(string)
    .QueryParam(Dictionary<string, object>)
    .Execute(System.Action<PNAccessManagerRevokeTokenResult, PNStatus>)
```

| Parameter | Description |
| --- | --- |
| `Token` *Type: `string`Default: n/a | Existing token with embedded permissions. |
| `QueryParam`Type: Dictionary`<string, object>`Default: n/a | Dictionary `object` to pass name/value pairs as query `string` params with PubNub URL request for debug purposes. |
| `Execute`Type: `System.Action`Default: n/a | `System.Action` of type `PNAccessManagerRevokeTokenResult`. |
| `ExecuteAsync`Type: NoneDefault: n/a | Returns `Task<PNResult<PNAccessManagerRevokeTokenResult>>`. |

### Sample code

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

PNResult<PNAccessManagerRevokeTokenResult> revokeTokenResponse = await pubnub
    .RevokeToken()
    .Token("p0thisAkFl043rhDdHRsCkNDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")
    .ExecuteAsync();
PNAccessManagerRevokeTokenResult revokeTokenResult = revokeTokenResponse.Result;
PNStatus revokeTokenStatus = revokeTokenResponse.Status;
if (!revokeTokenStatus.Error && revokeTokenResult != null)
{
    Debug.Log("Revoke token success");
}
else
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(revokeTokenStatus));
}
```

### Returns

The `RevokeToken()` operation returns `PNResult<PNAccessManagerRevokeTokenResult>` which contains the following properties:

| Property | Description |
| --- | --- |
| `Result`Type: `PNAccessManagerRevokeTokenResult` | Returns an empty `PNAccessManagerRevokeTokenResult` object when the token revocation request is successful. |
| `Status`Type: `PNStatus` | Returns a `PNStatus` object for operations ending in success or failure. |

### Error Responses

If you submit an invalid request, the server returns an error status code with a descriptive message informing which of the provided arguments is missing or incorrect. Depending on the root cause, this operation may return the following errors:

* `400 Bad Request`
* `403 Forbidden`
* `503 Service Unavailable`

## Parse token

The `ParseToken()` method decodes an existing token and returns the object containing permissions embedded in that token. The client can use this method for debugging to check the permissions to the resources or find out the token's `TTL` details.

### Method(s)

```csharp
ParseToken(String token)
```

| Parameter | Description |
| --- | --- |
| `token` *Type: `String` | Current token with embedded permissions. |

### Sample code

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

var parsedTokenContent =
    pubnub.ParseToken(
        "p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI");
var parsedTokenJson = pubnub.JsonPluggableLibrary.SerializeToJsonString(parsedTokenContent);
```

### Returns

```csharp
{
   "Version":2,
   "Timestamp":1619718521,
   "TTL":15,
   "AuthorizedUuid":"my_uuid",
   "Resources":{
      "Uuids":{
        "uuid-id":{
            "Read":true,
            "Write":true,
            "Manage":true,
            "Delete":true,
            "Get":true,
            "Update":true,
            "Join":true
        }
      },
      "Channels":{
        "channel-id":{
            "Read":true,
            "Write":true,
            "Manage":true,
            "Delete":true,
            "Get":true,
            "Update":true,
            "Join":true
        }
      },
      "ChannelGroups":{
        "group-id":{
            "Read":true,
            "Write":true,
            "Manage":true,
            "Delete":true,
            "Get":true,
            "Update":true,
            "Join":true
        }
      }
   },
   "Patterns":{
      "Uuids":{
        "uuid-pattern":{
            "Read":true,
            "Write":true,
            "Manage":true,
            "Delete":true,
            "Get":true,
            "Update":true,
            "Join":true
        }
      },
      "Channels":{
        "channel-pattern":{
            "Read":true,
            "Write":true,
            "Manage":true,
            "Delete":true,
            "Get":true,
            "Update":true,
            "Join":true
        }
      },
      "ChannelGroups":{
        "group-pattern":{
            "Read":true,
            "Write":true,
            "Manage":true,
            "Delete":true,
            "Get":true,
            "Update":true,
            "Join":true
        }
      }
   }
}
```

To better understand the structure of the `TokenContents` object, see the details of all related custom types:

* `TokenContents`

| Parameter | Description |
| --- | --- |
| `Resources`Type: `TokenResources` | Resource permissions specified in a sequence. |
| `Patterns`Type: `TokenPatterns` | Resource permissions expressed as RegEx patterns. |
| `Meta`Type: `Dictionary<string, object>` | Extra metadata to be published with the request. Values must be scalar only; arrays or objects aren't supported. |
| `Signature`Type: `string` | HMAC+SHA256 signed with a PubNub confidential signing key. |
| `Version`Type: `int` | Version of the token structure. |
| `Timestamp`Type: `long` | Parameter generated on the server side to record the time when the token was created. |
| `TTL`Type: `int` | Total number of minutes for which the token is valid. The minimum allowed value is 1., The maximum is 43,200 minutes (30 days). |
| `AuthorizedUUID`Type: `string` | Single UUID which is solely authorized to use the token to make API requests to PubNub. |

* `TokenResources`

| Parameter | Description |
| --- | --- |
| `Channels`Type: `Dictionary<string, TokenAuthValues>` | Individual or sequential channel permissions. |
| `Groups`Type: `Dictionary<string, TokenAuthValues>` | Individual or sequential group permissions. |
| `UUIDs`Type: `Dictionary<string, TokenAuthValues>` | Individual or sequential UUID permissions. This resource is only used in Objects v2 operations. |

* `TokenPatterns`

| Parameter | Description |
| --- | --- |
| `Channels`Type: `Dictionary<string, TokenAuthValues>` | Channel permissions expressed as RegEx patterns. |
| `Groups`Type: `Dictionary<string, TokenAuthValues>` | Group permissions expressed as RegEx patterns. |
| `UUIDs`Type: `Dictionary<string, TokenAuthValues>` | UUID permissions expressed as RegEx patterns. This resource is only used in Objects v2 operations. |

* TokenAuthValues Read (bool), Write (bool), Manage (bool), Delete (bool), Get (bool), Update (bool), Join (bool)

### Error Responses

If you receive an error while parsing the token, it may suggest that the token is damaged. In that case, request the server to issue a new one.

## Set token

The `SetAuthToken()` method is used by the client devices to update the authentication token granted by the server.

### Method(s)

```csharp
SetAuthToken(String token)
```

| Parameter | Description |
| --- | --- |
| `token` *Type: `String` | Current token with embedded permissions. |

### Sample code

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

pubnub.SetAuthToken(
    "p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI");
```

### Returns

This method doesn't return any response value.

## Grant token - spaces & users (deprecated)

:::note Requires Access Manager add-on
This method requires that the *Access Manager* add-on is enabled for your key in the [Admin Portal](https://admin.pubnub.com/). Read the [support page](https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-) on enabling add-on features on your keys.
:::

The `GrantToken()` method generates a time-limited authorization token with an embedded access control list. The token defines time to live (`TTL`), `AuthorizedUserId`, and a set of permissions giving access to one or more resources:

* `Spaces`
* `Users` (other users' metadata, such as their names or avatars)

Only this `AuthorizedUserId` will be able to use the token with the defined permissions. The authorized client will send the token to PubNub with each request until the token's `TTL` expires. Any unauthorized request or a request made with an invalid token will return a `403` with a respective error message.

#### Permissions - spaces & users (deprecated)

The grant request allows your server to securely grant your clients access to the resources within the PubNub Platform. There is a limited set of operations the clients can perform on every resource:

| Resource | Permissions |
| --- | --- |
| `Spaces` | `read`, `write`, `get`, `manage`, `update`, `join`, `delete` |
| `Users` | `get`, `update`, `delete` |

For permissions and API operations mapping, refer to [Manage Permissions with Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#permissions).

#### TTL - spaces & users (deprecated)

The `TTL` (time to live) parameter is the number of minutes before the granted permissions expire. The client will require a new token to be granted before expiration to ensure continued access. `ttl` is a required parameter for every grant call and there is no default value set for it. The max value for `ttl` is 43,200 (30 days).

For more details, see [TTL in Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#ttl).

#### RegEx - spaces & users (deprecated)

If you prefer to specify permissions by setting patterns, rather than listing all resources one by one, you can use regular expressions. To do this, set RegEx permissions as `Patterns` before making a grant request.

For more details, see [RegEx in Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#regex).

#### Authorized user ID - spaces & users (deprecated)

Setting an `AuthorizedUserId` in the token helps you specify which client device should use this token in every request to PubNub. This will ensure that all requests to PubNub are authorized before PubNub processes them. If `AuthorizedUserId` isn't specified during the grant request, the token can be used by any client with any `UserId`. It's recommended to restrict tokens to a single `AuthorizedUserId` to prevent impersonation.

For more details, see [Authorized UUID in Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#authorized-uuid).

#### Method(s) - spaces & users (deprecated)

```csharp
pubnub.GrantToken()
    .TTL(int)
    .Meta(Dictionary<string, object>)
    .AuthorizedUserId(string)
    .Resources(PNTokenResources)
    .Patterns(PNTokenPatterns)
    .QueryParam(Dictionary<string,object>)
    .Execute(System.Action<PNAccessManagerTokenResult, PNStatus>)
```

| Parameter | Description |
| --- | --- |
| `TTL` *Type: `int`Default: n/a | Total number of minutes for which the token is valid. The minimum allowed value is 1., The maximum is 43,200 minutes (30 days). |
| `Meta`Type: Dictionary`<string, object>`Default: n/a | Extra metadata to be published with the request. Values must be scalar only; arrays or objects aren't supported. |
| `AuthorizedUserId`Type: `string`Default: n/a | Single `Uuid` which is authorized to use the token to make API requests to PubNub. |
| `Resources`Type: `PNTokenResources`Default: n/a | Object containing channel, channel group, and UUID metadata permissions. |
| `Patterns`Type: `PNTokenPatterns`Default: n/a | Object containing permissions to apply to all channel, channel group, and UUID metadata matching the RegEx pattern. |
| `QueryParam`Type: Dictionary`<string, object>`Default: n/a | Dictionary `object` to pass name/value pairs as query `string` params with PubNub URL request for debug purposes. |
| `Execute`Type: `PNCallback`Default: n/a | `System.Action` of type `PNAccessManagerTokenResult`. |
| `ExecuteAsync`Type: NoneDefault: n/a | Returns `Task<PNResult<PNAccessManagerTokenResult>>`. |

`PNTokenResources` contains the following properties:

| Parameter | Description |
| --- | --- |
| `Spaces`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing Space permissions. |
| `Users`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing User metadata permissions. |

`PNTokenPatterns` contains the following properties:

| Parameter | Description |
| --- | --- |
| `Spaces`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing permissions to apply to all Spaces matching the RegEx pattern. |
| `Users`Type: `Dictionary<string, PNTokenAuthValues>`Default: n/a | Dictionary object containing permissions to apply to all User metadata matching the RegEx pattern. |

`PNTokenAuthValues` contains the following properties:

| Property Name | Type | Description |
| --- | --- | --- |
| `Read` | `bool` | Read permission. |
| `Write` | `bool` | Write permission. |
| `Manage` | `bool` | Manage permission. |
| `Delete` | `bool` | Delete permission. |
| `Get` | `bool` | Get permission. |
| `Update` | `bool` | Update permission. |
| `Join` | `bool` | Join permission. |

:::note Required key/value mappings
For a successful grant request, you must specify permissions for at least one User or Space either as a resource list or as a pattern (RegEx).
:::

#### Sample code - spaces & users (deprecated)

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

PNResult<PNAccessManagerTokenResult> grantTokenResponse = await pubnub.GrantToken()
    .TTL(15)
    .AuthorizedUserId("my-authorized-userId")
    .Resources(new PNTokenResources()
    {
        Spaces = new Dictionary<string, PNTokenAuthValues>() {
            { "my-space", new PNTokenAuthValues() { Read = true } } } // False to disallow
    })
    .ExecuteAsync();
PNAccessManagerTokenResult grantTokenResult = grantTokenResponse.Result;
PNStatus grantTokenStatus = grantTokenResponse.Status;
//PNAccessManagerTokenResult is a parsed and abstracted response from the server
if (!grantTokenStatus.Error && grantTokenResult != null)
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
else
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenStatus));
}
```

#### Returns - spaces & users (deprecated)

The `GrantToken()` operation returns `PNResult<PNAccessManagerTokenResult>` which contains the following properties:

| Property | Description |
| --- | --- |
| `Result`Type: `PNAccessManagerTokenResult` | Returns a `PNAccessManagerTokenResult` object. |
| `Status`Type: `PNStatus` | Returns a `PNStatus` object. |

`PNAccessManagerTokenResult` contains the following properties:

| Parameter | Description |
| --- | --- |
| `Token` *Type: `String` | Current token with embedded permissions. |

```json
{ "Token":"p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI"}
```

#### Other examples - spaces & users (deprecated)

##### Grant an authorized client different levels of access to various resources in a single call - spaces & users (deprecated)

The code below grants `my-authorized-userId`:

* Read access to `space-a`, and get to `userId-c`.
* Read/write access to `space-b`, `space-c`, `space-d`, and get/update to `userId-d`.

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

PNResult<PNAccessManagerTokenResult> grantTokenResponse = await pubnub.GrantToken()
    .TTL(15)
    .AuthorizedUserId("my-authorized-userId")
    .Resources(new PNTokenResources()
    {
        Spaces = new Dictionary<string, PNTokenAuthValues>() {
            { "space-a", new PNTokenAuthValues() { Read = true } },
            { "space-b", new PNTokenAuthValues() { Read = true, Write = true } },
            { "space-c", new PNTokenAuthValues() { Read = true, Write = true } },
            { "space-d", new PNTokenAuthValues() { Read = true, Write = true } }},
        Users = new Dictionary<string, PNTokenAuthValues>() {
            { "user-c", new PNTokenAuthValues() { Get = true } },
            { "user-d", new PNTokenAuthValues() { Get = true, Update = true } }}
    })
    .ExecuteAsync();
PNAccessManagerTokenResult grantTokenResult = grantTokenResponse.Result;
PNStatus grantTokenStatus = grantTokenResponse.Status;
if (!grantTokenStatus.Error && grantTokenResult != null)
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
else
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenStatus));
}
```

##### Grant an authorized client read access to multiple spaces using RegEx - spaces & users (deprecated)

The code below grants `my-authorized-userId` read access to all channels that match the `space-[A-Za-z0-9]` RegEx pattern.

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

PNResult<PNAccessManagerTokenResult> grantTokenResponse = await pubnub.GrantToken()
    .TTL(15)
    .AuthorizedUserId("my-authorized-userId")
    .Patterns(new PNTokenPatterns()
    {
        Spaces = new Dictionary<string, PNTokenAuthValues>() {
            { "space-[A-Za-z0-9]", new PNTokenAuthValues() { Read = true } }}
    })
    .ExecuteAsync();
PNAccessManagerTokenResult grantTokenResult = grantTokenResponse.Result;
PNStatus grantTokenStatus = grantTokenResponse.Status;
if (!grantTokenStatus.Error && grantTokenResult != null)
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
else
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenStatus));
}
```

##### Grant an authorized client different levels of access to various resources and read access to spaces using RegEx in a single call - spaces & users (deprecated)

The code below grants the `my-authorized-userId`:

* Read access to `space-a` and `userId-c`.
* Read/write access to `space-b`, `space-c`, `space-d`, and get/update to `userId-d`.
* Read access to all channels that match the `space-[A-Za-z0-9]` RegEx pattern.

```csharp
using PubnubApi;
using PubnubApi.Unity;

//Create configuration
PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"))
{
 SubscribeKey = "YOUR_SUBSCRIBE_KEY",
 PublishKey = "YOUR_PUBLISH_KEY",
 SecretKey = "YOUR_SECRET_KEY",
};
//Create a new PubNub instance
Pubnub pubnub = PubnubUnityUtils.NewUnityPubnub(pnConfiguration);

// If you're using Unity Editor setup you can get the Pubnub instance from PNManagerBehaviour
// For more details, see https://www.pubnub.com/docs/sdks/unity#configure-pubnub
/*
[SerializeField] private PNManagerBehaviour pubnubManager;
Pubnub pubnub = pubnubManager.pubnub;
*/

PNResult<PNAccessManagerTokenResult> grantTokenResponse = await pubnub.GrantToken()
    .TTL(15)
    .AuthorizedUserId("my-authorized-userId")
    .Resources(new PNTokenResources()
    {
        Spaces = new Dictionary<string, PNTokenAuthValues>() {
            { "space-a", new PNTokenAuthValues() { Read = true } },
            { "space-b", new PNTokenAuthValues() { Read = true, Write = true } },
            { "space-c", new PNTokenAuthValues() { Read = true, Write = true } },
            { "space-d", new PNTokenAuthValues() { Read = true, Write = true } }},
        Users = new Dictionary<string, PNTokenAuthValues>() {
            { "user-c", new PNTokenAuthValues() { Get = true } },
            { "user-d", new PNTokenAuthValues() { Get = true, Update = true } }}
    })
    .Patterns(new PNTokenPatterns()
    {
        Spaces = new Dictionary<string, PNTokenAuthValues>() {
            { "space-[A-Za-z0-9]", new PNTokenAuthValues() { Read = true } }}
    })
    .ExecuteAsync();
PNAccessManagerTokenResult grantTokenResult = grantTokenResponse.Result;
PNStatus grantTokenStatus = grantTokenResponse.Status;
if (!grantTokenStatus.Error && grantTokenResult != null)
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
else
{
    Debug.Log(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenStatus));
}
```

#### Error Responses - spaces & users (deprecated)

If you submit an invalid request, the server returns the `400` error status code with a descriptive message informing which of the provided arguments is missing or incorrect. These can include, for example, issues with a RegEx, a [timestamp](https://support.pubnub.com/hc/en-us/articles/360051973331-Why-do-I-get-Invalid-Timestamp-when-I-try-to-grant-permission-using-Access-Manager-), or permissions.

## Terms in this document

* **Access Manager** - A cryptographic, token-based permission administrator that allows you to regulate clients' access to PubNub resources, such as channels, channel groups, and user IDs.
* **Action** - The type of activity (procedure) to execute when a condition is satisfied (for example, sending a message).
* **Billing alert notification** - A means of informing a user that a billing alert has been triggered. Before notifications can happen, a billing alert must be triggered first.
* **Business Object** - A container for data fields and metrics that defines aggregations and data sources.
* **Channel** - A pathway for sending and receiving messages between devices, created automatically when you first use it, that can handle any number of users and messages for different communication needs, like 1-1 text chats, group conversations, and other data streaming.
* **Channel pattern** - A way to group and analyze channel data to track performance metrics like message counts and user engagement over time with PubNub Insights.
* **Condition** - A requirement that must be satisfied or evaluated to true for an action to be executed. Input in a decision table.
* **Cryptor** - An implementation of a specific cryptographic algorithm used for data encryption/decryption that adheres to a standard interface.
* **Dashboard** - A collection of widgets (charts) that give an overview of the metrics one is evaluating.
* **Data fields** - Data you want Illuminate to track. These can be quantitative (measures), like "Number" or "Timestamp" or qualitative (dimensions) values, like "String" that can be used to categorize and segment data. Data fields can be aggregated and calculated.
* **Decision** - A collection (or decision table) of conditions and actions. When conditions are satisfied, the corresponding actions are triggered as per defined rules.
* **End Customer** - A customer of a PubNub partner. End customers do not have direct access to the Admin Portal. Instead, they interact with PubNub products—such as Illuminate—through the partner’s portal, where PubNub services are embedded. They can create PubNub objects only within this partner-provided environment.
* **Entity** - A subscribable object within a PubNub SDK that allows you to perform context-specific operations.
* **Listener** - A function or objectthat reacts to events or messages, like new chat messages or connection updates, letting your app respond in real-time.
* **Mapped/Unmapped** - Whether the data source for a data field has been defined or the action has been configured.
* **MCP Server** - A Model Context Protocol server that coordinates communication and synchronization between AI agents, clients, or services, such as Cursor IDE and Windsurf.
* **Message** - A unit of data transmitted between clients or between a client and a server in PubNub, containing information such as text, binary data, or structured data formats like JSON. Messages are sent over channels and can be tracked for delivery and read status.
* **Metric** - What exactly is evaluated using measures and dimensions (collectively called data fields), as well as aggregation functions.
* **Module** - A Functions v1 container that groups related functions for configuration and deployment on an app’s keysets.
* **Origin** - The subdomain used to establish a connection to the PubNub network that allows your application's traffic to appear like it's coming from your own domain.
* **Package** - A Functions v2 container that groups Functions, tracks Revisions, and is deployed to keysets.
* **Partner** - A PubNub customer who resells PubNub products, such as Illuminate, to their own customers. Partners have access to the Admin Portal, enabling them to create and manage PubNub objects for themselves or on behalf of their end customers.
* **Publish Key** - A unique identifier that allows your application to send messages to PubNub channels. It's part of your app's credentials and should be kept secure.
* **PubNub** - PubNub is a real-time messaging platform that provides APIs and SDKs for building scalable applications. It handles the complex infrastructure of real-time communication, including: Message delivery and persistence, Presence detection, Access control, Push notifications, File sharing, Serverless processing with Functions and Events & Actions, Analytics and monitoring with BizOps Workspace, AI-powered insights with Illuminate.
* **Push token** - A device identifier issued by a push provider (APNs or FCM) used to register a device for receiving mobile push notifications.
* **Rule** - A definition (row in a decision table) stating which action should be triggered for which condition.
* **Service Integration** - A machine identity that represents a program or service consuming the Admin API, scoped to your account and authenticated using expirable API keys with configurable permissions.
* **Signal** - A non-persistent message limited to 64 bytes designed for high-volume usecases where the the most recent data is relevant, like GPS location updates.
* **Subscribe Key** - A unique identifier that allows your application to receive messages from PubNub channels. It's part of your app's credentials and should be kept secure.
* **Timetoken** - A unique identifier for each message that represents the number of 100-nanosecond intervals since January 1, 1970, for example, 16200000000000000.
* **Trigger details** - A set of predefined criteria for a given billing alert. When met, billing alert notifications are generated.
* **User** - An individual or entity that interacts with a system, application, or service. In PubNub, a user typically refers to someone who sends or receives messages through the platform, identified by a unique user ID or username.
* **User ID** - UTF-8 encoded, unique string of up to 92 characters used to identify a single client (end user, device, or server) that connects to PubNub.
* **Vibe Coding** - A way to build applications in an intuitive, relaxed, and improvisational manner, using AI tools and natural language descriptions.