--- source_url: https://www.pubnub.com/docs/sdks/android/api-reference/access-manager title: Access Manager v3 API for Android SDK updated_at: 2026-05-22T11:05:38.233Z --- > Documentation Index > For a curated overview of PubNub documentation, see: https://www.pubnub.com/docs/llms.txt > For the full list of all documentation pages, see: https://www.pubnub.com/docs/llms-full.txt # Access Manager v3 API for Android SDK :::warning Unsupported docs PubNub no longer maintains Android SDK docs, but our [Java SDK](https://www.pubnub.com/docs/sdks/java) or [Kotlin SDK](https://www.pubnub.com/docs/sdks/kotlin) 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/general/security/access-control#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/general/security/access-control). ## 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) 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/general/security/access-control#permissions). ###### 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/general/security/access-control#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/general/security/access-control#regex). ###### 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/general/security/access-control#authorized-uuid). ### Method(s) ```java grantToken() .ttl(Integer) .meta(Object) .authorizedUUID(String) .channels(List) .channelGroups(List) .uuids(List) ``` | 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: `Object`Default: n/a | Extra metadata to be published with the request. Values must be scalar only; arrays or objects are not supported. | | `authorizedUUID`Type: `String`Default: n/a | Single `uuid` which is authorized to use the token to make API requests to PubNub. | | `channels`Type: `List`Default: n/a | All channel grants provided either as a list or a RegEx pattern. | | `channelGroups`Type: `List`Default: n/a | All channel group grants provided either as a list or a RegEx pattern. | | `uuids`Type: `List`Default: n/a | 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](https://www.pubnub.com/docs/mailto:support@pubnub.com). For more information, refer to [Revoke permissions](https://www.pubnub.com/docs/general/security/access-control#revoke-permissions). ### Method(s) ```java revokeToken() .token(String token) ``` | Parameter | Description | | --- | --- | | `token` *Type: `String`Default: n/a | 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 | Description | | --- | --- | | `token` *Type: `String`Default: n/a | 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 | Description | | --- | --- | | `token` *Type: `String`Default: n/a | Current token with embedded permissions. | ### Sample code ```java pubnub.setToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI") ``` ### Returns This method doesn't return any response value. ## Terms in this document * **Access Manager** - A cryptographic, token-based permission administrator that allows you to regulate clients' access to PubNub resources, such as channels, channel groups, and user IDs. * **Action** - The type of activity (procedure) to execute when a condition is satisfied (for example, sending a message). * **Billing alert notification** - A means of informing a user that a billing alert has been triggered. Before notifications can happen, a billing alert must be triggered first. * **Business Object** - A container for data fields and metrics that defines aggregations and data sources. * **Channel** - A pathway for sending and receiving messages between devices, created automatically when you first use it, that can handle any number of users and messages for different communication needs, like 1-1 text chats, group conversations, and other data streaming. * **Channel pattern** - A way to group and analyze channel data to track performance metrics like message counts and user engagement over time with PubNub Insights. * **Condition** - A requirement that must be satisfied or evaluated to true for an action to be executed. Input in a decision table. * **Cryptor** - An implementation of a specific cryptographic algorithm used for data encryption/decryption that adheres to a standard interface. * **Dashboard** - A collection of widgets (charts) that give an overview of the metrics one is evaluating. * **Data fields** - Data you want Illuminate to track. These can be quantitative (measures), like "Number" or "Timestamp" or qualitative (dimensions) values, like "String" that can be used to categorize and segment data. Data fields can be aggregated and calculated. * **Decision** - A collection (or decision table) of conditions and actions. When conditions are satisfied, the corresponding actions are triggered as per defined rules. * **End Customer** - A customer of a PubNub partner. End customers do not have direct access to the Admin Portal. Instead, they interact with PubNub products—such as Illuminate—through the partner’s portal, where PubNub services are embedded. They can create PubNub objects only within this partner-provided environment. * **Entity** - A subscribable object within a PubNub SDK that allows you to perform context-specific operations. * **Listener** - A function or objectthat reacts to events or messages, like new chat messages or connection updates, letting your app respond in real-time. * **Mapped/Unmapped** - Whether the data source for a data field has been defined or the action has been configured. * **MCP Server** - A Model Context Protocol server that coordinates communication and synchronization between AI agents, clients, or services, such as Cursor IDE and Windsurf. * **Message** - A unit of data transmitted between clients or between a client and a server in PubNub, containing information such as text, binary data, or structured data formats like JSON. Messages are sent over channels and can be tracked for delivery and read status. * **Metric** - What exactly is evaluated using measures and dimensions (collectively called data fields), as well as aggregation functions. * **Module** - A Functions v1 container that groups related functions for configuration and deployment on an app’s keysets. * **Origin** - The subdomain used to establish a connection to the PubNub network that allows your application's traffic to appear like it's coming from your own domain. * **Package** - A Functions v2 container that groups Functions, tracks Revisions, and is deployed to keysets. * **Partner** - A PubNub customer who resells PubNub products, such as Illuminate, to their own customers. Partners have access to the Admin Portal, enabling them to create and manage PubNub objects for themselves or on behalf of their end customers. * **Publish Key** - A unique identifier that allows your application to send messages to PubNub channels. It's part of your app's credentials and should be kept secure. * **PubNub** - PubNub is a real-time messaging platform that provides APIs and SDKs for building scalable applications. It handles the complex infrastructure of real-time communication, including: Message delivery and persistence, Presence detection, Access control, Push notifications, File sharing, Serverless processing with Functions and Events & Actions, Analytics and monitoring with BizOps Workspace, AI-powered insights with Illuminate. * **Push token** - A device identifier issued by a push provider (APNs or FCM) used to register a device for receiving mobile push notifications. * **Rule** - A definition (row in a decision table) stating which action should be triggered for which condition. * **Service Integration** - A machine identity that represents a program or service consuming the Admin API, scoped to your account and authenticated using expirable API keys with configurable permissions. * **Signal** - A non-persistent message limited to 64 bytes designed for high-volume usecases where the the most recent data is relevant, like GPS location updates. * **Subscribe Key** - A unique identifier that allows your application to receive messages from PubNub channels. It's part of your app's credentials and should be kept secure. * **Timetoken** - A unique identifier for each message that represents the number of 100-nanosecond intervals since January 1, 1970, for example, 16200000000000000. * **Trigger details** - A set of predefined criteria for a given billing alert. When met, billing alert notifications are generated. * **User** - An individual or entity that interacts with a system, application, or service. In PubNub, a user typically refers to someone who sends or receives messages through the platform, identified by a unique user ID or username. * **User ID** - UTF-8 encoded, unique string of up to 92 characters used to identify a single client (end user, device, or server) that connects to PubNub. * **Vibe Coding** - A way to build applications in an intuitive, relaxed, and improvisational manner, using AI tools and natural language descriptions.