---
source_url: https://www.pubnub.com/docs/sdks/kotlin/api-reference/access-manager
title: Access Manager v3 API for Kotlin SDK
updated_at: 2026-05-22T11:06:51.584Z
sdk_name: PubNub Kotlin SDK
sdk_version: 13.3.0
---

> 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 Kotlin SDK

PubNub Kotlin SDK, use the latest version: 13.3.0

Install:

```bash
Add PubNub dependency to your build@13.3.0
```

:::warning Access Manager isn't enabled by default
Without it, PubNub resources on this keyset have no access controls and clients can reach
channels
and metadata without permission checks. Enable Access Manager in
[Admin Portal](https://admin.pubnub.com/)
before deploying to production.
:::

:::warning Breaking changes in v9.0.0
PubNub Kotlin SDK version 9.0.0 unifies the codebases for Kotlin and [Java](https://www.pubnub.com/docs/sdks/java) 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/kotlin/status-events). These changes can impact applications built with previous versions (< `9.0.0` ) of the Kotlin 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).
:::

:::tip Gradle compatibility
While older Gradle versions might work, we recommend using Gradle 6.8+ to ensure proper dependency resolution and avoid potential compatibility issues with the SDK's dependencies.
:::

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](https://www.pubnub.com/docs/general/security/access-control#authorized-uuid) 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.

:::note 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](https://www.pubnub.com/docs/general/setup/users-and-devices#set-the-user-id).
:::

For more information about Access Manager v3, refer to [Manage Permissions with Access Manager v3](https://www.pubnub.com/docs/general/security/access-control).

:::tip Request execution
Most PubNub Kotlin SDK method invocations return an Endpoint object, which allows you to decide whether to perform the operation synchronously or asynchronously.
You must invoke the `.sync()` or `.async()` method on the Endpoint to execute the request, or the operation **will not** be performed.
```kotlin
val channel = pubnub.channel("channelName")
channel.publish("This SDK rules!").async { result ->
    result.onFailure { exception ->
        // Handle error
    }.onSuccess { value ->
        // Handle successful method result
    }
}
```
:::

## 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/kotlin/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 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 |
| --- | --- |
| `channel` | `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 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).

For more details, see [TTL in Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#ttl).

###### RegEx patterns

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. Patterns are evaluated on the server using [RE2-style syntax](https://github.com/google/re2/wiki/Syntax); backreferences and lookaround assertions are not supported.

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 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](https://www.pubnub.com/docs/general/security/access-control#authorized-uuid).

### Method(s)

```kotlin
grantToken(
  ttl: Integer,
  meta: Any,
  authorizedUUID: String,
  channels: List<ChannelGrant>
  channelGroups: List<ChannelGroupGrant>
  uuids: List<UUIDGrant>)
```

| 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<Channel>`Default: n/a | All channel grants provided either as a list or a RegEx pattern. |
| `channelGroups`Type: `list<ChannelGroupGrant>`Default: n/a | All channel group grants provided either as a list or a RegEx pattern. |
| `uuids`Type: `list<UUIDGrant>`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

:::tip 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.
:::

```kotlin
import com.google.gson.JsonObject
import com.pubnub.api.PubNub
import com.pubnub.api.UserId
import com.pubnub.api.enums.PNStatusCategory
import com.pubnub.api.models.consumer.PNStatus
import com.pubnub.api.models.consumer.access_manager.v3.ChannelGrant
import com.pubnub.api.models.consumer.pubsub.PNMessageResult
import com.pubnub.api.models.consumer.pubsub.PNPresenceEventResult
import com.pubnub.api.v2.callbacks.EventListener
import com.pubnub.api.v2.callbacks.StatusListener
import com.pubnub.api.v2.subscriptions.SubscriptionOptions

fun main() {
    // REPLACE THESE WITH YOUR ACTUAL KEYS from your PubNub Admin Portal
    // For demonstration purposes only - these won't work without your own keys
    val mySubscribeKey = "demo" // Replace with actual subscribe key
    val myPublishKey = "demo" // Replace with actual publish key
    val mySecretKey = "mySecretKey" // Replace with actual secret key

    // Configure PubNub with secret key (needed for token generation)
    // Note: Only server-side applications should use the secret key
    val config = com.pubnub.api.v2.PNConfiguration.builder(UserId("server-admin"), mySubscribeKey).apply {
        publishKey = myPublishKey
        secretKey = mySecretKey // Secret key is required for generating tokens
    }

    val adminPubNub = PubNub.create(config.build())

    println("Step 1: Generate a token for a client")
    println("Note: This requires valid PubNub keys with Access Manager enabled")

    // Demo channel we'll use
    val myChannel = "token-demo-channel"

    // Generate a token with specific permissions for a client
    adminPubNub.grantToken(
        ttl = 15, // 15 minutes token lifetime
        authorizedUUID = "client-user", // The client that will use this token
        channels = listOf(
            // Grant read/write access to our demo channel
            ChannelGrant.name(name = myChannel, read = true, write = true),
            // Grant read-only access to any channel matching "readonly-*"
            ChannelGrant.pattern(pattern = "^readonly-.*$", read = true)
        )
    ).async { result ->
        result.onFailure { exception ->
            println("Failed to generate token: ${exception.message}")
            println("\nNOTE: If you see 'Invalid signature' error, make sure:")
            println("1. You've replaced the demo keys with your actual PubNub keys")
            println("2. Access Manager is enabled for your keys in the PubNub Admin Portal")
            println("3. Your secret key is correct")
            exception.printStackTrace()
        }.onSuccess { tokenResult ->
            println("✅ Token generated successfully!")
            val token = tokenResult.token
            println("Token: $token")

            // Step 2: Now create a client PubNub instance that uses this token
            useTokenAsClient(token, myChannel, mySubscribeKey, myPublishKey)
        }
    }

    // Keep the program running long enough for async operations
    Thread.sleep(20000)

    // Clean up
    adminPubNub.destroy()
}

/**
 * This function demonstrates using a token as a client
 */
fun useTokenAsClient(token: String, channelName: String, subscribeKey: String, publishKey: String) {
    println("\nStep 2: Initialize client with the token")

    // Configure client PubNub instance with the token
    val clientConfig = com.pubnub.api.v2.PNConfiguration.builder(UserId("client-user"), subscribeKey).apply {
        this.publishKey = publishKey
        // Set the token that we received from the server
        authToken = token
    }

    val clientPubNub = PubNub.create(clientConfig.build())

    // Define the message we'll publish
    val myMessage = JsonObject().apply {
        addProperty("sender", "client-user")
        addProperty("content", "Hello from a token-authorized client!")
        addProperty("timestamp", System.currentTimeMillis())
    }

    println("Message to send: $myMessage")

    // Add listeners for connection status
    clientPubNub.addListener(object : StatusListener {
        override fun status(pubnub: PubNub, status: PNStatus) {
            when (status.category) {
                PNStatusCategory.PNConnectedCategory -> println("Connected/Reconnected")
                PNStatusCategory.PNDisconnectedCategory,
                PNStatusCategory.PNUnexpectedDisconnectCategory -> println("Disconnected/Unexpectedly Disconnected")
                else -> {
                    if (status.error) {
                        println("Error status: ${status.category}")
                    }
                }
            }
        }
    })

    // Setup channel subscription
    val channel = clientPubNub.channel(channelName)
    val options = SubscriptionOptions.receivePresenceEvents()
    val subscription = channel.subscription(options)

    // Add a listener
    subscription.addListener(object : EventListener {
        override fun message(pubnub: PubNub, result: PNMessageResult) {
            println("📩 Received message: ${result.message.asJsonObject}")
        }

        override fun presence(pubnub: PubNub, result: PNPresenceEventResult) {
            println("Presence event: $result")
        }
    })

    // Subscribe to the channel
    println("\nStep 3: Subscribe to channel $channelName")
    subscription.subscribe()

    // Wait for connection to establish
    Thread.sleep(3000)

    // Publish a message
    println("\nStep 4: Publish a message to $channelName")
    channel.publish(myMessage).async { result ->
        result.onFailure { exception ->
            println("❌ Error while publishing: ${exception.message}")
            exception.printStackTrace()
        }.onSuccess { value ->
            println("✅ Message sent successfully, timetoken: ${value.timetoken}")
        }
    }

    // Wait to see if we receive the message
    Thread.sleep(5000)

    // Test if we can publish to a channel we don't have access to
    println("\nStep 5: Try to publish to a channel we don't have write access to")
    val restrictedChannel = clientPubNub.channel("restricted-channel")
    restrictedChannel.publish(myMessage).async { result ->
        result.onFailure { exception ->
            println("Expected error (we don't have access): ${exception.message}")
        }.onSuccess { value ->
            println("This shouldn't succeed as we don't have access to this channel")
        }
    }

    // Clean up before exiting
    Thread.sleep(5000)
    subscription.unsubscribe()
    clientPubNub.destroy()
    println("\n✅ Example completed")
}
```

### 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`.

```kotlin
pubnub.grantToken(
    ttl = 15,
    authorizedUUID = "my-authorized-uuid",
    channels = listOf(
        ChannelGrant.name(name = "channel-a", read = true),
        ChannelGrant.name(name = "channel-b", read = true, write = true),
        ChannelGrant.name(name = "channel-c", read = true, write = true),
        ChannelGrant.name(name = "channel-d", read = true, write = true)
    ),
    channelGroups = listOf(
        ChannelGroupGrant.id(id = "channel-group-b", read = true)
    ),
    uuids = listOf(
        UUIDGrant.id(id = "uuid-c", get = true),
        UUIDGrant.id(id = "uuid-d", get = true, update = true)
    )
).async { result ->
    result.onFailure { exception ->
        // Handle error
    }.onSuccess { value ->
        // Handle successful method 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.

```kotlin
pubnub.grantToken(
    ttl = 15,
    authorizedUUID = "my-authorized-uuid",
    channels = listOf(
        ChannelGrant.pattern(pattern = "^channel-[A-Za-z0-9]*$", read = true)
    )
)
    .async { result ->
        result.onFailure { exception ->
            // Handle error
        }.onSuccess { value ->
            // Handle successful method 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.

```kotlin
pubnub.grantToken(
    ttl = 15,
    authorizedUUID = "my-authorized-uuid",
    channels = listOf(
        ChannelGrant.name(name = "channel-a", read = true),
        ChannelGrant.name(name = "channel-b", read = true, write = true),
        ChannelGrant.name(name = "channel-c", read = true, write = true),
        ChannelGrant.name(name = "channel-d", read = true, write = true),
        ChannelGrant.pattern(pattern = "^channel-[A-Za-z0-9]*$", read = true)
    ),
    channelGroups = listOf(
        ChannelGroupGrant.id(id = "channel-group-b", read = true)
    ),
    uuids = listOf(
        UUIDGrant.id(id = "uuid-c", get = true),
        UUIDGrant.id(id = "uuid-d", get = true, update = true)
    )
)
    .async { result ->
        result.onFailure { exception ->
            // Handle error
        }.onSuccess { value ->
            // Handle successful method result
        }
    }
```

### 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](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 permissions. The server returns the details of the error as a string under the `PubNubException` class.

## Grant token - spaces & users

:::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 `grantToken()` method generates a time-limited authorization token with an embedded access control list. The token defines time to live (`ttl`), `authorizedUserId`, and a set of permissions giving access to one or more resources:

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

Only this `authorizedUserId` 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.

* 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 `space-1` and `write` to `space-2`).

###### 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 |
| --- | --- |
| `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](https://www.pubnub.com/docs/general/security/access-control#permissions).

###### TTL (time to live)

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

For more details, see [TTL in Access Manager v3](https://www.pubnub.com/docs/general/security/access-control#ttl).

###### RegEx patterns

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](https://www.pubnub.com/docs/general/security/access-control#regex).

###### Authorized user ID

Setting an `authorizedUserId` 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 `authorizedUserId` isn't specified during the grant request, the token can be used by any client with any `userId`. It's recommended to restrict tokens to a single `authorizedUserId` 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)

```kotlin
grantToken(
  ttl: Int,
  meta: Any?,
  authorizedUserId: UserId?,
  spacesPermissions: List<SpacePermissions>,
  usersPermissions: List<UserPermissions>,
)
```

| Parameter | Description |
| --- | --- |
| `ttl` *Type: `Int`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. |
| `authorizedUserId`Type: `UserId`Default: n/a | Single `userId` which is authorized to use the token to make API requests to PubNub. |
| `spacesPermissions`Type: `List<SpacePermissions>`Default: n/a | All Space permissions provided as a list of individual permissions or RegEx patterns. |
| `usersPermissions`Type: `List<UserPermissions>`Default: n/a | All User permissions provided as a list of individual permissions or RegEx patterns. |

:::note Required key/value mappings
For a successful request, you must specify permissions for at least one User or Space, either as a resource list or as a pattern (RegEx).
:::

### Sample code

```kotlin
pubnub.grantToken(
    ttl = 15,
    authorizedUserId = UserId("my-authorized-userId"),
    spacesPermissions = listOf(SpacePermissions.id(spaceId = SpaceId("my-space"), read = true))
)
    .async { result ->
        result.onFailure { exception ->
            // Handle error
        }.onSuccess { value ->
            // Handle successful method 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-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`.

```kotlin
pubnub.grantToken(
    ttl = 15,
    authorizedUserId = UserId("my-authorized-userId"),
    spacesPermissions = listOf(
        SpacePermissions.id(spaceId = SpaceId("channel-a"), read = true),
        SpacePermissions.id(spaceId = SpaceId("channel-b"), read = true, write = true),
        SpacePermissions.id(spaceId = SpaceId("channel-c"), read = true, write = true),
        SpacePermissions.id(spaceId = SpaceId("channel-d"), read = true, write = true)
    ),
    usersPermissions = listOf(
        UserPermissions.id(userId = UserId("userId-c"), get = true),
        UserPermissions.id(userId = UserId("userId-d"), get = true, update = true)
    )
)
    .async { result ->
        result.onFailure { exception ->
            // Handle error
        }.onSuccess { value ->
            // Handle successful method result
        }
    }
```

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

```kotlin
pubnub.grantToken(
    ttl = 15,
    authorizedUserId = UserId("my-authorized-userId"),
    spacesPermissions = listOf(
        SpacePermissions.pattern(pattern = "^space-[A-Za-z0-9]*$", read = true)
    )
)
    .async { result ->
        result.onFailure { exception ->
            // Handle error
        }.onSuccess { value ->
            // Handle successful method result
        }
    }
```

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

```kotlin
pubnub.grantToken(
    ttl = 15,
    authorizedUserId = UserId("my-authorized-userId"),
    spacesPermissions = listOf(
        SpacePermissions.pattern(pattern = "^space-[A-Za-z0-9]*$", read = true)
    )
)
    .async { result ->
        result.onFailure { exception ->
            // Handle error
        }.onSuccess { value ->
            // Handle successful method result
        }
    }
```

### 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](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 permissions. The server returns the details of the error as a string under the `PubNubException` class.

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

:::note Enable token revoke
To revoke tokens, you must first enable this feature on the [Admin Portal](https://admin.pubnub.com/). 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)

```kotlin
revokeToken(token: String)
```

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

### Sample code

```kotlin
pubnub.revokeToken("p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenV")
```

### Returns

When the token revocation request is successful, this method returns a `Unit`.

### 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)

```kotlin
parseToken(String token)
```

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

### Sample code

```kotlin
pubnub.parseToken(
    "qEF2AkF0Gmgi5mVDdHRsGQU5Q3Jlc6VEY2hhbqFnc3BhY2UwMQhDZ3JwoENzcGOgQ3VzcqBEdXVpZKFmdXNlcjAxGCBDcGF0pURjaGFuoWdzcGFjZS4qAUNncnCgQ3NwY6BDdXNyoER1dWlkoWZ1c2VyLioYIERtZXRhoER1dWlkbmF1dGhvcml6ZWRVc2VyQ3NpZ1ggkOSK0vQY5LFE5IHctQ6rGokqHbRH8EopbQRGAbU7Zfo="
)
```

### 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)

```kotlin
setToken(String token)
```

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

### Sample code

```kotlin
pubnub.setToken(
    "qEF2AkF0Gmgi5mVDdHRsGQU5Q3Jlc6VEY2hhbqFnc3BhY2UwMQhDZ3JwoENzcGOgQ3VzcqBEdXVpZKFmdXNlcjAxGCBDcGF0pURjaGFuoWdzcGFjZS4qAUNncnCgQ3NwY6BDdXNyoER1dWlkoWZ1c2VyLioYIERtZXRhoER1dWlkbmF1dGhvcml6ZWRVc2VyQ3NpZ1ggkOSK0vQY5LFE5IHctQ6rGokqHbRH8EopbQRGAbU7Zfo="
)
```

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