Class MixedRealityStsClient

Package version

Represents the Mixed Reality STS client for retrieving STS tokens used to access Mixed Reality services.

Hierarchy

MixedRealityStsClient

Index

Constructors

constructor

Properties

Methods

getToken

Constructors

constructor

new MixedRealityStsClient(accountId: string, accountDomain: string, keyCredential: AzureKeyCredential, options?: MixedRealityStsClientOptions): MixedRealityStsClient
new MixedRealityStsClient(accountId: string, accountDomain: string, credential: TokenCredential, options?: MixedRealityStsClientOptions): MixedRealityStsClient

- Defined in mixedRealityStsClient.ts:40
Creates an instance of a MixedRealityStsClient.

Parameters
- accountId: string
  
  The Mixed Reality service account identifier.
- accountDomain: string
  
  The Mixed Reality service account domain.
- keyCredential: AzureKeyCredential
  
  The Mixed Reality service account primary or secondary key credential.
- Optional options: MixedRealityStsClientOptions
  
  Additional client options.
Returns MixedRealityStsClient
- Defined in mixedRealityStsClient.ts:54
Creates an instance of a MixedRealityStsClient.

Parameters
- accountId: string
  
  The Mixed Reality service account identifier.
- accountDomain: string
  
  The Mixed Reality service account domain.
- credential: TokenCredential
  
  The credential used to access the Mixed Reality service.
- Optional options: MixedRealityStsClientOptions
  
  Additional client options.
Returns MixedRealityStsClient

Properties

accountId

accountId: string

Gets the Mixed Reality service account identifier.

endpointUrl

endpointUrl: string

Gets the Mixed Reality STS service endpoint.

Methods

getToken

getToken(options?: GetTokenOptions): Promise<AccessToken>

- Defined in mixedRealityStsClient.ts:148
Retrieve a token from the STS service.

Parameters
- Default value options: GetTokenOptions = {}
  
  Operation options.
Returns Promise<AccessToken>

Generated using TypeDoc