Access Manager v3 API for PubNub C# SDK

Access Manager allows you to enforce security controls for client access to resources within the PubNub Platform. With Access Manager v3, 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 space-1 and write to space-2).

You can add the authorizedUserId parameter to the grant request to restrict the token usage to one client with a given userId. Once specified, only this authorizedUserId will be able to use the token to make API requests for the specified resources, according to permissions given in the grant request.

For more information about Access Manager v3, refer to Manage Permissions with Access Manager v3.

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

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:

ResourcePermissions
Spacesread, write, get, manage, update, join, delete
Usersget, 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).

Recommended TTL value

For security reasons, it's recommended to set TTL between 10 and 60, and create a new token before this TTL elapses.

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, set RegEx permissions as Patterns before making a grant request.

For more details, see RegEx in Access Manager v3.

Authorized User ID

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)

pubnub.GrantToken().TTL(int).Meta(Dictionary<string, object>).AuthorizedUserId(string).Resources(PNTokenResources).Patterns(PNTokenPatterns).QueryParam(Dictionary<string,object>)
ParameterTypeRequiredDefaultDescription
TTLintYesn/aTotal number of minutes for which the token is valid.
  • The minimum allowed value is 1.
  • The maximum is 43,200 minutes (30 days).
AuthorizedUserIdstringOptionaln/aSingle Uuid which is authorized to use the token to make API requests to PubNub.
ResourcesPNTokenResourcesOptionaln/aObject containing channel, channel group, and UUID metadata permissions.
PatternsPNTokenPatternsOptionaln/aObject containing permissions to apply to all channel, channel group, and UUID metadata matching the RegEx pattern.
MetaDictionary<string, object>Optionaln/aExtra metadata to be published with the request. Values must be scalar only; arrays or objects aren't supported.
ExecutePNCallbackOptionaln/aPNCallback of type PNAccessManagerTokenResult.
ExecuteAsyncNoneOptionaln/aReturns PNResult<PNAccessManagerTokenResult>.

PNTokenResources contains the following properties:

ParameterTypeRequiredDefaultDescription
SpacesDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing Space permissions.
UsersDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing User metadata permissions.

PNTokenPatterns contains the following properties:

ParameterTypeRequiredDefaultDescription
SpacesDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing permissions to apply to all Spaces matching the RegEx pattern.
UsersDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing permissions to apply to all User metadata matching the RegEx pattern.

PNTokenAuthValues contains the following properties:

Property NameTypeDescription
ReadboolRead permission.
WriteboolWrite permission.
ManageboolManage permission.
DeleteboolDelete permission.
GetboolGet permission.
UpdateboolUpdate permission.
JoinboolJoin 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).

Basic Usage

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)
{
Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
show all 20 lines

Returns

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

PropertyTypeDescription
ResultPNAccessManagerTokenResultReturns a PNAccessManagerTokenResult object.
StatusPNStatusReturns a PNStatus object.

PNAccessManagerTokenResult contains the following properties:

ParameterTypeRequiredDescription
TokenStringYesCurrent 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-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.
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();
show all 25 lines

Grant an authorized client read access to multiple spaces using RegEx

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

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)
{
Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
show all 20 lines

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

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.
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()
show all 30 lines

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>)
ParameterTypeRequiredDefaultDescription
TokenstringYesn/aExisting token with embedded permissions.
ExecutePNCallbackOptionaln/aPNCallback of type PNAccessManagerRevokeTokenResult.
ExecuteAsyncNoneOptionaln/aReturns PNResult<PNAccessManagerRevokeTokenResult>.

Basic Usage

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

Returns

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

PropertyTypeDescription
ResultPNAccessManagerRevokeTokenResultReturns an empty PNAccessManagerRevokeTokenResult object when the token revocation request is successful.
StatusPNStatusReturns 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)
ParameterTypeRequiredDescription
tokenStringYesCurrent token with embedded permissions.

Basic Usage

pubnub.ParseToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Returns

{
"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
show all 76 lines

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)
ParameterTypeRequiredDescription
tokenStringYesCurrent token with embedded permissions.

Basic Usage

pubnub.SetAuthToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Returns

This method doesn't return any response value.

Grant Token (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), 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:

ResourcePermissions
Channelsread, write, get, manage, update, join, delete
ChannelGroupsread, manage
Uuidsget, 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).

Recommended ttl value

For security reasons, it's recommended to set ttl between 10 and 60, and create a new token before this ttl elapses.

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>)
ParameterTypeRequiredDefaultDescription
TTLintYesn/aTotal number of minutes for which the token is valid.
  • The minimum allowed value is 1.
  • The maximum is 43,200 minutes (30 days).
AuthorizedUuidstringOptionaln/aSingle Uuid which is authorized to use the token to make API requests to PubNub.
ResourcesPNTokenResourcesOptionaln/aObject containing channel, channel group, and UUID metadata permissions.
PatternsPNTokenPatternsOptionaln/aObject containing permissions to apply to all channel, channel group, and UUID metadata matching the RegEx pattern.
MetaDictionary<string, object>Optionaln/aExtra metadata to be published with the request. Values must be scalar only; arrays or objects aren't supported.
ExecutePNCallbackOptionaln/aPNCallback of type PNAccessManagerTokenResult.
ExecuteAsyncNoneOptionaln/aReturns PNResult<PNAccessManagerTokenResult>.

PNTokenResources contains the following properties:

ParameterTypeRequiredDefaultDescription
ChannelsDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing channel permissions.
ChannelGroupsDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing channel group permissions.
UuidsDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing UUID metadata permissions.

PNTokenPatterns contains the following properties:

ParameterTypeRequiredDefaultDescription
ChannelsDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing permissions to apply to all channels matching the RegEx pattern.
ChannelGroupsDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing permissions to apply to all channel groups matching the RegEx pattern.
UuidsDictionary<string, PNTokenAuthValues>Optionaln/aDictionary object containing permissions to apply to all UUID metadata matching the RegEx pattern.

PNTokenAuthValues contains the following properties:

Property NameTypeDescription
ReadboolRead permission. Applies to Subscribe, History, and Presence.
WriteboolWrite permission. Applies to Publish.
ManageboolManage permission. Applies to Channel Groups and Objects.
DeleteboolDelete permission. Applies to History and Objects.
GetboolGet permission. Applies to Objects.
UpdateboolUpdate permission. Applies to Objects.
JoinboolJoin permission. Applies to Objects.
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).

Basic Usage

PNResult<PNAccessManagerTokenResult> grantTokenResponse = await pubnub.GrantToken()
.TTL(15)
.AuthorizedUuid("my-authorized-uuid")
.Resources(new PNTokenResources()
{
Channels = new Dictionary<string, PNTokenAuthValues>() {
{ "my-channel", 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)
{
Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
show all 20 lines

Returns

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

PropertyTypeDescription
ResultPNAccessManagerTokenResultReturns a PNAccessManagerTokenResult object.
StatusPNStatusReturns a PNStatus object.

PNAccessManagerTokenResult contains the following properties:

ParameterTypeRequiredDescription
TokenStringYesCurrent 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.
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 } }}
show all 27 lines

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.

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)
{
Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(grantTokenResult));
}
show all 20 lines

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.
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 } }}
show all 32 lines

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.

Last updated on