Initialize a client SDK with an auth key

Showing JavaScript examples.

After your server grants a token, the client sets it as the authKey and sends it with every subsequent PubNub API call. This page covers two operations: setting the token at initialization and updating it after the client is already running.

Before you start

Confirm you have:

Access Manager enabled on your keyset. See Configure access control.
A server that grants tokens. See Grant, change, and revoke permissions.
A token received from your server for the current user.

Initialize with an auth key

Set the token in the SDK configuration when the client starts. The client sends it with every PubNub API call until you replace it.

1const pubnub = new PubNub({
2  subscribeKey: "mySubscribeKey",
3  publishKey: "myPublishKey",
4  userId: "myUniqueUserId",
5  authKey: "yourAuthKey"
6});

1from pubnub.pnconfiguration import PNConfiguration
2from pubnub.pubnub import PubNub
3

4pnconfig = PNConfiguration()
5pnconfig.subscribe_key = "my_subscribe_key"
6pnconfig.publish_key = "my_publish_key"
7pnconfig.user_id = "my_unique_user_id"
8pnconfig.auth_key = "your_auth_key"
9pnconfig.ssl = True
10

11pubnub = PubNub(pnconfig)

1import PubNub
2

3let config = PubNubConfiguration(
4  publishKey: "myPublishKey",
5  subscribeKey: "mySubscribeKey",
6  userId: "myUniqueUserId",
7  authKey: "yourAuthKey"
8)
9

10let pubnub = PubNub(configuration: config)

1#import <PubNub/PubNub.h>
2

3PNConfiguration *config = [PNConfiguration configurationWithPublishKey:@"myPublishKey"
4                                                           subscribeKey:@"mySubscribeKey"
5                                                                 userID:@"myUniqueUserId"];
6config.authKey = @"yourAuthKey";
7

8self.client = [PubNub clientWithConfiguration:config];

1package main
2

3import pubnub "github.com/pubnub/go"
4

5func main() {
6    config := pubnub.NewConfigWithUserId("myUniqueUserId")
7    config.SubscribeKey = "mySubscribeKey"
8    config.PublishKey = "myPublishKey"
9    config.AuthKey = "yourAuthKey"
10    config.Secure = true
11

12    pn := pubnub.NewPubNub(config)
13}

1using PubnubApi;
2

3PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
4pnConfiguration.SubscribeKey = "mySubscribeKey";
5pnConfiguration.PublishKey = "myPublishKey";
6pnConfiguration.AuthKey = "yourAuthKey";
7pnConfiguration.Secure = true;
8

9Pubnub pubnub = new Pubnub(pnConfiguration);

1using PubnubApi;
2

3PNConfiguration pnConfiguration = new PNConfiguration(new UserId("myUniqueUserId"));
4pnConfiguration.SubscribeKey = "mySubscribeKey";
5pnConfiguration.PublishKey = "myPublishKey";
6pnConfiguration.AuthKey = "yourAuthKey";
7pnConfiguration.Secure = true;
8

9Pubnub pubnub = new Pubnub(pnConfiguration);

1import 'package:pubnub/pubnub.dart';
2

3final myKeyset = Keyset(
4  subscribeKey: 'mySubscribeKey',
5  publishKey: 'myPublishKey',
6  authKey: 'yourAuthKey',
7  userId: UserId('myUniqueUserId'),
8);
9

10final pubnub = PubNub(defaultKeyset: myKeyset);

1use PubNub\PNConfiguration;
2use PubNub\PubNub;
3

4$pnConfiguration = new PNConfiguration();
5$pnConfiguration->setSubscribeKey("mySubscribeKey");
6$pnConfiguration->setPublishKey("myPublishKey");
7$pnConfiguration->setUserId("myUniqueUserId");
8$pnConfiguration->setAuthKey("yourAuthKey");
9$pnConfiguration->setSecure(true);
10

11$pubnub = new PubNub($pnConfiguration);

Update the token after initialization

When your server issues a new token (for example, after a permission change or token refresh), set it on the running client instance using setToken. The client uses the new token for all subsequent calls.

1pubnub.setToken("newToken")

Grant, change, and revoke permissions. Issue tokens from your server.
Check available permissions. Decode a token to inspect its permissions.
Change or extend access. Strategies for keeping tokens current.
Update an expired token. Handle 403 errors when a token has expired.

Before you start​

Initialize with an auth key​

Update the token after initialization​

New SDK available

Related pages​

Before you start

Initialize with an auth key

Update the token after initialization

Related pages