JavaScriptWebWebNode.jsPhoneGapReactReduxTitaniumVueJavaScript V4 Access Manager API Reference for Realtime Apps

PubNub Access Manager (PAM) allows you to enforce secure controls for client access to resources within the PubNub network. With PAM, your servers can grant their clients access to individual PubNub resources for a limited duration, with the ability to extend access or add permissions for additional resources.

As soon as PAM is enabled, no publish/subscribe operations can be done without first explicitly providing an authorization token to the PubNub object. If an invalid token is provided, the requesting client will receive a Forbidden error.

For more information about PAM, refer to Managing Permissions with Access Manager.


Requires Access Manager add-on XRequires that the Access Manager add-on is enabled for your key. See this page on enabling add-on features on your keys:

https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-.
The grant method allows you to grant permissions for one or more resources to one or more authKeys. You may need to make multiple grant calls with an authKey so that you can specify explicit permissions for each channel, channelGroup and uuid resources. For common permissions, you can normally use a single request.

Privileges specifically granted to an application's subscribeKey always take precedence over privileges granted to channel or auth Key. Therefore an application that requires authentication at the user level should not grant access at either the Application or Channel levels. View the Grant Levels section for more details.

The grant request allows your server to securely grant access for your clients on the following resources within the platform. Each resource allows a limited set of permissions that control the operations that can be performed by the clients. For permissions and API operations mapping information, refer to Managing Permissions with Access Manager.

ResourcePermissions
channelread, write, get, manage, update, join, delete
uuidget, update, delete
channelGroupread, manage

To make granting access on multiple channels and channel groups more efficient, you can use the wildcard notation. It doesn't, however, apply to the uuid resource and you can only go one level deep using wildcards.

  • * grants access on all channels
  • a.* grants access on all channels that begin with `a.`
  • a.b.* doesn't work. If you grant on a.b.*, the grant treats `a.b.*` as a channel name, not a wildcard
When a user attempts to access a PubNub resource, PAM will evaluate any existing rules using the following order of precedence before access to a channel is granted to the user:
  1. Application Level - PAM privileges are always evaluated first at the Application level. If either read or write attribute is set to true for a subscribeKey, PAM will immediately grant access for that attribute without proceeding to check permissions at either Channel or User levels. If an attribute is set to false at the Application level, PAM proceeds to evaluate the attribute at the next most granular level.
  2. Channel Level - After first verifying an attribute at the Application level, PAM evaluates the attribute at the Channel level. If an attribute is set to true for a combination of subscribeKey, and channel, PAM grants access for that attribute at the Channel level without proceeding to check whether there may be user level permissions.
  3. User Level (Recommended) - As a final step PAM evaluates the attributes at the User level. If an attribute is set to true for subscribeKey, channel and auth Key, access is granted for that attribute. Similarly, user level grants also allow you granting an auth Key access to channelGroups and uuids. User level grants require authKeys and are the recommended approach if you need to manage permissions for individual users within your application. Each user should be assigned a unique auth Key and securely passed back to the user to perform operations on the platform.
To Grant Permissions on a Channel you can use the following method(s) in the JavaScript V4 SDK
  1. ParameterTypeRequiredDefaultsDescription
    authKeysArrayOptional 

    Specifies authKey to grant permissions. It is possible to specify multiple auth keys as comma separated list in combination with a single channel name.


    authKeys are required for user-level grants. If you don’t specify an authKey, the permissions will apply to all clients on channel-level or application-level. View the Grant Levels section for more details.

    channelsArraySpecifying either channels, channelGroups or uuids is mandatory. 

    Specifies up to 200 channels on which to grant permissions. Either channels, channelGroups or uuids are required.

    channelGroups ArraySpecifying either channels, channelGroups or uuids is mandatory. 

    Specifies up to 200 channel groups on which to grant permissions. Either channels, channelGroups or uuids are required.

    uuids ArrayOptional 

    Specifies up to 200 uuids on which to grant permissions. Either channels, channelGroups or uuids are required.
     

    You can't grant permissions to channels and channel groups in the same request if you decide to use uuids.

    This parameter does not support wildcards.

    ttl NumberYes1440 (24hrs)

    Time in minutes for which granted permissions are valid. Default is 1440 (24hrs), Max is 525600 , Min is 1. Setting ttl to 0 will apply the grant indefinitely.

    read BooleanOptionalfalse

    Set to true to grant read permissions. Set to false to remove permissions.

    write BooleanOptionalfalse

    Set to true to grant write permissions. Set to false to remove permissions.

    manageBooleanOptionalfalse

    Set to true to grant manage permissions. Set to false to remove permissions.

    deleteBooleanOptionalfalse

    Set to true to grant delete permissions. Set to false to remove permissions.

    getBooleanOptionalfalse

    Set to true to grant get permissions. Set to false to remove permissions.

    updateBooleanOptionalfalse

    Set to true to grant update permissions. Set to false to remove permissions.

    joinBooleanOptionalfalse

    Set to true to grant join permissions. Set to false to remove permissions.

    callbackFunctionOptional 

    Executes on a successful/unsuccessful grant.

pubnub.grant(
    {
        authKeys: ['my_authkey'],
        channels: ['my_channel'],
        ttl: 12313, // 0 for infinite
        read: true, // false to disallow
        write: true, // false to disallow
        manage: true, // false to disallow
        delete: true // false to disallow
    },
    function (status) {
        // handle state setting response
    }
);
{
    "status" : 200,
    "message" : "Success",
    "payload" : {
        "ttl" : 1440,
        "auths" : {
            "my_authkey" : {
                "r" : 1,
                "w" : 1,
                "m" : 1,
                "d" : 1,
                "g" : 0,
                "u" : 0,
                "j" : 0
            }
        },
        "subscribe_key" : "my_subkey",
        "level" : "user",
        "channel" : "my_channel"
    },
    "service" : "Access Manager"
}
 
PAM grant or revoke requests must be less than ~32KiB at a time, or the client will return an error. For requests greater than 32KiB, break them into smaller batched requests. When the message size exceeds 32KiB the server returns the HTTP Error code 500, instead of the correct error code 414.
 
For NTP synchronization, please ensure that you have configured NTP on your server to keep the clock in sync. This is to prevent system clock drift leading to 400 Invalid Timestamp error response.
https://support.pubnub.com/hc/en-us/articles/360051973331-Why-do-I-get-Invalid-Timestamp-when-I-try-to-grant-permission-using-Access-Manager-
  1. Grant read permission to a channel only for clients with a specific authKey with a 5 minute ttl:

    pubnub.grant(
        {
            authKeys: ['my_authkey'],
            channels: ['my_channel'],
            read: true, // false to disallow
            write: false // false to disallow
        },
        function (status) {
            console.log(status);
        }
    );
  2. Grant read and write permissions to anc authKey on a presence channel with a 5 minute ttl:

    pubnub.grant(
        {
            authKeys: ['my_authkey'],
            channels: ['my_channel-pnpres'],
            read: true, // false to disallow
            write: true // false to disallow
        },
        function (status) {
            console.log(status);
        }
    );
  3. Allow a user access to all channel groups using a wildcard.

    To perform a first level wildcard grant for channel groups you need to specify : (colon) as the parameter for channelGroups. This ensures that users can read or manage all channel groups.

    pubnub.grant(
        {
            authKeys: ['my_authkey'],
            channelGroups: [':'],
            read: true, 
            manage: true
        },
        function (status) {
            console.log(status);
        }
    );
  4. Grant get, update, and delete access to a uuid only for clients with a specific authKey with a 24 hour ttl:

    pubnub.grant(
        {
            authKeys: ['key1'],
            uuids: ['uuid1'],
            ttl: 1440, // 0 for infinite
            get: true, // false to disallow
            update: true, // false to disallow
            delete: true // false to disallow
        },
        function (status) {
            console.log(status);
        }
    );
    
  5. This request grants read permission to all users on all channel(s) with default ttl (1440 minutes). This rule applies on the application level and takes precedence over channel and user-level permissions.

     

    Use application level grants with caution

    When access is granted on an application level, all channels and users will have access.

    Application level grants can also happen due to a bug in your code. e.g. Null parameters for channels and auth-keys can cause accidental application level grants.

    pubnub.grant({
        read: true
    });
    
  6. This request grants read and write permissions to a specific channel for all users (no authKey required) with default ttl (1440 minutes). This rule applies on the channel level and takes precedence over user-level permissions.

    pubnub.grant(
        {
            channels: ['my_channel'],
            read: true, // false to disallow
            write: true // false to disallow
        },
        function (status) {
            console.log(status);
        }
    );