PubNub Access Manager (PAM) extends PubNub's existing security framework by allowing developers to create and enforce secure access to channels and channel groups throughout the PubNub Real-Time Network.
As soon as Access Manager is enabled, no pub/sub-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.
Learn more about Access Manager here.
This function establishes access permissions for PubNub Access Manager (PAM) by setting the read
or write
attribute to true
. A grant
with read
or write
set to false
(or not included) will revoke any previous grants with read
or write
set to true
.
Permissions can be applied to any one of three levels:
- Application level privileges are based on
subscribeKey
applying to all associated channels. - Channel level privileges are based on a combination of
subscribeKey
and channel
name. - User level privileges are based on the combination of
subscribeKey
, channel
and auth Key.
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:
- 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. | 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. |
- 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. - User Level - 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.
| If an argument of the grant is not provided, an expected default will be assumed. read and write arguments default to false - no auth Key results in
channel-level grant - no
channel results in application-level grant
|
No Permissions - If no permissions were granted at any of the three levels, the user will be denied access to the PubNub resource and receive a 403 error message. This is the default behavior for a PAM enabled application.
| Note that 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. |
- History: To access historical messages you must grant full
read
access at either the subscribeKey
or channel
level. When a user has the appropriate permissions they can access any data stored. If they do not have access a 403
will be returned by PAM. - Presence: To grant access to Presence for a particular channel name you must also allow
read
and write
access to the presence channel
name which is specified by adding the -pnpres
suffix to the name. Also note that a leave
will fail in the case where a user's grant expires while connected. An HTTP 403
will be returned. - APNS: Standard permissions are required for publishing.
The duration of permission set with grant()
are controlled by setting a time-to-live(ttl
). If a ttl
is not specified it is automatically set to 1440
minutes by default. Once the ttl
associated with an entry in PAM has expired, the read
and write
attributes are immediately set to false
for that entry in the PAM table.
| PAM grant or revoke requests must be less than ~32KB at a time, or the client will return an error. For requests greater than 32KB, break them into smaller batched requests. |
| When the message size exceeds 32KB the server returns the HTTP Error code 500, instead of the correct error code 414. |
| When you init with secretKey , you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels. |
| The limit on the total amount of channels that you can pass at once when using grant() is 200 . |
To Grant Permissions on a Channel
you can use the following method(s) in the JavaScript V4 SDK:
pubnub.grant(
{
channels: [ch1, ch2],
channelGroups: [cg1, cg2],
authKeys: [key1, key2],
ttl: 12313, // 0 for infinite
read: true, // false to disallow
write: true, // false to disallow
manage: true // false to disallow
},
function (status) {
// handle state setting response
}
);
PubNub Access Manager (PAM) extends PubNub's existing security framework by allowing developers to create and enforce secure access to channels and channel groups throughout the PubNub Real-Time Network.
As soon as Access Manager is enabled, no pub/sub-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.
Learn more about Access Manager here.
This function establishes access permissions for PubNub Access Manager (PAM) by setting the read
or write
attribute to true
. A grant
with read
or write
set to false
(or not included) will revoke any previous grants with read
or write
set to true
.
Permissions can be applied to any one of three levels:
- Application level privileges are based on
subscribeKey
applying to all associated channels. - Channel level privileges are based on a combination of
subscribeKey
and channel
name. - User level privileges are based on the combination of
subscribeKey
, channel
and auth Key.
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:
- 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. | 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. |
- 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. - User Level - 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.
| If an argument of the grant is not provided, an expected default will be assumed. read and write arguments default to false - no auth Key results in
channel-level grant - no
channel results in application-level grant
|
No Permissions - If no permissions were granted at any of the three levels, the user will be denied access to the PubNub resource and receive a 403 error message. This is the default behavior for a PAM enabled application.
| Note that 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. |
- History: To access historical messages you must grant full
read
access at either the subscribeKey
or channel
level. When a user has the appropriate permissions they can access any data stored. If they do not have access a 403
will be returned by PAM. - Presence: To grant access to Presence for a particular channel name you must also allow
read
and write
access to the presence channel
name which is specified by adding the -pnpres
suffix to the name. Also note that a leave
will fail in the case where a user's grant expires while connected. An HTTP 403
will be returned. - APNS: Standard permissions are required for publishing.
The duration of permission set with grant()
are controlled by setting a time-to-live(ttl
). If a ttl
is not specified it is automatically set to 1440
minutes by default. Once the ttl
associated with an entry in PAM has expired, the read
and write
attributes are immediately set to false
for that entry in the PAM table.
| PAM grant or revoke requests must be less than ~32KB at a time, or the client will return an error. For requests greater than 32KB, break them into smaller batched requests. |
| When the message size exceeds 32KB the server returns the HTTP Error code 500, instead of the correct error code 414. |
| When you init with secretKey , you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels. |
| The limit on the total amount of channels that you can pass at once when using grant() is 200 . |
To Grant Permissions on a Channel
you can use the following method(s) in the Node.js V4 SDK:
pubnub.grant(
{
channels: [ch1, ch2],
channelGroups: [cg1, cg2],
authKeys: [key1, key2],
ttl: 12313, // 0 for infinite
read: true, // false to disallow
write: true, // false to disallow
manage: true // false to disallow
},
function (status) {
// handle state setting response
}
);
PubNub Access Manager (PAM) extends PubNub's existing security framework by allowing developers to create and enforce secure access to channels and channel groups throughout the PubNub Real-Time Network.
As soon as Access Manager is enabled, no pub/sub-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.
Learn more about Access Manager here.
This function establishes access permissions for PubNub Access Manager (PAM) by setting the read
or write
attribute to true
. A grant
with read
or write
set to false
(or not included) will revoke any previous grants with read
or write
set to true
.
Permissions can be applied to any one of three levels:
- Application level privileges are based on
subscribeKey
applying to all associated channels. - Channel level privileges are based on a combination of
subscribeKey
and channel
name. - User level privileges are based on the combination of
subscribeKey
, channel
and auth Key.
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:
- 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. | 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. |
- 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. - User Level - 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.
| If an argument of the grant is not provided, an expected default will be assumed. read and write arguments default to false - no auth Key results in
channel-level grant - no
channel results in application-level grant
|
No Permissions - If no permissions were granted at any of the three levels, the user will be denied access to the PubNub resource and receive a 403 error message. This is the default behavior for a PAM enabled application.
| Note that 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. |
- History: To access historical messages you must grant full
read
access at either the subscribeKey
or channel
level. When a user has the appropriate permissions they can access any data stored. If they do not have access a 403
will be returned by PAM. - Presence: To grant access to Presence for a particular channel name you must also allow
read
and write
access to the presence channel
name which is specified by adding the -pnpres
suffix to the name. Also note that a leave
will fail in the case where a user's grant expires while connected. An HTTP 403
will be returned. - APNS: Standard permissions are required for publishing.
The duration of permission set with grant()
are controlled by setting a time-to-live(ttl
). If a ttl
is not specified it is automatically set to 1440
minutes by default. Once the ttl
associated with an entry in PAM has expired, the read
and write
attributes are immediately set to false
for that entry in the PAM table.
| PAM grant or revoke requests must be less than ~32KB at a time, or the client will return an error. For requests greater than 32KB, break them into smaller batched requests. |
| When the message size exceeds 32KB the server returns the HTTP Error code 500, instead of the correct error code 414. |
| When you init with secretKey , you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels. |
| The limit on the total amount of channels that you can pass at once when using grant() is 200 . |
To Grant Permissions on a Channel
you can use the following method(s) in the PhoneGap V4 SDK:
pubnub.grant(
{
channels: [ch1, ch2],
channelGroups: [cg1, cg2],
authKeys: [key1, key2],
ttl: 12313, // 0 for infinite
read: true, // false to disallow
write: true, // false to disallow
manage: true // false to disallow
},
function (status) {
// handle state setting response
}
);
Beta Version Available! | A beta release of the PubNub React framework, version 2.0 is now available. You can access it in the v2.0 branch of the react repository. |
PubNub Access Manager (PAM) extends PubNub's existing security framework by allowing developers to create and enforce secure access to channels and channel groups throughout the PubNub Real-Time Network.
As soon as Access Manager is enabled, no pub/sub-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.
Learn more about Access Manager here.
This function establishes access permissions for PubNub Access Manager (PAM) by setting the read
or write
attribute to true
. A grant
with read
or write
set to false
(or not included) will revoke any previous grants with read
or write
set to true
.
Permissions can be applied to any one of three levels:
- Application level privileges are based on
subscribeKey
applying to all associated channels. - Channel level privileges are based on a combination of
subscribeKey
and channel
name. - User level privileges are based on the combination of
subscribeKey
, channel
and auth Key.
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:
- 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. | 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. |
- 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. - User Level - 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.
| If an argument of the grant is not provided, an expected default will be assumed. read and write arguments default to false - no auth Key results in
channel-level grant - no
channel results in application-level grant
|
No Permissions - If no permissions were granted at any of the three levels, the user will be denied access to the PubNub resource and receive a 403 error message. This is the default behavior for a PAM enabled application.
| Note that 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. |
- History: To access historical messages you must grant full
read
access at either the subscribeKey
or channel
level. When a user has the appropriate permissions they can access any data stored. If they do not have access a 403
will be returned by PAM. - Presence: To grant access to Presence for a particular channel name you must also allow
read
and write
access to the presence channel
name which is specified by adding the -pnpres
suffix to the name. Also note that a leave
will fail in the case where a user's grant expires while connected. An HTTP 403
will be returned. - APNS: Standard permissions are required for publishing.
The duration of permission set with grant()
are controlled by setting a time-to-live(ttl
). If a ttl
is not specified it is automatically set to 1440
minutes by default. Once the ttl
associated with an entry in PAM has expired, the read
and write
attributes are immediately set to false
for that entry in the PAM table.
| PAM grant or revoke requests must be less than ~32KB at a time, or the client will return an error. For requests greater than 32KB, break them into smaller batched requests. |
| When the message size exceeds 32KB the server returns the HTTP Error code 500, instead of the correct error code 414. |
| When you init with secretKey , you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels. |
| The limit on the total amount of channels that you can pass at once when using grant() is 200 . |
To Grant Permissions on a Channel
you can use the following method(s) in the React V4 SDK:
pubnub.grant(
{
channels: [ch1, ch2],
channelGroups: [cg1, cg2],
authKeys: [key1, key2],
ttl: 12313, // 0 for infinite
read: true, // false to disallow
write: true, // false to disallow
manage: true // false to disallow
},
function (status) {
// handle state setting response
}
);
PubNub Access Manager (PAM) extends PubNub's existing security framework by allowing developers to create and enforce secure access to channels and channel groups throughout the PubNub Real-Time Network.
As soon as Access Manager is enabled, no pub/sub-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.
Learn more about Access Manager here.
This function establishes access permissions for PubNub Access Manager (PAM) by setting the read
or write
attribute to true
. A grant
with read
or write
set to false
(or not included) will revoke any previous grants with read
or write
set to true
.
Permissions can be applied to any one of three levels:
- Application level privileges are based on
subscribeKey
applying to all associated channels. - Channel level privileges are based on a combination of
subscribeKey
and channel
name. - User level privileges are based on the combination of
subscribeKey
, channel
and auth Key.
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:
- 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. | 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. |
- 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. - User Level - 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.
| If an argument of the grant is not provided, an expected default will be assumed. read and write arguments default to false - no auth Key results in
channel-level grant - no
channel results in application-level grant
|
No Permissions - If no permissions were granted at any of the three levels, the user will be denied access to the PubNub resource and receive a 403 error message. This is the default behavior for a PAM enabled application.
| Note that 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. |
- History: To access historical messages you must grant full
read
access at either the subscribeKey
or channel
level. When a user has the appropriate permissions they can access any data stored. If they do not have access a 403
will be returned by PAM. - Presence: To grant access to Presence for a particular channel name you must also allow
read
and write
access to the presence channel
name which is specified by adding the -pnpres
suffix to the name. Also note that a leave
will fail in the case where a user's grant expires while connected. An HTTP 403
will be returned. - APNS: Standard permissions are required for publishing.
The duration of permission set with grant()
are controlled by setting a time-to-live(ttl
). If a ttl
is not specified it is automatically set to 1440
minutes by default. Once the ttl
associated with an entry in PAM has expired, the read
and write
attributes are immediately set to false
for that entry in the PAM table.
| PAM grant or revoke requests must be less than ~32KB at a time, or the client will return an error. For requests greater than 32KB, break them into smaller batched requests. |
| When the message size exceeds 32KB the server returns the HTTP Error code 500, instead of the correct error code 414. |
| When you init with secretKey , you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels. |
| The limit on the total amount of channels that you can pass at once when using grant() is 200 . |
To Grant Permissions on a Channel
you can use the following method(s) in the Titanium V4 SDK:
pubnub.grant(
{
channels: ['my_channel'],
authKeys: ['my_rw_authkey'],
read: true,
write: true,
ttl: 5
},
function (status) {
// handle state setting response
}
);
PubNub Access Manager (PAM) extends PubNub's existing security framework by allowing developers to create and enforce secure access to channels and channel groups throughout the PubNub Real-Time Network.
As soon as Access Manager is enabled, no pub/sub-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.
Learn more about Access Manager here.
This function establishes access permissions for PubNub Access Manager (PAM) by setting the read
or write
attribute to true
. A grant
with read
or write
set to false
(or not included) will revoke any previous grants with read
or write
set to true
.
Permissions can be applied to any one of three levels:
- Application level privileges are based on
subscribeKey
applying to all associated channels. - Channel level privileges are based on a combination of
subscribeKey
and channel
name. - User level privileges are based on the combination of
subscribeKey
, channel
and auth Key.
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:
- 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. | 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. |
- 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. - User Level - 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.
| If an argument of the grant is not provided, an expected default will be assumed. read and write arguments default to false - no auth Key results in
channel-level grant - no
channel results in application-level grant
|
No Permissions - If no permissions were granted at any of the three levels, the user will be denied access to the PubNub resource and receive a 403 error message. This is the default behavior for a PAM enabled application.
| Note that 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. |
- History: To access historical messages you must grant full
read
access at either the subscribeKey
or channel
level. When a user has the appropriate permissions they can access any data stored. If they do not have access a 403
will be returned by PAM. - Presence: To grant access to Presence for a particular channel name you must also allow
read
and write
access to the presence channel
name which is specified by adding the -pnpres
suffix to the name. Also note that a leave
will fail in the case where a user's grant expires while connected. An HTTP 403
will be returned. - APNS: Standard permissions are required for publishing.
The duration of permission set with grant()
are controlled by setting a time-to-live(ttl
). If a ttl
is not specified it is automatically set to 1440
minutes by default. Once the ttl
associated with an entry in PAM has expired, the read
and write
attributes are immediately set to false
for that entry in the PAM table.
| PAM grant or revoke requests must be less than ~32KB at a time, or the client will return an error. For requests greater than 32KB, break them into smaller batched requests. |
| When the message size exceeds 32KB the server returns the HTTP Error code 500, instead of the correct error code 414. |
| When you init with secretKey , you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels. |
| The limit on the total amount of channels that you can pass at once when using grant() is 200 . |
To Grant Permissions on a Channel
you can use the following method(s) in the Vue V4 SDK:
import PubNubVue from 'pubnub-vue';
const pubnub = PubNubVue.getInstance();
pubnub.grant(
{
channels: [ch1, ch2],
channelGroups: [cg1, cg2],
authKeys: [key1, key2],
ttl: 12313, // 0 for infinite
read: true, // false to disallow
write: true, // false to disallow
manage: true// false to disallow
},
function(status) {
// handle state setting response
}
);