Access Manager v3 API for PubNub PHP SDK

Access Manager v3 allows you to enforce security controls for client access to resources within the PubNub Platform. With Access Manager v3, your servers 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 authorizedUuid parameter to the grant request to restrict the token usage to only one client with a given Uuid. Once specified, only this authorizedUuid will be able to use the token to make API requests for the specified resources, according to permissions given in the grant request.

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.

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

Channels
ChannelGroups
Uuids (other users' object metadata, such as their names or avatars)

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

Permissions

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`
`ChannelGroups`	`read`, `manage`
`Uuids`	`get`, `update`, `delete`

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

TTL

The ttl (time to live) parameter is the number of minutes before the granted permissions expire. The client will require a new token to be granted before expiration to ensure continued access. ttl is a required parameter for every grant call and there is no default value set for it. The max value for ttl is 43,200 (30 days).

danger

Recommended ttl value

For security reasons, it's recommended to set ttl between 10 and 60, and create a new token before this ttl elapses.

For more details, see TTL in Access Manager v3.

RegEx

If you prefer to specify permissions by setting patterns, rather than listing all resources one by one, you can use regular expressions. To do this, set RegEx permissions as patterns before making a grant request.

For more details, see RegEx in Access Manager v3.

Authorized UUID

Setting an authorizedUuid in the token helps you specify which client device should use this token in every request to PubNub. This will ensure that all requests to PubNub are authorized before PubNub processes them. If authorizedUuid isn't specified during the grant request, the token can be used by any client with any Uuid. It's recommended to restrict tokens to a single authorizedUuid to prevent impersonation.

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

Method(s)

$pubnub->grantToken()
    ->ttl($ttl)
    ->authorizedUuid($uuid)
    ->addChannelResources(Array[String => String])
    ->addChannelGroupResources(Array[String => String])
    ->addUuidResources(Array[String => String])
    ->addChannelPatterns(Array[String => String])
    ->addChannelGroupPatterns(Array[String => String])
    ->addUuidPatterns(Array[String => String])
    ->meta(Array[String => String])
    ->sync();

Parameter	Type	Required	Default	Description
`ttl`	`Number`	Yes	n/a	Total number of minutes for which the token is valid. The minimum allowed value is `1`. The maximum is `43,200` minutes (30 days).
`authorizedUuid`	`String`	Optional	n/a	Single UUID which is authorized to use the token to make API requests to PubNub.
`addChannelResources`	`Array`	Optional	n/a	Array containing explicit channels resource permissions.
`addChannelGroupResources`	`Array`	Optional	n/a	Array containing explicit channel groups resource permissions.
`addUuidResources`	`Array`	Optional	n/a	Array containing explicit UUID resource permissions.
`addChannelPatterns`	`Array`	Optional	n/a	Array containing channels permissions expressed as a RegEx pattern.
`addChannelGroupPatterns`	`Array`	Optional	n/a	Array containing channel groups permissions expressed as a RegEx pattern.
`addUuidPatterns`	`Array`	Optional	n/a	Array containing UUID permissions expressed as a RegEx pattern.
`meta`	`Array`	Optional	n/a	Extra metadata to be published with the request. Values must be scalar only; arrays or objects aren't supported.

An array for resource/permission should contain the resource name as the key and an array of rights as a value. You don't need to specify the false permissions as that's the default value for all rights.

[
    'channel-1' => ['read' => true, 'write' => true]
    'channel-2' => ['read' => true, 'write' => false]
    'channel-3' => ['read' => true]
]

Required key/value mappings

For a successful grant request, you must specify permissions for at least one Uuid, Channel, or ChannelGroup, either as a resource list or as a pattern (RegEx).

Basic Usage

$token = $pubnub->grantToken()
    ->ttl(15)
    ->authorizedUuid('my-authorized-uuid')
    ->addChannelResources([
        'my-channel' => ['read' => true, 'write' => true, 'update' => true],
    ])
    ->sync();
);

Returns

"p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI"

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.

$pubnub->grantToken()
    ->ttl(15)
    ->authorizedUuid('my-authorized-uuid')
    ->addChannelResources([
        'channel-a' => ['read' => true],
        'channel-b' => ['read' => true, 'write' => true],
        'channel-c' => ['read' => true, 'write' => true],
        'channel-d' => ['read' => true, 'write' => true],
    ])
    ->addChannelGroupResources([
        'channel-group-b' => ['read' => true],
    ])
    ->addUuidResources([
        'uuid-c' => ['get' => true],
        'uuid-d' => ['get' => true, 'update' => true],
show all 17 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.

$pubnub->grantToken()
    ->ttl(15)
    ->authorizedUuid('my-authorized-uuid')
    ->addChannelPatterns([
        '^channel-[A-Za-z0-9]$' => ['read' => true],
    ])
    ->sync();

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.

$pubnub->grantToken()
    ->ttl(15)
    ->authorizedUuid('my-authorized-uuid')
    ->addChannelResources([
        'channel-a' => ['read' => true],
        'channel-b' => ['read' => true, 'write' => true],
        'channel-c' => ['read' => true, 'write' => true],
        'channel-d' => ['read' => true, 'write' => true],
    ])
    ->addChannelGroupResources([
        'channel-group-b' => ['read' => true],
    ])
    ->addUuidResources([
        'uuid-c' => ['get' => true],
        'uuid-d' => ['get' => true, 'update' => true],
show all 19 lines

Error responses

If you submit an invalid request, the server returns the 400 error status code with a descriptive message informing which of the provided arguments is missing or incorrect. These can include, for example, issues with a RegEx, a timestamp, or permissions. The server returns the details of the error in PubNubServerException.

Method	Type	Description
`getStatusCode()`	`Int`	Status code `400` that is returned by the server by default.
`getBody()`	`Object`	Entire body of the error returned by the server. The body contains such fields as `message`, `source`, `details`, `service`, and `status`.
`getServerErrorMessage()`	`String`	Descriptive error message, such as `Invalid ttl`.
`getServerErrorSource()`	`String`	Source of the error.
`getServerErrorDetails()`	`Object`	Details of the first encountered problem. This object contains these public properties: `message`, `location`, and `locationType`.

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

Enable token revoke

To revoke tokens, you must first enable this feature on the Admin Portal. To do that, navigate to your app's keyset and mark the Revoke v3 Token checkbox in the ACCESS MANAGER section.

The revokeToken() method allows you to disable an existing token and revoke all permissions embedded within. You can only revoke a valid token previously obtained using the grantToken() method.

Use this method for tokens with ttl less than or equal to 30 days. If you need to revoke a token with a longer ttl, contact support.

For more information, refer to Revoke permissions.

Method(s)

$pubnub->revokeToken($token)
    ->sync();

Parameter	Type	Required	Default	Description
`token`	`String`	Yes	n/a	Existing token with embedded permissions.

Basic Usage

$pubnub->revokeToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenV")
    ->sync();

Returns

When the token revocation request is successful, this method returns a PNRequestResult. When the request fails, it returns PubNubServerException.

PNRequestResult

Method	Type	Description
`getStatus()`	`Int`	Server response status `200`.
`getService()`	`String`	Service to which the request was made. In this case, `Access Manager`.
`isError()`	`Boolean`	Whether the response is an error message.
`getError()`	`Array`	Error returned by the server.
`getMessage()`	`String`	Message returned by the server on successful request. In this case, `Success`.

Error Responses

If you submit an invalid request, the server returns an error status code with a descriptive message informing which of the provided arguments is missing or incorrect. Depending on the root cause, this operation may return the following errors:

400 Bad Request
403 Forbidden
503 Service Unavailable

Parse Token

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

Method(s)

parseToken(String token)

Parameter	Type	Required	Default	Description
`token`	`String`	Yes	n/a	Current token with embedded permissions.

Basic Usage

$pubnub->parseToken( "p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI");

Returns

$parsedToken = $pubnub->parseToken( "p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")
->toArray();

array(7) {
  ["version"]=>
  int(2)
  ["timestamp"]=>
  int(1634592012)
  ["ttl"]=>
  int(15)
  ["resources"]=>
  array(1) {
    ["chan"]=>
    array(1) {
      ["my-channel"]=>
show all 43 lines

Method	Parameter	Return type	Description
`getVersion()`	none	`Int`	Token version. The current version is `2`.
`getTimestamp()`	none	`Int`	Timestamp of the issued token.
`getTtl()`	none	`String`	Total number of minutes for which the token is valid.
`getResources()`	none	`Array`	List of all resources included in the token in the following format: `type => name => permissions`
`getPatterns()`	none	`Array`	List of all patterns included in the token in the following format: `type => name => permissions`
`getChannelResource($channel)`	`String`	`Object`	Instance of the `Permissions` object for a specific channel. It returns `null` if no permissions are defined.
`getChannelGroupResource($channelGroup)`	`String`	`Object`	Instance of the `Permissions` object for a specific channel group. It returns `null` if no permissions are defined.
`getUuidResource($uuid)`	`String`	`Object`	Instance of the `Permissions` object for a specific UUID. It returns `null` if no permissions are defined.
`getChannelPattern($channel)`	`String`	`Object`	Instance of the `Permissions` object for a specific channel. It returns `null` if no permissions are defined.
`getChannelGroupPattern($channelGroup)`	`String`	`Object`	Instance of the `Permissions` object for a specific channel group. It returns `null` if no permissions are defined.
`getUuidPattern($uuid)`	`String`	`Object`	Instance of the `Permissions` object for a specific UUID. It returns `null` if no permissions are defined.
`getMetadata()`	none	`Array`	Array of metadata set in the grant token request.
`getSignature()`	none	`String`	Signature generated by the server.
`getUuid()`	none	`String`	Authorized UUID
`toArray()`	none	`Array`	Entire token in an array format

Permissions object

Calling getChannelResource() returns an instance of the Permissions object. This object has a series of methods to access specific rights.

$pubnub->parseToken( "p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")
->getChannelResource('my-channel')
->hasRead();

Method	Return type	Description
`hasRead()`	`boolean`	`read` rights that apply to Subscribe, History, and Presence.
`hasWrite()`	`boolean`	`write` rights that apply to Publish.
`hasManage()`	`boolean`	`manage` rights that apply to channel groups and App Context.
`hasDelete()`	`boolean`	`delete` rights that apply to History and App Context.
`hasGet()`	`boolean`	`get` rights that apply to App Context (formerly Objects v2).
`hasUpdate()`	`boolean`	`update` rights that apply to App Context (formerly Objects v2).
`hasJoin()`	`boolean`	`join` rights that apply to App Context (formerly Objects v2).

For example, calling hasRead() returns true.

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 setToken() method is used by the client devices to update the authentication token granted by the server.

Method(s)

setToken(String token)

Parameter	Type	Required	Default	Description
`token`	`String`	Yes	n/a	Current token with embedded permissions.

Basic Usage

$pubnub->setToken(
"p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI"
);

Returns

This method doesn't return any response value.

Grant Token​

Requires Access Manager add-on

Permissions​

TTL​

danger

RegEx​

Authorized UUID​

Method(s)​

Required key/value mappings

Basic Usage​

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​

Revoke Token​

Requires Access Manager add-on

Enable token revoke

Method(s)​

Basic Usage​

Returns​

PNRequestResult​

Error Responses​

Parse Token​

Method(s)​

Basic Usage​

Returns​

Permissions object​

Error Responses​

Set Token​

Method(s)​

Basic Usage​

Returns​

Grant Token

Permissions

TTL

RegEx

Authorized UUID

Method(s)

Basic Usage

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

Revoke Token

Method(s)

Basic Usage

Returns

PNRequestResult

Error Responses

Parse Token

Method(s)

Basic Usage

Returns

Permissions object

Error Responses

Set Token

Method(s)

Basic Usage

Returns