Reference

BackstageClient.deviceAuth

BackstageClient.deviceAuth in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / deviceAuth

deviceAuth: {
  issueToken: (request: {
     deviceId: string;
     deviceSecret: string;
   }, requestOptions?: RequestOptions) => Promise<{
     expiresInSeconds: number;
     token: string;
  }>;
  jwks: (requestOptions?: RequestOptions) => Promise<{
     keys: {
      [key: string]: unknown;
     }[];
     version: number;
  }>;
};

Defined in: client.ts:9679

Device Auth methods

issueToken()#

issueToken: (request: {
  deviceId: string;
  deviceSecret: string;
}, requestOptions?: RequestOptions) => Promise<{
  expiresInSeconds: number;
  token: string;
}>;

Mint a device token Exchange (deviceId, deviceSecret) for a short-lived device JWT.

Parameters#

Parameter	Type
`request`	{ `deviceId`: `string`; `deviceSecret`: `string`; }
`request.deviceId`	`string`
`request.deviceSecret?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ expiresInSeconds: number; token: string; }>

Operation Id#

issueDeviceToken

jwks()#

jwks: (requestOptions?: RequestOptions) => Promise<{
  keys: {
   [key: string]: unknown;
  }[];
  version: number;
}>;

Device JWKS Public keys for offline Local Command Token verification by relays.

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ keys: { [key: string]: unknown; }[]; version: number; }>

Operation Id#

getDeviceJwks