UNPKG

@trimble-oss/trimble-id

Version:

Trimble Identity SDK for JavaScript/ TypeScript

52 lines (51 loc) 2.82 kB
import { IEndpointProvider } from "./IEndpointProvider" /** * @implements {IEndpointProvider} * @description OpenIdEndpointProvider helps to discover various endpoints like authorization_endpoint, token_endpoint, userinfo_endpoint etc. */ declare class OpenIdEndpointProvider implements IEndpointProvider { /** * @description Public constructor for OpenIdEndpointProvider class * @param {string} configurationEndpoint The URL for the Trimble Identity OpenID well known configuration endpoint * Production : https://id.trimble.com/.well-known/openid-configuration * @param {string=} tokenRevocationEndpoint The URL for the Trimble Identity token revocation endpoint, if not supplied this is computed relative to the token endpoint */ constructor(configurationEndpoint: string, tokenRevocationEndpoint?: string); /** * @description Retrieves a URL for the Trimble Identity authorization endpoint * @returns {PromiseLike<string>} A Task that resolves to the value of the URL on completion * @exception Thrown if the configuration endpoint returns an error */ RetrieveAuthorizationEndpoint(): Promise<string>; /** * @description Retrieves a URL for the Trimble Identity authorization endpoint * @returns {PromiseLike<string>} A Task that resolves to the value of the URL on completion * @exception Thrown if the configuration endpoint returns an error */ RetrieveTokenEndpoint(): Promise<string>; /** * @description Retrieves a URL for the Trimble Identity authorization endpoint * @returns {PromiseLike<string>} A Task that resolves to the value of the URL on completion * @exception Thrown if the configuration endpoint returns an error */ RetrieveUserInfoEndpoint(): Promise<string>; /** * @description Retrieves a URL for the Trimble Identity token revocation endpoint * @returns {PromiseLike<string>} A Task that resolves to the value of the URL on completion * @exception Thrown if the configuration endpoint returns an error */ RetrieveTokenRevocationEndpoint(): Promise<string>; /** * @description Retrieves a URL for the Trimble Identity end session endpoint * @returns {PromiseLike<string>} A Task that resolves to the value of the URL on completion * @exception Thrown if the configuration endpoint returns an error */ RetrieveEndSessionEndpoint(): Promise<string>; /** * @description Retrieves a URL for the Trimble Identity authorization endpoint * @returns {PromiseLike<string>} A Task that resolves to the value of the URL on completion * @exception Thrown if the configuration endpoint returns an error */ RetrieveJSONWebKeySetEndpoint(): Promise<string>; } export default OpenIdEndpointProvider