Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IdentityClient

Package version

Hierarchy

  • ServiceClient
    • IdentityClient

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

authorityHost

authorityHost: string

Protected Optional baseUri

baseUri: undefined | string

If specified, this is the base URI that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property.

Protected Optional requestContentType

requestContentType: undefined | string

The default request content type for the service. Used if no requestContentType is present on an OperationSpec.

Methods

createWebResource

  • createWebResource(requestOptions: RequestPrepareOptions): WebResource

refreshAccessToken

  • refreshAccessToken(tenantId: string, clientId: string, scopes: string, refreshToken: string | undefined, clientSecret: string | undefined, expiresOnParser?: undefined | function, options?: GetTokenOptions): Promise<TokenResponse | null>

  • Parameters

    • tenantId: string
    • clientId: string
    • scopes: string
    • refreshToken: string | undefined
    • clientSecret: string | undefined
    • Optional expiresOnParser: undefined | function
    • Optional options: GetTokenOptions

    Returns Promise<TokenResponse | null>

sendOperationRequest

  • sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

  • Send an HTTP request that is populated using the provided OperationSpec.

    Parameters

    • operationArguments: OperationArguments

      The arguments that the HTTP request's templated values will be populated from.

    • operationSpec: OperationSpec

      The OperationSpec to use to populate the httpRequest.

    • Optional callback: ServiceCallback<any>

      The callback to call when the response is received.

    Returns Promise<RestResponse>

sendRequest

  • sendRequest(options: RequestPrepareOptions | WebResource): Promise<HttpOperationResponse>

  • Send the provided httpRequest.

    Parameters

    • options: RequestPrepareOptions | WebResource

    Returns Promise<HttpOperationResponse>

sendTokenRequest

  • sendTokenRequest(webResource: WebResource, expiresOnParser?: undefined | function): Promise<TokenResponse | null>

Static getDefaultOptions

Generated using TypeDoc