Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetAuthenticationTokenOptions

Package version

Options for auth a client

Hierarchy

  • GetAuthenticationTokenOptions

Index

Properties

Properties

Optional roles

roles: string[]

The roles the client have. Roles give the client initial permissions to leave, join, or publish to groups when using PubSub subprotocol

  • webpubsub.joinLeaveGroup: the client can join or leave any group
  • webpubsub.sendToGroup: the client can send messages to any group
  • webpubsub.joinLeaveGroup.<group>: the client can join or leave group <group>
  • webpubsub.sendToGroup.<group>: the client can send messages to group <group>

https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions

Optional ttl

ttl: undefined | number

The time-to-live minutes for the access token. If not set, the default value is 60 minutes.

Optional userId

userId: undefined | string

The userId for the client

Generated using TypeDoc