Access Manager v3 API for Python SDK

Access Manager allows you to enforce security controls for client access to resources within the PubNub Platform. With Access Manager v3, your servers (that use a PubNub instance configured with a secret key) 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 one client with a given userId. 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.

Request execution and return values

You can decide whether to perform the Python SDK operations synchronously or asynchronously.

.sync() returns an Envelope object, which has two fields: Envelope.result, whose type differs for each API, and Envelope.status of type PnStatus.
```
pubnub.publish() \
    .channel("myChannel") \
    .message("Hello from PubNub Python SDK") \
    .sync()
```

.pn_async(callback) returns None and passes the values of Envelope.result and Envelope.status to a callback you must define beforehand.

def my_callback_function(result, status):
    print(f'TT: {result.timetoken}, status: {status.category.name}')

pubnub.publish() \
    .channel("myChannel") \
    .message("Hello from PubNub Python SDK") \
    .pn_async(my_callback_function)

User ID / UUID

User ID is also referred to as UUID/uuid in some APIs and server responses but holds the value of the userId parameter you set during initialization.

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.

Requires Secret Key authentication

Granting permissions to resources should be done by administrators whose SDK instance has been initialized with a Secret Key (available on the Admin Portal on your app's keyset).

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

channels
groups
uuids (other users' object metadata, such as their names or avatars)

Only this authorized_uuid 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
TTL (time to live)
RegEx patterns
Authorized UUID

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`
`groups`	`read`, `manage`
`uuids`	`get`, `update`, `delete`

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

The ttl (time to live) parameter defines how many minutes the permissions remain valid. After expiration, the client must get a new token to maintain access. ttl is required for every grant call. There is no default value. The maximum value is 43,200 (30 days).

For more details, see TTL in Access Manager v3.

Use regular expressions (RegEx) to specify permissions by pattern instead of listing each resource. Define RegEx permissions as pattern before making a grant request.

For more details, see RegEx in Access Manager v3.

Setting an authorized_uuid in the token specifies which client should use this token in every request to PubNub. If you do not set authorized_uuid during the grant request, the token can be used by any client with any UUID. Restrict tokens to a single authorized_uuid to prevent impersonation.

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

Method(s)

grant_token() \
    .ttl(int) \
    .meta(Dictionary) \
    .authorized_uuid(str) \
    .channels(list<Channel>) \
    .groups(list<Group>) \
    .uuids(list<UUID>)

* required

Parameter	Description
`ttl` * Type: `Number` Default: 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).
`meta` Type: `Dictionary` Default: n/a	Extra metadata to be published with the request. Values must be scalar only; arrays or objects are not supported.
`authorized_uuid` Type: `Str` Default: n/a	Single `uuid` which is authorized to use the token to make API requests to PubNub.
`channels` Type: `list<Channel>` Default: n/a	All channel grants provided either as a list or a RegEx pattern.
`groups` Type: `list<Group>` Default: n/a	All channel group grants provided either as a list or a RegEx pattern.
`uuids` Type: `list<UUID>` Default: n/a	All uuid grants provided either as a list or a RegEx pattern.

Required key/value mappings

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

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

Builder Pattern
Named Arguments

import os
from pubnub.pnconfiguration import PNConfiguration
from pubnub.pubnub import PubNub
from pubnub.models.consumer.v3.channel import Channel
from pubnub.exceptions import PubNubException


def grant_pubnub_token(pubnub: PubNub) -> str:
    envelope = pubnub.grant_token() \
        .channels([
            Channel.id('readonly-channel').read(),
            Channel.id('readwrite-channel').read().write(),
        ]) \
        .authorized_uuid("my-authorized-uuid") \
        .ttl(15) \
show all 43 lines

import os
from pubnub.pnconfiguration import PNConfiguration
from pubnub.pubnub import PubNub
from pubnub.models.consumer.v3.channel import Channel
from pubnub.exceptions import PubNubException


def grant_pubnub_token(pubnub: PubNub) -> str:
    grant = pubnub.grant_token(
        channels=[
            Channel.id('readonly-channel').read(),
            Channel.id('readwrite-channel').read().write(),
        ],
        authorized_uuid="my-authorized-uuid",
        ttl=15
show all 44 lines

Returns

{"token":"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.

from pubnub.models.consumer.v3.channel import Channel
from pubnub.models.consumer.v3.group import Group
from pubnub.models.consumer.v3.uuid import UUID

channels = [
    Channel.id("channel-a").read(),
    Channel.id("channel-b").read().write(),
    Channel.id("channel-c").read().write(),
    Channel.id("channel-d").read().write()
]
groups = [
    Group.id("channel-group-b").read()
]
uuids = [
    UUID.id("uuid-c").get(),
show all 25 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.

envelope = pubnub.grant_token() \
    .channels(Channel.pattern("channel-[A-Za-z0-9]").read()) \
    .authorized_uuid("my-authorized-uuid") \
    .ttl(15) \
    .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.

from pubnub.models.consumer.v3.channel import Channel
from pubnub.models.consumer.v3.group import Group
from pubnub.models.consumer.v3.uuid import UUID

channels = [
    Channel.id("channel-a").read(),
    Channel.pattern("channel-[A-Za-z0-9]").read(),
    Channel.id("channel-b").read().write(),
    Channel.id("channel-c").read().write(),
    Channel.id("channel-d").read().write()
]
groups = [
    Group.id("channel-group-b").read()
]
uuids = [
show all 25 lines

Error responses

If you submit an invalid request, the server returns HTTP 400 with a message that identifies the missing or incorrect argument. Causes can include a RegEx issue, an invalid timestamp, or incorrect permissions. Details are returned in the envelope object.

Grant token - spaces & users

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), authorized_user, and a set of permissions giving access to one or more resources:

For a limited time period.
Through resource lists or regular expression (RegEx) patterns.
In one API request, even when permissions differ.

spaces
users (other users' metadata, such as their names or avatars)

Only this authorized_user 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
TTL (time to live)
RegEx patterns
Authorized user ID

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
`space`	`read`, `write`, `get`, `manage`, `update`, `join`, `delete`
`user`	`get`, `update`, `delete`

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

For more details, see TTL in Access Manager v3.

Use regular expressions (RegEx) to specify permissions by pattern instead of listing each resource. Define RegEx permissions as patterns before making a grant request.

For more details, see RegEx in Access Manager v3.

Setting an authorized_user in the token specifies which client should use this token in every request to PubNub. If you do not set authorized_user during the grant request, the token can be used by any client with any userId. Restrict tokens to a single authorized_user to prevent impersonation.

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

Method(s)

grant_token() \
    .ttl(Integer) \
    .meta(Dictionary) \
    .authorized_user(String) \
    .spaces(list<Space>) \
    .users(list<User>)

* required

Parameter	Description
`ttl` * Type: Integer Default: 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).
`meta` Type: `Dictionary` Default: n/a	Extra metadata to be published with the request. Values must be scalar only; arrays or objects are not supported.
`authorized_user` Type: String Default: n/a	Single `user_id` which is authorized to use the token to make API requests to PubNub.
`spaces` Type: `list<Space>` Default: n/a	All Space permissions provided as a list of individual permissions or RegEx patterns.
`users` Type: `list<User>` Default: n/a	All User permissions provided as a list of individual permissions or RegEx patterns.

Required key/value mappings

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

Sample code

Builder Pattern
Named Arguments

envelope = pubnub.grant_token() \
    .authorized_user('some_user_id')\
    .spaces([
        Space().id('some_space_id').read().write(),
        Space().pattern('some_*').read().write()
    ]) \
    .ttl(60) \
    .sync()

grant = pubnub.grant_token(spaces=[Space().id('some_space_id').read().write(), Space().pattern('some_*').read().write()],
                           authorized_user="my-authorized-uuid",
                           ttl=60) \
    .sync()

print(f'Token granted: {grant.result.get_token()}')

Returns

{"token":"p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI"}

Other examples

Grant an authorized client different levels of access to various resources in a single call

The code below grants my-authorized-userId:

Read access to space-a, and get to userId-c.
Read/write access to space-b, space-c, space-d, and get/update to userId-d.

from pubnub.models.consumer.v3.space import Space
from pubnub.models.consumer.v3.user import User

spaces = [
    Space.id("space-a").read(),
    Space.id("space-b").read().write(),
    Space.id("space-c").read().write(),
    Space.id("space-d").read().write()
]
users = [
    User.id("userId-c").get(),
    User.id("userId-d").get().update()
]
envelope = pubnub.grant_token()
    .spaces(spaces)
show all 19 lines

Grant an authorized client read access to multiple spaces using RegEx

The code below grants my-authorized-userId read access to all channels that match the space-[A-Za-z0-9] RegEx pattern.

envelope = pubnub.grant_token()
    .spaces(Space.pattern("space-[A-Za-z0-9]").read())
    .ttl(15)
    .authorized_user("my-authorized-userId")
    .sync()

Grant an authorized client different levels of access to various resources and read access to spaces using RegEx in a single call

The code below grants the my-authorized-userId:

Read access to space-a and userId-c.
Read/write access to space-b, space-c, space-d, and get/update to userId-d.
Read access to all channels that match the space-[A-Za-z0-9] RegEx pattern.

from pubnub.models.consumer.v3.space import Space
from pubnub.models.consumer.v3.user import User

channels = [
    Space.id("space-a").read(),
    Space.pattern("space-[A-Za-z0-9]").read(),
    Space.id("space-b").read().write(),
    Space.id("space-c").read().write(),
    Space.id("space-d").read().write()
]
users = [
    User.id("user-c").get(),
    User.id("user-d").get().update()
]
envelope = pubnub.grant_token()
show all 21 lines

Error responses

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 revoke_token() 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 grant_token() 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)

revoke_token(String)

* required

Parameter	Description
`token` * Type: String Default: n/a	Existing token with embedded permissions.

Sample code

pubnub.revoke_token("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Returns

The revoke_token() operation returns an Envelope which contains the following fields:

Field	Type	Description
result	`PNRevokeTokenResult`	A detailed object containing the result of the operation.
status	`PNStatus`	A status object with additional information.

PNRevokeTokenResult

Revoke token success with status: 200

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 parse_token() 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)

parse_token(String)

* required

Parameter	Description
`token` * Type: String Default: n/a	Current token with embedded permissions.

Sample code

pubnub.parse_token("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Returns

{
   "version":2,
   "timestamp":1629394579,
   "ttl":15,
   "authorized_uuid": "user1",
   "resources":{
      "uuids":{
         "user1":{
            "read": False,
            "write": False,
            "manage": False,
            "delete": False,
            "get": True,
            "update": True,
            "join": False
show all 76 lines

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

Method(s)

set_token(String)

* required

Parameter	Description
`token` * Type: String Default: n/a	Current token with embedded permissions.

Sample code

pubnub.set_token("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")

Returns

This method doesn't return any response value.

Request execution and return values

User ID / UUID

Grant token​

Requires Access Manager add-on

Requires Secret Key authentication

Method(s)​

Required key/value mappings

Sample code​

Reference code

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​

Grant token - spaces & users​

Requires Access Manager add-on

Method(s)​

Required key/value mappings

Sample code​

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 spaces using RegEx​

Grant an authorized client different levels of access to various resources and read access to spaces using RegEx in a single call​

Error responses​

Revoke token​

Requires Access Manager add-on

Enable token revoke

Method(s)​

Sample code​

Returns​

PNRevokeTokenResult​

Error Responses​

Parse token​

Method(s)​

Sample code​

Returns​

Error Responses​

Set token​

Method(s)​

Sample code​

Returns​

Grant token

Method(s)

Sample code

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

Grant token - spaces & users

Method(s)

Sample code

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 spaces using RegEx

Grant an authorized client different levels of access to various resources and read access to spaces using RegEx in a single call

Error responses

Revoke token

Method(s)

Sample code

Returns

PNRevokeTokenResult

Error Responses

Parse token

Method(s)

Sample code

Returns

Error Responses

Set token

Method(s)

Sample code

Returns