--- source_url: https://www.pubnub.com/docs/sdks/android/api-reference/access-manager title: Access Manager v3 API for Android SDK updated_at: 2026-09-30T07:20:08.000Z --- # Access Manager v3 API for Android SDK > For AI agents: documentation index at https://www.pubnub.com/llms-full.txt :::warning Unsupported docs PubNub no longer maintains Android SDK docs, but our [Java SDK](https://www.pubnub.com/docs/sdks/java.md) or [Kotlin SDK](https://www.pubnub.com/docs/sdks/kotlin.md) are fully compatible with the Android platform and you can use them to build mobile apps, ensuring stable software development. ::: Access Manager v3 lets you enforce security controls for client access to resources on the PubNub platform. With Access Manager v3, your servers (that use a PubNub instance configured with a secret key) can grant clients tokens with embedded permissions that provide access to individual PubNub resources: * For a limited time period. * Through resource lists or regular expression (RegEx) patterns. * In one API request, even when permissions differ (for example, `read` to `channel1` and `write` to `channel2`). You can add the [authorizedUUID](https://www.pubnub.com/docs/security/access-control/overview.md#authorized-uuid) parameter to restrict token usage to one client with a given UUID. Only this `authorizedUUID` can use the token to make API requests for the specified resources and permissions. For more information about Access Manager v3, refer to [Manage Permissions with Access Manager v3](https://www.pubnub.com/docs/security/access-control/overview.md). ## Grant token :::note Requires Access Manager add-on This method requires that the *Access Manager* add-on is enabled for your key in the [Admin Portal](https://admin.pubnub.com/). Read the [support page](https://support.pubnub.com/hc/en-us/articles/360051974791-How-do-I-enable-add-on-features-for-my-keys-) on enabling add-on features on your keys. ::: :::warning Requires Secret Key authentication Granting permissions to resources should be done by administrators whose SDK instance has been [initialized](https://www.pubnub.com/docs/sdks/android/api-reference/configuration.md) with a **Secret Key** (available on the [Admin Portal](https://admin.pubnub.com/) on your app's keyset). ::: 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 clients access to resources on the PubNub platform. Each resource type supports a specific set of operations: | 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](https://www.pubnub.com/docs/security/access-control/overview.md). ### TTL (time to live) 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](https://www.pubnub.com/docs/security/access-control/overview.md#ttl). ### RegEx patterns Use regular expression (RegEx) patterns to set permissions without listing each resource. Set RegEx permissions as `patterns` before making a grant request. For more details, see [RegEx in Access Manager v3](https://www.pubnub.com/docs/security/access-control/overview.md). ### Authorized UUID Setting an `authorizedUUID` in the token specifies which client should use this token in every request to PubNub. If you do not set `authorizedUUID` during the grant request, the token can be used by any client with any UUID. Restrict tokens to a single `authorizedUUID` to prevent impersonation. For more details, see [Authorized UUID in Access Manager v3](https://www.pubnub.com/docs/security/access-control/overview.md#authorized-uuid). ### Method(s) ```java grantToken() .ttl(Integer) .meta(Object) .authorizedUUID(String) .channels(List) .channelGroups(List) .uuids(List) ``` | Parameter | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | ttl | Number | Yes | | 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 | Object | Optional | | Extra metadata to be published with the request. Values must be scalar only; arrays or objects are not supported. | | authorizedUUID | String | Optional | | Single `uuid` which is authorized to use the token to make API requests to PubNub. | | channels | List | Optional | | All channel grants provided either as a list or a RegEx pattern. | | channelGroups | List | Optional | | All channel group grants provided either as a list or a RegEx pattern. | | uuids | List | Optional | | All uuid grants provided either as a list or a RegEx pattern. | :::note 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). ::: ### Sample code ```java pubnub.grantToken() .ttl(15) .authorizedUUID("my-authorized-uuid") .channels(Arrays.asList(ChannelGrant.name("my-channel").read())) .async(new PNCallback() { @Override public void onResponse(@Nullable PNGrantTokenResult result, @NotNull PNStatus status) { if (status.isError()) { // Handle error } else { // Handle result } } }); ``` ### Returns ```json {"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`. ```java pubnub.grantToken() .ttl(15) .authorizedUUID("my-authorized-uuid") .channels(Arrays.asList( ChannelGrant.name("channel-a").read(), ChannelGrant.name("channel-b").read().write(), ChannelGrant.name("channel-c").read().write(), ChannelGrant.name("channel-d").read().write())) .channelGroups(Collections.singletonList( ChannelGroupGrant.id("channel-group-b").read())) .uuids(Arrays.asList( UUIDGrant.id("uuid-c").get(), UUIDGrant.id("uuid-d").get().update())) .async(new PNCallback() { @Override public void onResponse(@Nullable PNGrantTokenResult result, @NotNull PNStatus status) { if (status.isError()) { // Handle error } else { // Handle result } } }); ``` #### 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. ```java pubnub.grantToken() .ttl(15) .authorizedUUID("my-authorized-uuid") .channels(Collections.singletonList( ChannelGrant.pattern("^channel-[A-Za-z0-9]*$").read())) .async(new PNCallback() { @Override public void onResponse(@Nullable PNGrantTokenResult result, @NotNull PNStatus status) { if (status.isError()) { // Handle error } else { // Handle result } } }); ``` #### 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. ```java pubnub.grantToken() .ttl(15) .authorizedUUID("my-authorized-uuid") .channels(Arrays.asList( ChannelGrant.name("channel-a").read(), ChannelGrant.name("channel-b").read().write(), ChannelGrant.name("channel-c").read().write(), ChannelGrant.name("channel-d").read().write(), ChannelGrant.pattern("^channel-[A-Za-z0-9]*$").read())) .channelGroups(Collections.singletonList( ChannelGroupGrant.id("channel-group-b").read())) .uuids(Arrays.asList( UUIDGrant.id("uuid-c").get(), UUIDGrant.id("uuid-d").get().update())) .async(new PNCallback() { @Override public void onResponse(@Nullable PNGrantTokenResult result, @NotNull PNStatus status) { if (status.isError()) { // Handle error } else { // Handle result } } }); ``` ### 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](https://support.pubnub.com/hc/en-us/articles/360051973331-Why-do-I-get-Invalid-Timestamp-when-I-try-to-grant-permission-using-Access-Manager-), or incorrect permissions. The server returns the error details under the `PubNubException` class. ## Revoke token :::note Enable token revoke This method requires that the *Access Manager* add-on is enabled for your key in the [Admin Portal](https://admin.pubnub.com/). Also, to revoke tokens, you must first enable this feature. 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](mailto:support@pubnub.com). For more information, refer to [Revoke permissions](https://www.pubnub.com/docs/security/access-control/overview.md). ### Method(s) ```java revokeToken() .token(String token) ``` | Parameter | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | token | String | Yes | | Existing token with embedded permissions. | ### Sample code ```java pubnub.revokeToken() .token("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI") ``` ### Returns When the token revocation request is successful, this method returns a `PNRevokeTokenResult`. ### 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) ```java parseToken(String token) ``` | Parameter | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | token | String | Yes | | Current token with embedded permissions. | ### Sample code ```java pubnub.parseToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI") ``` ### Returns ```json { "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 } }, "channels":{ "channel1":{ "read":true, "write":true, "manage":false, "delete":false, "get":false, "update":false, "join":false } }, "groups":{ "group1":{ "read":true, "write":false, "manage":false, "delete":false, "get":false, "update":false, "join":false } } }, "patterns":{ "uuids":{ ".*":{ "read":false, "write":false, "manage":false, "delete":false, "get":true, "update":false, "join":false } }, "channels":{ ".*":{ "read":true, "write":true, "manage":false, "delete":false, "get":false, "update":false, "join":false } }, "groups":{ ".*":{ "read":true, "write":false, "manage":false, "delete":false, "get":false, "update":false, "join":false } } } } ``` ### 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) ```java setToken(String token) ``` | Parameter | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | token | String | Yes | | Current token with embedded permissions. | ### Sample code ```java pubnub.setToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI") ``` ### Returns This method doesn't return any response value. Last updated at: 2026-09-30T07:20:08.000Z