Access Manager v2 API for Ruby SDK

Access Manager allows you to enforce secure controls for client access to resources within the PubNub network. With Access Manager, 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 Access Manager 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 Access Manager, refer to Managing Permissions with Access Manager.

Grant

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

Permissions

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.

Resource	Permissions
`channel`	`read`, `write`, `get`, `manage`, `update`, `join`, `delete`
`uuid`	`get`, `update`, `delete`
`channelGroup`	`read`, `manage`

Wildcard permissions

Wildcard notation allows you to grant permissions to multiple channels at a time and later revoke these permissions in the same manner. You can only go one level deep using wildcards. In other words:

a.* grants access on all channels that begin with a..
* or a.b.* won't work this way. If you grant on * or a.b.*, the grant treats * or a.b.* as a channel name, not a wildcard.

Wildcard revokes

You can revoke permissions with wildcards from one level deep, like a.*, only when you initially used wildcards to grant permissions to a.*.

Grant levels

When a user attempts to access a PubNub resource, Access Manager will evaluate any existing rules using the following order of precedence before access to a channel is granted to the user:

Application Level - Access Manager privileges are always evaluated first at the Application level. If either read or write attribute is set to True for a subscribe_key, Access Manager 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, Access Manager proceeds to evaluate the attribute at the next most granular level.
Channel Level - After first verifying an attribute at the Application level, Access Manager evaluates the attribute at the Channel level. If an attribute is set to True for a combination of subscribe_key, and channel, Access Manager grants access for that attribute at the Channel level without proceeding to check whether there may be user level permissions.
User Level (Recommended) - As a final step Access Manager evaluates the attributes at the User level. If an attribute is set to True for subscribe_key, 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 auth_key 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.

Method(s)

To Grant Permissions on a Channel you can use the following method(s) in the Ruby SDK:

grant(channels: channels, channel_groups: channel_groups, uuids: uuids, auth_key: auth_key, read: read, write: write, get: get, manage: manage, update: update, join: join, delete: delete, ttl: ttl, http_sync: http_sync, callback: callback)

* required

Parameter	Description
`channels` Type: String, Symbol, comma separated list	Specifies the `channels` on which to `grant` permissions. If no `channels/channelGroups` are specified, then the `grant` applies to any and all `channels/channelGroups` that have been or will be created for that `publish/subscribe` key set. Furthermore, any existing or future grants on specific `channels` are ignored, until the `all channels` grant is revoked. It is possible to `grant` permissions to multiple `channels` simultaneously by specifying the `channels` as a comma separated list. Wildcard notation like `a.` can be used to `grant` access on channels. You can `grant` one level deep. `a.` - you can grant on this. `` and `a.b.` - grant will not work on these levels. If you grant on `` or `a.b.`, the grant will treat `` or `a.b.` as a single channel named either `` or `a.b.`.
`channel_groups` Type: String, Symbol, comma separated list	Specifies the `channelGroups` to `grant` permissions. If no `channels/channelGroups` are specified, then the `grant` applies to any and all `channels/channelGroups` that have been or will be created for that `publish/subscribe` key set. Furthermore, any existing or future grants on specific `channelGroups` are ignored, until the `all channelGroups` grant is revoked. It is possible to `grant` permissions to multiple `channelGroups` simultaneously by specifying the `channelGroups` as a comma separated list. This parameter does not support wildcards.
`uuids` Type: String, Symbol, comma-separated list	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.
`auth_key` Type: String, Symbol	Specifies `auth` Key to grant permissions. It is possible to specify multiple `auth` keys as comma separated list in combination with a single `channel` name. You can also grant access to a single `auth` key for multiple `channels` at the same time. Zero or more `channels` with zero or more `auth` tokens are allowed.
`read` Type: Boolean	`Read` permissions.Default: `true`.
`write` Type: Boolean	`Write` permissions.Default: `true`.
`manage` Type: Boolean	`Manage` permissions.Default: `true`.
`delete` Type: Boolean	`Delete` permissions.Default: `false`.
`get` Type: Boolean	`Get` permissions.Default: `false`.
`update` Type: Boolean	`Update` permissions.Default: `false`.
`join` Type: Boolean	`Join` permissions.Default: `false`.
`ttl` Type: Integer	Time in minutes for which granted permissions are valid. The default value is `1440 (24hrs)` and the allowed values range from `1` to `525600`. If you set `ttl` to `0`, it will apply the grant indefinitely.
`http_sync` Type: Boolean	Default `false`. Method will be executed `asynchronously` and will return future, to get it's `value` you can use `value` method. If set to `true`, method returns an array of envelopes (even if there's only one `envelope`). For `sync` methods `Envelope` object will be returned.
`callback` Type: Lambda accepting one parameter	`Callback` that will be called for each `envelope`. For `async` methods future will be returned, to retrieve `value` `Envelope` object you have to call `value` method (thread will be locked until the `value` is returned).

Sample code

Grant Access Manager permissions for channel and auth_key

pubnub.grant(channels: 'my_channel', ttl: 5, auth_key: 'my_rw_authkey') do |envelope|
    puts envelope
end

Response

#<Pubnub::Envelope:0x007fd384d2c288
    @result = {
        :code => 200,
        :data => {
            "level" => "user",
            "subscribe_key" => "sub-c-5f595120-6fe1-11e7-9980-0619f8945a4f",
            "ttl" => 1440,
            "channel" => "whatever",
            "auths" => {
                "someuser" => {
                    "r" => 1,
                    "w" => 1,
                    "m" => 1
                }
            }
show all 21 lines

Requests size

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

NTP configuration

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. Read more in the support article.

Other examples

pubnub.grant(ttl: 60, write: false) do |envelope|
    puts envelope
end

pubnub.grant(channels: 'my_channel') do |envelope|
    puts envelope
end

pubnub.grant(channels: 'my_channel', ttl: 5, auth_key: 'my_ro_authkey', read:true, write: false) do |envelope|
    puts envelope
end

The above code would return the following response to the client:

#<Pubnub::Envelope:0x007fd384d671a8
    @result = {
        :code => 200,
        :data => {
            "level" => "user",
            "subscribe_key" => "sub-c-5f595120-6fe1-11e7-9980-0619f8945a4f",
            "ttl" => 5,
            "channel" => "my_channel",
            "auths" => {
                "my_ro_authkey" => {
                    "r" => 1,
                    "w" => 0,
                    "m" => 1
                }
            }
show all 21 lines

Allow access to a specific channel for Presence

pubnub.grant(presence: 'my_channel') do |envelope|
    puts envelope
end

Allow get and update access to a UUID only for clients with specific auth_keys with a 24 hr ttl

pubnub.grant(uuids: 'my_uuid', ttl: 1440, auth_key: 'my_ro_authkey', get: true, update: true) do |envelope|
    puts envelope
end

Grant to multiple channels

pubnub.grant(channels: 'ch1,ch2,ch3,', ttl: 60, auth_key: 'my_auth_key', read: true) do |envelope|
    puts envelope
end

Application Level Grant

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. For example, Null parameters for channels and auth-keys can cause accidental application level grants.
```
# Create PubNub client
pubnub = Pubnub.new(
    publish_key: 'pub-c-',
    subscribe_key: 'sub-c-',
    secret_key: 'sec-c-'
)

# Additional optional parameters for grant, see: http://www.pubnub.com/docs/sdks/ruby/api-reference/access-manager#grant_arg_1

pubnub.grant(http_sync: true)
```

Channel Level Grant

# Create PubNub client
pubnub = Pubnub.new(
    publish_key: 'pub-c-',
    subscribe_key: 'sub-c-',
    secret_key: 'sec-c-'
)

# Additional optional parameters for grant, see: http://www.pubnub.com/docs/sdks/ruby/api-reference/access-manager#grant_arg_1

pubnub.grant(channels: 'open-channel', http_sync: true)

User Level Grant

# Create PubNub client
pubnub = Pubnub.new(
    publish_key: 'pub-c-',
    subscribe_key: 'sub-c-',
    secret_key: 'sec-c-'
)

# Additional optional parameters for grant, see: http://www.pubnub.com/docs/sdks/ruby/api-reference/access-manager#grant_arg_1

pubnub.grant(channels: 'private-channel', auth_key: 'authorized-user', http_sync: true)

Grant​

Requires Access Manager add-on

Permissions​

Wildcard permissions​

Wildcard revokes

Grant levels​

Method(s)​

Sample code​

Grant Access Manager permissions for channel and auth_key​

Response​

Requests size

NTP configuration

Other examples​

Grant subscribe privileges to all users on all channel(s) with default ttl (1440 minutes)​

Allow subscribe and publish to a specific channel for all users (no auth_key required) with default ttl (1440 minutes)​

Grant subscribe access to a channel only for clients with a specific auth_key with a 5 minute ttl​

Allow access to a specific channel for Presence​

Allow get and update access to a UUID only for clients with specific auth_keys with a 24 hr ttl​

Grant to multiple channels​

Use application level grants with caution