--- source_url: https://www.pubnub.com/docs/sdks/java/api-reference/access-manager-v2 title: Access Manager v2 API for Java SDK updated_at: 2026-05-22T11:06:37.515Z sdk_name: PubNub Java SDK sdk_version: 6.4.5 --- > 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 v2 API for Java SDK PubNub Java SDK, use the latest version: 6.4.5 Install: ```bash Add PubNub dependency to your build@6.4.5 ``` :::warning Breaking changes in v9.0.0 PubNub Java SDK version 9.0.0 unifies the codebases for Java and [Kotlin](https://www.pubnub.com/docs/sdks/kotlin) SDKs, introduces a new way of instantiating the PubNub client, and changes asynchronous API callbacks and emitted [status events](https://www.pubnub.com/docs/sdks/java/status-events). These changes can impact applications built with previous versions (< `9.0.0`) of the Java SDK. For more details about what has changed, refer to [Java/Kotlin SDK migration guide](https://www.pubnub.com/docs/sdks/kotlin/migration-guides/kotlin-v9-migration-guide). ::: 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](https://www.pubnub.com/docs/general/security/access-control-v2). ## Grant :::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. ::: 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](#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](https://www.pubnub.com/docs/general/security/access-control-v2#permissions) | Resource | Permissions | | --- | --- | | `channel` | `read`, `write`, `get`, `manage`, `update`, `join`, `delete` | | `uuid` | `get`, `update`, `delete` | | `channelGroup` | `read`, `manage` | #### 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 with `a.`. * `*` or `a.b.*` won't work this way. If you grant on `*` or `a.b.*`, the grant treats `*` or `a.b.*` as a channel name, not a wildcard. :::warning 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: 1. **Application Level** - Access Manager privileges are always evaluated first at the `Application` level. If either `read` or `write` attribute is set to `true` for a `subscribeKey`, Access Manager will immediately grant access for that attribute without proceeding to check permissions at either `Channel` or `User` levels. If an attribute is set to `false` at the Application level, Access Manager proceeds to evaluate the attribute at the next most granular level. 2. **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 `true` for a combination of `subscribeKey`, and `channel`, Access Manager grants access for that attribute at the `Channel` level without proceeding to check whether there may be `user` level permissions. 3. **User Level (Recommended)** - As a final step Access Manager evaluates the attributes at the `User` level. If an attribute is set to `true` for `subscribeKey`, `channel` and `auth_key`, access is granted for that attribute. Similarly, user level grants also allow you granting an `auth_key` access to `channelGroups` and `uuids`. User level grants require `auth_key` and are the recommended approach if you need to manage permissions for individual users within your application. Each user should be assigned a unique `auth_key` and securely passed back to the user to perform operations on the platform. ### Method(s) To `Grant Permissions on a Channel` you can use the following method(s) in the Java SDK: ```java this.pubnub.grant().authKeys(Arrays).channels(Arrays).uuids(Arrays).write(Boolean).read(Boolean).manage(Boolean).delete(Boolean).get(Boolean).update(Boolean).join(Boolean).ttl(Long).async(result -> {}) ``` | Parameter | Description | | --- | --- | | `authKeys`Type: ArraysDefault: n/a | Specifies `auth` Key to grant permissions. It is possible to specify multiple `auth` keys. You can also grant access to a single `auth` key for multiple `channels` at the same time. Zero or more `channels` with zero or more `auth` tokens are allowed. | | `channels`Type: ArraysDefault: n/a | Specifies the `channels` on which to `grant` permissions. If no `channels/channelGroups` are specified, then the `grant` applies to any and all `channels/channelGroups` that have been or will be created for that `publish/subscribe` key set. Furthermore, any existing or future grants on specific `channels` are ignored, until the `all channels` grant is revoked. It is possible to `grant` permissions to multiple `channels` simultaneously. Wildcard notation like `a.*` can be used to `grant` access on channels. You can `grant` one level deep. a.* - you can grant on this., * and a.b.* - grant will not work on these levels. If you grant on * or a.b.*, the grant will treat * or a.b.* as a single channel named either * or a.b.*. | | `channelGroups`Type: ArraysDefault: n/a | Specifies the `channelGroups` to `grant` permissions. If no `channels/channelGroups` are specified, then the `grant` applies to any and all `channels/channelGroups` that have been or will be created for that `publish/subscribe` key set. Furthermore, any existing or future grants on specific `channelGroups` are ignored, until the `all channelGroups` grant is revoked. It is possible to `grant` permissions to multiple `channelGroups` simultaneously. This parameter does **not** support wildcards. | | `uuids`Type: ArraysDefault: n/a | A list of `uuids` to `grant` permissions to. You can't grant permissions to channels and channel groups in the same request if you decide to use `uuids`. This parameter does **not** support wildcards. | | `write`Type: BooleanDefault: `false` | `Write` permission | | `read`Type: BooleanDefault: `false` | `Read` permission | | `manage`Type: BooleanDefault: `false` | `Manage` permission | | `delete`Type: BooleanDefault: `false` | `Delete` permission | | `get`Type: BooleanDefault: `false` | `Get` permission | | `update`Type: BooleanDefault: `false` | `Update` permission | | `join`Type: BooleanDefault: `false` | `Join` permission | | `ttl`Type: LongDefault: `Not set` | `Time to live` for permission to be valid | | `async` *Type: `Consumer`Default: n/a | `Consumer` of a `Result` of type `PNAccessManagerGrantResult` | ### Sample code #### Grant Access Manager permissions for channel and auth_key ```java pubnub.grant() .channels(Arrays.asList("ch1", "ch2", "ch3")) //channels to allow grant on .channelGroups(Arrays.asList("cg1", "cg2", "cg3")) // groups to allow grant on .authKeys(Arrays.asList("key1", "key2", "key3")) // the keys we are provisioning .write(true) // allow those keys to write (false by default) .manage(true) // allow those keys to manage channel groups (false by default) .read(true) // allow keys to read the subscribe feed (false by default) .delete(true) // allow keys to delete messages (false by default) .ttl(12337) // how long those keys will remain valid (0 for eternity) .async(result -> { /* check result */ }); ``` ### Returns The `grant()` operation returns a `PNAccessManagerGrantResult` which contains the following operations: | Method | Description | | --- | --- | | `getLevel()`Type: String | Subkey or `channel` level. | | `getTtl()`Type: Int | `Ttl` of `grant`. | | `getSubscribeKey()`Type: String | The `subscribeKey`. | | `getChannels()`Type: `Map>` | Access rights per `channel`. See [PNAccessManagerKeyData](#pnaccessmanagerkeydata) for more details. | | `getChannelGroups()`Type: `Map>` | Access rights per `channel group`. See [PNAccessManagerKeyData](#pnaccessmanagerkeydata) for more details. | #### PNAccessManagerKeyData | Method | Description | | --- | --- | | `isReadEnabled()`Type: Boolean | `true` if the user has `read` rights. | | `isWriteEnabled()`Type: Boolean | `true` if the user has `write` rights. | | `isManageEnabled()`Type: Boolean | `true` if the user has `manage` rights. | | `isDeleteEnabled()`Type: Boolean | `true` if the user has `delete` rights. | :::warning Size of revoke requests Access Manager grant or revoke requests must be less than ~32KiB at a time, or the client will return an error. For requests greater than 32KiB, break them into smaller batched requests. When the message size exceeds 32KiB the server returns the HTTP Error code 500, instead of the correct error code 414. ::: :::warning NTP configuration For NTP synchronization, please ensure that you have configured NTP on your server to keep the clock in sync. This is to prevent system clock drift leading to 400 `Invalid Timestamp` error response. Read the [support article](https://support.pubnub.com/hc/en-us/articles/360051973331-Why-do-I-get-Invalid-Timestamp-when-I-try-to-grant-permission-using-Access-Manager-) for more details. ::: ### Other examples #### Grant subscribe access to a channel only for clients with a specific auth_key with a 5 minute ttl ```java pubnub.grant() .channels(Arrays.asList("my_channel")) .write(false) .read(true) .authKeys(Arrays.asList("my_ro_authkey")) .ttl(5) .async(result -> { /* check result */ }); ``` The above code would return the following response to the client: ```java result.onSuccess(res -> { res.getTtl(); // 5 res.getLevel(); // user }) ``` #### Allow access to a specific channel for Presence ```java pubnub.grant() .channels(Arrays.asList("my_channel-pnpres")) .write(true) .read(true) .async(result -> { /* check result */ }); ``` #### Grant Access Manager permissions for channel group ```java pubnub.grant() .channelGroups(Arrays.asList("cg1", "cg2", "cg3")) // groups to allow grant on .authKeys(Arrays.asList("key1", "key2", "key3")) // the keys we are provisioning .write(true) // allow those keys to write (false by default) .manage(true) // allow those keys to manage channel groups (false by default) .read(true) // allow keys to read the subscribe feed (false by default) .ttl(12337) // how long those keys will remain valid (0 for eternity) .async(result -> { /* check result */ }); ``` The above code would return the following response to the client: ```java result.onSuccess(res -> { res.getTtl(); // 12337 res.getLevel(); // user }) ``` #### Application level grant :::warning 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.* ::: ```java pubnub.grant() .write(true) .read(true) .async(result -> { /* check result */ }); ``` #### Channel level grant ```java pubnub.grant() .channels(Arrays.asList("my_channel")) .write(true) .read(true) .async(result -> { /* check result */ }); ``` #### User level grant ```java pubnub.grant() .channels(Arrays.asList("my_channel")) .write(true) .read(true) .authKeys(Arrays.asList("my_authkey")) .ttl(5) .async(result -> { /* check result */ }); ``` #### UUID level grant ```java pubnub.grant() .uuids(Arrays.asList("uuid1", "uuid2")) // uuids to allow grant on .authKeys(Arrays.asList("key1")) // the keys you are provisioning .get(true) // allow those keys to get (false by default) .update(true) // allow those keys to update (false by default) .delete(true) // allow keys to delete (false by default) .ttl(60) // how long those keys will remain valid (0 for eternity) .async(result -> { /* check result */ }); ```