Access Manager v2 API for PHP 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. See Enable the features your app calls.
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.
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 |
category (channels, uuids) | get only |
In grant(), categories() selects the channels and uuids categories.
- A category permission lets a token list all metadata of one resource type on your subscribe key. Valid categories are
channelsanduuids. The only permission isget(32). - A
getpermission on one named channel or user, or on a pattern, does not grant a category. - A token can contain only categories. It needs no resource or pattern.
- When enumeration enforcement is enabled for a keyset, App Context list requests from a token or auth key without the matching category permission return a
403error.
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 witha..*ora.b.*won't work this way. If you grant on*ora.b.*, the grant treats*ora.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
Applicationlevel. If eitherreadorwriteattribute is set totruefor asubscribeKey, Access Manager will immediately grant access for that attribute without proceeding to check permissions at eitherChannelorUserlevels. If an attribute is set tofalseat 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
truefor a combination ofsubscribeKey, andchannel, Access Manager grants access for that attribute at theChannellevel without proceeding to check whether there may beuserlevel permissions. - User Level (Recommended) - As a final step Access Manager evaluates the attributes at the
Userlevel. If an attribute is set totrueforsubscribeKey,channelandauth_key, access is granted for that attribute. Similarly, user level grants also allow you granting anauth_keyaccess tochannelGroupsanduuids. User level grants requireauth_keyand are the recommended approach if you need to manage permissions for individual users within your application. Each user should be assigned a uniqueauth_keyand securely passed back to the user to perform operations on the platform.
Method(s)
To Grant Permissions on a Channel using the builder pattern, you can use the following method(s) in the PHP SDK:
1grant()
2 ->authKeys(String | Array[String] )
3 ->channels( String | Array[String] )
4 ->channelGroups( Array[String] )
5 ->categories( String | Array[String] )
6 ->ttl(integer | null )
7 ->read(boolean)
8 ->write(boolean)
9 ->manage(boolean)
10 ->delete(boolean
11 ->get(boolean)
12 ->update(boolean)
13 ->join(boolean)
authKeys()required#- Specifies
authKey to grant permissions. It is possible to specify multipleauthkeys as comma separated list in combination with a singlechannelname. You can also grant access to a singleauthkey for multiplechannelsat the same time. Zero or morechannelswith zero or moreauthtokens are allowed. channels()#- Specifies the
channelson which tograntpermissions. If nochannels/channelGroupsare specified, then thegrantapplies to any and allchannels/channelGroupsthat have been or will be created for thatpublish/subscribekey set. Furthermore, any existing or future grants on specificchannelsare ignored, until theall channelsgrant is revoked. It is possible tograntpermissions to multiplechannelssimultaneously by specifying thechannelsas a comma separated list. Wildcard notation likea.*can be used tograntaccess on channels. You cangrantone level deep.a.*- you can grant on this.*anda.b.*- grant will not work on these levels. If you grant on*ora.b.*, the grant will treat*ora.b.*as a single channel named either*ora.b.*.
uuids()#- Specifies a list of
uuidson which to grant permissions.
You can't grant permissions to channels and channel groups in the same request if you decide to useuuids.
This parameter does not support wildcards. channelGroups()#- Specifies up to 200 channel groups on which to grant permissions. If you set none of
channels,channelGroups,uuids, orcategories, the grant applies to the whole keyset.
This parameter does not support wildcards. categories()#- Specifies the categories to grant. Use
PNGrantCategory::CHANNELSto list all channel metadata andPNGrantCategory::UUIDSto list all uuid metadata. Agetpermission on a named channel or uuid doesn't imply this. RequiresauthKeys()andget(). Refer to Category permissions. ttl()required#Timein minutes for which granted permissions are valid. Max : 525600 Min : 1 Setting 0 will apply the grant indefinitely (forever grant).read()required#Readpermissions are granted by setting toTrue.Readpermissions are removed by setting toFalse.write()required#Writepermissions are granted by setting totrue.Writepermissions are removed by setting tofalse.manage()required#Managepermissions are granted by setting to True.Managepermissions are removed by setting to False.delete()required#Deletepermissions are granted by setting to True.Deletepermissions are removed by setting to False.get()required#Getpermissions are granted by setting to True.Getpermissions are removed by setting to False.update()required#Updatepermissions are granted by setting to True.Updatepermissions are removed by setting to False.join()required#Joinpermissions are granted by setting to True.Joinpermissions are removed by setting to False.
Category permissions
- A category permission lets a token list all metadata of one resource type on your subscribe key. Valid categories are
channelsanduuids. The only permission isget(32). - A
getpermission on one named channel or user, or on a pattern, does not grant a category. - A token can contain only categories. It needs no resource or pattern.
- When enumeration enforcement is enabled for a keyset, App Context list requests from a token or auth key without the matching category permission return a
403error.
When you call categories():
- Call
get(true)to grant the category. Callget(false)with the samecategories()andauthKeys()to revoke it. - The SDK leaves out every permission you don't set.
- The server returns a
400error for a category grant withgetset totrueand attlof1. The SDK doesn't check this before sending. - The
getpermission also applies to every channel, channel group, and uuid in the same request, because all resources in a request share one set of permissions. - Don't set
read(),write(),manage(),delete(),update(), orjoin()totrue.
grant() throws a PubNubValidationException before the SDK sends the request in these cases:
| Cause | Error message |
|---|---|
categories() contains a value other than channels or uuids. | Unsupported category "<name>", expected one of: channels, uuids |
authKeys() is missing or holds only empty values. | Category grants require at least one auth key |
read(), write(), manage(), delete(), update(), or join() is true. | Only the get permission is allowed for categories |
get() isn't called. | Category grants need get(true) to grant or get(false) to revoke |
Sample code
Grant Access Manager permissions for channel and AuthKey
1
Returns
The grant() operation returns a PNAccessManagerGrantResult which contains the following fields:
getLevel()#- Permissions level, one of Subscribe key, Subscribe key+auth, channel, channel-group, channel-group + auth level.
getTtl()#- Time to live value.
getSubscribeKey()#- The subscribe key.
getChannels()#- Access rights per channel. See
PNAccessManagerChannelDatabelow for more details. getChannelGroups()#- Access rights per channel. See
PNAccessManagerChannelGroupDatabelow for more details. getUsers()#- Access rights per channel. See
PNAccessManagerUserDatabelow for more details. getCategories()#- Category-level access rights, keyed
channelsanduuids. SeePNAccessManagerCategoryDatabelow for more details. Empty unless you setcategories(). isReadEnabled()#- Subscribe key level read permissions.
isWriteEnabled()#- Subscribe key level write permissions.
isManageEnabled()#- Subscribe key level manage permissions.
isDeleteEnabled()#- Subscribe key level delete permissions.
isGetEnabled()#- Subscribe key level get permissions.
isUpdateEnabled()#- Subscribe key level update permissions.
isJoinEnabled()#- Subscribe key level join permissions.
PNAccessManagerChannelData, PNAccessManagerGroupData, PNAccessManagerUserData, and PNAccessManagerCategoryData have the same fields structure.
getAuthKeys()#- Access rights per auth-key. See PNAccessManagerKeyData for more details.
getTtl()#- Time to live value.
getName()#- Channel, group, user, or category name.
isReadEnabled()#- Subscribe key level read permissions.
isWriteEnabled()#- Subscribe key level write permissions.
isManageEnabled()#- Subscribe key level manage permissions.
isDeleteEnabled()#- Subscribe key level delete permissions.
isGetEnabled()#- Subscribe key level get permissions.
isUpdateEnabled()#- Subscribe key level update permissions.
isJoinEnabled()#- Subscribe key level join permissions.
PNAccessManagerKeyData
getTtl()#- Time to live value.
isReadEnabled()#- Subscribe key level read permissions.
isWriteEnabled()#- Subscribe key level write permissions.
isManageEnabled()#- Subscribe key level manage permissions.
isDeleteEnabled()#- Subscribe key level delete permissions.
isGetEnabled()#- Subscribe key level get permissions.
isUpdateEnabled()#- Subscribe key level update permissions.
isJoinEnabled()#- Subscribe key level join permissions.
Read, write and manage permissions hav 3 states:
trueif enabled.falseif disabled.- None if not explicitly set.
Other examples
Grant subscribe privileges to all users on all channel(s) with default ttl (1440 minutes)
1
Allow subscribe and publish to a specific grant subscribe and publish to a specific channel for all users (no AuthKey required) with default ttl (1440 minutes)
1
Grant an AuthKey access to list all channel and uuid metadata
The code below grants my_authkey the get category permission for both channels and uuids, then revokes it by granting the same categories with get(false).
1
Grant subscribe access to a channel only for clients with a specific AuthKey with a 5 minute ttl
1
The above code would return the following response to the client:
1{
2 "status" : 200,
3 "message" : "Success",
4 "payload" : {
5 "ttl" : 5,
6 "auths" : {
7 "my_ro_authkey" : {
8 "r" : 1,
9 "w" : 0,
10 "d" : 0
11 }
12 },
13 "subscribe_key" : "my_Subscribe key",
14 "level" : "user",
15 "channel" : "my_channel"
show all 19 linesAllow access to a specific channel for Presence
1
Grant Access Manager permissions for channel group
1
The above code would return the following response to the client:
1{
2 "status":200,
3 "message":"Success",
4 "payload":{
5 "ttl":5,
6 "auths":{
7 "my_rw_authkey":{
8 "r":1,
9 "w":1,
10 "d":1
11 }
12 },
13 "subscribe_key":"my_Subscribe key",
14 "level":"user",
15 "channel":"my_channel"
show all 18 linesApplication 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.
1
Channel level grant
1
User level grant
1