Access Manager v3 API for Unity SDK

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 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.

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.

Grant token

Requires Access Manager add-on

This method requires that the Access Manager add-on is enabled for your key in the Admin Portal. Read the support page 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), 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 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
`Channels`	`read`, `write`, `get`, `manage`, `update`, `join`, `delete`
`ChannelGroups`	`read`, `manage`
`Uuids`	`get`, `update`, `delete`

For permissions and API operations mapping, refer to Manage Permissions with Access Manager v3.

TTL

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.

RegEx

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, define RegEx permissions for a given resource type in the grant request.

For more details, see RegEx in Access Manager v3.

Authorized UUID

Setting an AuthorizedUuid 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 AuthorizedUuid isn't specified during the grant request, the token can be used by any client with any UUID. It's recommended to restrict tokens to a single AuthorizedUuid to prevent impersonation.

For more details, see Authorized UUID in Access Manager v3.

Method(s)

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

* required

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: None Default: n/a	Returns `Task<PNResult<PNAccessManagerTokenResult>>`.

PNTokenResources contains the following properties:

* required

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:

* required

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.

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

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.

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:

* required

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

{ "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.

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.

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.

Error responses

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, or permissions.

Revoke token

Requires Access Manager add-on

This method requires that the Access Manager add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Enable token revoke

To revoke tokens, you must first enable this feature on the Admin Portal. 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.

For more information, refer to Revoke permissions.

Method(s)

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

* required

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: None Default: n/a	Returns `Task<PNResult<PNAccessManagerRevokeTokenResult>>`.

Sample code

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)

ParseToken(String token)

* required

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

Sample code

Returns

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)

SetAuthToken(String token)

* required

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

Sample code

Returns

This method doesn't return any response value.

Grant token - spaces & users (deprecated)

Requires Access Manager add-on

This method requires that the Access Manager add-on is enabled for your key in the Admin Portal. Read the support page 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.

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.

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.

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.

Method(s) - spaces & users (deprecated)

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

* required

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: None Default: n/a	Returns `Task<PNResult<PNAccessManagerTokenResult>>`.

PNTokenResources contains the following properties:

* required

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:

* required

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.

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)

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:

* required

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

{ "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.

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.

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.

User ID / UUID

Grant token​

Requires Access Manager add-on

Permissions​

TTL​

RegEx​

Authorized UUID​

Method(s)​

Required key/value mappings

Sample code​

Reference code

Returns​

Other examples​

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

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

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

Error responses​

Revoke token​

Requires Access Manager add-on

Enable token revoke

Method(s)​

Sample code​

Returns​

Error Responses​

Parse token​

Method(s)​

Sample code​

Returns​

Error Responses​

Set token​

Method(s)​

Sample code​

Returns​

Grant token - spaces & users (deprecated)​

Requires Access Manager add-on

Permissions - spaces & users (deprecated)​

TTL - spaces & users (deprecated)​

RegEx - spaces & users (deprecated)​

Authorized user ID - spaces & users (deprecated)​

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

Required key/value mappings

Sample code - spaces & users (deprecated)​

Returns - spaces & users (deprecated)​

Other examples - spaces & users (deprecated)​

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

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

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)​

Error Responses - spaces & users (deprecated)​

Grant token

Permissions

TTL

RegEx

Authorized UUID

Method(s)

Sample code

Returns

Other examples

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

Grant an authorized client read access to multiple channels using RegEx

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

Error responses

Revoke token

Method(s)

Sample code

Returns

Error Responses

Parse token

Method(s)

Sample code

Returns

Error Responses

Set token

Method(s)

Sample code

Returns

Grant token - spaces & users (deprecated)

Permissions - spaces & users (deprecated)

TTL - spaces & users (deprecated)

RegEx - spaces & users (deprecated)

Authorized user ID - spaces & users (deprecated)

Method(s) - spaces & users (deprecated)

Sample code - spaces & users (deprecated)

Returns - spaces & users (deprecated)

Other examples - spaces & users (deprecated)

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

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

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)

Error Responses - spaces & users (deprecated)