On this page

Access Manager v3 API for Windows C SDK

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 before deploying to production.

Access Manager allows you to enforce security controls for client access to resources within the PubNub Platform. With Access Manager v3, your servers (that use a PubNub instance configured with a secret key) 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 author_uuid parameter to the grant request to restrict the token usage to only one client with a given UUID. Only this author_uuid can use the token to make API requests for the specified resources and permissions.

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.

Requires Secret Key authentication

Granting permissions to resources should be done by administrators whose SDK instance has been initialized with a Secret Key (available on the Admin Portal on your app's keyset).

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

channels
groups
uuids (other users' object metadata, such as their names or avatars)

Only this author_uuid 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_minutes expires. Any unauthorized request or a request made with an invalid token will return a 403 with a respective error message.

Permissions
TTL (time to live)
RegEx patterns
Authorized UUID

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`
`groups`	`read`, `manage`
`uuids`	`get`, `update`, `delete`

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

The ttl_minutes (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_minutes is required for every grant call. There is no default value. The maximum value is 43,200 (30 days).

For more details, see TTL in Access Manager v3.

Setting an author_uuid in the token specifies which client should use this token in every request to PubNub. If you do not set author_uuid during the grant request, the token can be used by any client with any UUID. Restrict tokens to a single author_uuid to prevent impersonation.

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

Method(s)

1enum pubnub_res pubnub_grant_token(pubnub_t* pb, char const* perm_obj)

* required

Parameter	Description
`pb` * Type: `pubnub_t*`	Pointer to the PubNub context. Can't be NULL.
`perm_obj` * Type: `const char*`	Pointer to `string` with the permissions.

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

1struct pam_permission ch_perm = {.read=true };
2int perm_my_channel = pubnub_get_grant_bit_mask_value(ch_perm);
3int ttl_minutes = 15; // Max value for ttl_minutes is 43,200 minutes (30 days)
4char perm_obj[2000];
5char* author_uuid = "my_author_uuid";
6sprintf(perm_obj,"{\"ttl\":%d, \"uuid\":\"%s\", \"permissions\":{\"resources\":{\"channels\":{ \"my_channel\":%d }, \"groups\":{}, \"users\":{ }, \"spaces\":{}}, \"patterns\":{\"channels\":{}, \"groups\":{}, \"users\":{}, \"spaces\":{}},\"meta\":{}}}", ttl_minutes, author_uuid, perm_my_channel);
7res = pubnub_grant_token(gtp, perm_obj);
8if (PNR_STARTED == res) {
9res = pubnub_await(gtp);
10if (PNR_OK == res) {
11   pubnub_chamebl_t grant_token_resp = pubnub_get_grant_token(gtp);
12   printf("pubnub_grant_token() Response from Pubnub: %s\n", grant_token_resp.ptr);
13}
14}

Returns

1{"data":{"message":"Success","token":"p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI"},"service":"Access Manager","status":200}

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.

1char* author_uuid = "my-authorized-uuid";
2struct pam_permission cha_perm = {.read=true };
3struct pam_permission cgb_perm = {.read=true };
4struct pam_permission uidc_perm = {.get=true };
5

6struct pam_permission chb_perm = {.read=true, .write=true };
7struct pam_permission chc_perm = {.read=true, .write=true };
8struct pam_permission chd_perm = {.read=true, .write=true };
9struct pam_permission uidd_perm = {.get=true, .update=true };
10

11int perm_cha = pubnub_get_grant_bit_mask_value(cha_perm);
12int perm_chb = pubnub_get_grant_bit_mask_value(chb_perm);
13int perm_chc = pubnub_get_grant_bit_mask_value(chc_perm);
14int perm_chd = pubnub_get_grant_bit_mask_value(chd_perm);
15

16int perm_cgb = pubnub_get_grant_bit_mask_value(cgb_perm);
17

18int perm_uidc = pubnub_get_grant_bit_mask_value(uidc_perm);
19int perm_uidd = pubnub_get_grant_bit_mask_value(uidd_perm);
20

21int ttl_minutes = 15;
22char perm_obj[2000];
23sprintf(perm_obj,"{\"ttl\":%d, \"uuid\":\"%s\", \"permissions\":{\"resources\":{\"channels\":{ \"channel-a\":%d, \"channel-b\":%d, \"channel-c\":%d, \"channel-d\":%d }, \"groups\":{ \"channel-group-b\":%d }, \"uuids\":{ \"uuid-c\":%d, \"uuid-d\":%d }}, \"patterns\":{\"channels\":{ }, \"groups\":{ }, \"uuids\":{ }},\"meta\":{ }}}", ttl_minutes, author_uuid, perm_cha, perm_chb, perm_chc, perm_chd, perm_cgb, perm_uidc, perm_uidd);
24res = pubnub_grant_token(gtp, perm_obj);
25if (PNR_STARTED == res) {
26res = pubnub_await(gtp);
27if (PNR_OK == res) {
28   pubnub_chamebl_t grant_token_resp = pubnub_get_grant_token(gtp);
29   printf("pubnub_grant_token() Response from Pubnub: %s\n", grant_token_resp.ptr);
30}
31}
show all 31 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.

1char* author_uuid = "my-authorized-uuid";
2struct pam_permission pat_ch_perm = {.read=true };
3

4int perm_ch_pat = pubnub_get_grant_bit_mask_value(pat_ch_perm);
5

6int ttl_minutes = 15;
7char perm_obj[2000];
8sprintf(perm_obj,"{\"ttl\":%d, \"uuid\":\"%s\", \"permissions\":{\"resources\":{\"channels\":{ }, \"groups\":{ }, \"uuids\":{ }}, \"patterns\":{\"channels\":{ \"channel-[A-Za-z0-9]\":%d }, \"groups\":{ }, \"uuids\":{ }},\"meta\":{ }}}", ttl_minutes, author_uuid, perm_ch_pat);
9res = pubnub_grant_token(gtp, perm_obj);
10if (PNR_STARTED == res) {
11res = pubnub_await(gtp);
12if (PNR_OK == res) {
13   pubnub_chamebl_t grant_token_resp = pubnub_get_grant_token(gtp);
14   printf("pubnub_grant_token() Response from Pubnub: %s\n", grant_token_resp.ptr);
15}
16}
show all 16 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.

1char* author_uuid = "my-authorized-uuid";
2struct pam_permission cha_perm = {.read=true };
3struct pam_permission cgb_perm = {.read=true };
4struct pam_permission uidc_perm = {.get=true };
5

6struct pam_permission chb_perm = {.read=true, .write=true };
7struct pam_permission chc_perm = {.read=true, .write=true };
8struct pam_permission chd_perm = {.read=true, .write=true };
9struct pam_permission uidd_perm = {.get=true, .update=true };
10

11struct pam_permission pat_ch_perm = {.read=true };
12

13int perm_cha = pubnub_get_grant_bit_mask_value(cha_perm);
14int perm_chb = pubnub_get_grant_bit_mask_value(chb_perm);
15int perm_chc = pubnub_get_grant_bit_mask_value(chc_perm);
16int perm_chd = pubnub_get_grant_bit_mask_value(chd_perm);
17

18int perm_cgb = pubnub_get_grant_bit_mask_value(cgb_perm);
19

20int perm_uidc = pubnub_get_grant_bit_mask_value(uidc_perm);
21int perm_uidd = pubnub_get_grant_bit_mask_value(uidd_perm);
22

23int perm_ch_pat = pubnub_get_grant_bit_mask_value(pat_ch_perm);
24

25int ttl_minutes = 15;
26char perm_obj[2000];
27sprintf(perm_obj,"{\"ttl\":%d, \"uuid\":\"%s\", \"permissions\":{\"resources\":{\"channels\":{ \"channel-a\":%d, \"channel-b\":%d, \"channel-c\":%d, \"channel-d\":%d }, \"groups\":{ \"channel-group-b\":%d }, \"uuids\":{ \"uuid-c\":%d, \"uuid-d\":%d }}, \"patterns\":{\"channels\":{ \"channel-[A-Za-z0-9]\":%d }, \"groups\":{ }, \"uuids\":{ }},\"meta\":{ }}}", ttl_minutes, author_uuid, perm_cha, perm_chb, perm_chc, perm_chd, perm_cgb, perm_uidc, perm_uidd, perm_ch_pat);
28res = pubnub_grant_token(gtp, perm_obj);
29if (PNR_STARTED == res) {
30res = pubnub_await(gtp);
31if (PNR_OK == res) {
32   pubnub_chamebl_t grant_token_resp = pubnub_get_grant_token(gtp);
33   printf("pubnub_grant_token() Response from Pubnub: %s\n", grant_token_resp.ptr);
34}
35}
show all 35 lines

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

Parse token

The pubnub_parse_token() 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_minutes details.

Method(s)

1char* pubnub_parse_token(pubnub_t* pb, char const* token)

* required

Parameter	Description
`pb` * Type: `pubnub_t*`	Pointer to the PubNub context. Can't be NULL.
`token` * Type: `const char*`	Current token with embedded permissions.

Sample code

1char* cbor_data = pubnub_parse_token(<pubnub_context>, "p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI");

Returns

1{
 "version":2,
 "timestamp":1619718521,
 "ttl":15,
 "resources":{
    "user-id":{
       "create":true,
       "read":true,
       "write":true,
       "manage":true,
       "delete":true
    },
    "space-id":{
       "create":true,
       "read":true,
       "write":true,
       "manage":true,
       "delete":true
    },
    "channel-id":{
       "create":true,
       "read":true,
       "write":true,
       "manage":true,
       "delete":true
    },
    "group-id":{
       "create":true,
       "read":true,
       "write":true,
       "manage":true,
       "delete":true
    }
 },
 "patterns":{
    "user-pattern":{
       "create":true,
       "read":true,
       "write":true,
       "manage":true,
       "delete":true
    },
    "space-pattern":{
       "create":true,
       "read":true,
       "write":true,
       "manage":true,
       "delete":true
    },
    "channel-pattern":{
       "create":true,
       "read":true,
       "write":true,
       "manage":true,
       "delete":true
    },
    "group-pattern":{
       "create":true,
       "read":true,
       "write":true,
    }
 }
63}
show all 63 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 pubnub_set_auth_token() method is used by the client devices to update the authentication token granted by the server.

Method(s)

1void pubnub_set_auth_token(pubnub_t* pb, char const* token)

* required

Parameter	Description
`pb` * Type: `pubnub_t*`	Pointer to the PubNub context. Can't be NULL.
`token` * Type: `const char*`	Current token with embedded permissions.

Sample code

1pubnub.pubnub_set_token(<pubnub_context>, "p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Returns

This method doesn't return any response value.

Access Manager isn't enabled by default

Grant token​

Requires Access Manager add-on

Requires Secret Key authentication

Method(s)​

Required key/value mappings

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​

Parse token​

Method(s)​

Sample code​

Returns​

Error Responses​

Set token​

Method(s)​

Sample code​

Returns​

Grant token

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

Parse token

Method(s)

Sample code

Returns

Error Responses

Set token

Method(s)

Sample code

Returns