@azure/msal-common 14.13.1 → 14.14.1

package/dist/request/CommonAuthorizationUrlRequest.d.ts

@@ -1,51 +1,51 @@
-import { ResponseMode } from "../utils/Constants";
-import { StringDict } from "../utils/MsalTypes";
-import { BaseAuthRequest } from "./BaseAuthRequest";
-import { AccountInfo } from "../account/AccountInfo";
-/**
- * Request object passed by user to retrieve a Code from the server (first leg of authorization code grant flow)
- *
- * - scopes                     - Array of scopes the application is requesting access to.
- * - claims                     - A stringified claims request which will be added to all /authorize and /token calls
- * - authority                  - Url of the authority which the application acquires tokens from.
- * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - redirectUri                - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
- * - extraScopesToConsent       - Scopes for a different resource when the user needs consent upfront.
- * - responseMode               - Specifies the method that should be used to send the authentication result to your app. Can be query, form_post, or fragment. If no value is passed in, it defaults to query.
- * - codeChallenge              - Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). For more information, see the PKCE RCF:https://tools.ietf.org/html/rfc7636
- * - codeChallengeMethod        - The method used to encode the code verifier for the code challenge parameter. Can be "plain" or "S256". If excluded, code challenge is assumed to be plaintext. For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636
- * - state                      - A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.
- * - prompt                     - Indicates the type of user interaction that is required.
- *          login: will force the user to enter their credentials on that request, negating single-sign on
- *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
- *          consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app
- *          select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account
- *          create: will direct the user to the account creation experience instead of the log in experience
- *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
- * - account                    - AccountInfo obtained from a getAccount API. Will be used in certain scenarios to generate login_hint if both loginHint and sid params are not provided.
- * - loginHint                  - Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the preferred_username claim.
- * - sid                        - Session ID, unique identifier for the session. Available as an optional claim on ID tokens.
- * - domainHint                 - Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
- * - extraQueryParameters       - String to string map of custom query parameters added to the /authorize call
- * - tokenQueryParameters       - String to string map of custom query parameters added to the /token call
- * - nonce                      - A value included in the request that is returned in the id token. A randomly generated unique value is typically used to mitigate replay attacks.
- * - resourceRequestMethod      - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
- * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
- */
-export type CommonAuthorizationUrlRequest = BaseAuthRequest & {
-    redirectUri: string;
-    responseMode: ResponseMode;
-    account?: AccountInfo;
-    codeChallenge?: string;
-    codeChallengeMethod?: string;
-    domainHint?: string;
-    extraQueryParameters?: StringDict;
-    extraScopesToConsent?: Array<string>;
-    loginHint?: string;
-    nonce?: string;
-    prompt?: string;
-    sid?: string;
-    state?: string;
-    nativeBroker?: boolean;
-};
+import { ResponseMode } from "../utils/Constants";
+import { StringDict } from "../utils/MsalTypes";
+import { BaseAuthRequest } from "./BaseAuthRequest";
+import { AccountInfo } from "../account/AccountInfo";
+/**
+ * Request object passed by user to retrieve a Code from the server (first leg of authorization code grant flow)
+ *
+ * - scopes                     - Array of scopes the application is requesting access to.
+ * - claims                     - A stringified claims request which will be added to all /authorize and /token calls
+ * - authority                  - Url of the authority which the application acquires tokens from.
+ * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - redirectUri                - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
+ * - extraScopesToConsent       - Scopes for a different resource when the user needs consent upfront.
+ * - responseMode               - Specifies the method that should be used to send the authentication result to your app. Can be query, form_post, or fragment. If no value is passed in, it defaults to query.
+ * - codeChallenge              - Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). For more information, see the PKCE RCF:https://tools.ietf.org/html/rfc7636
+ * - codeChallengeMethod        - The method used to encode the code verifier for the code challenge parameter. Can be "plain" or "S256". If excluded, code challenge is assumed to be plaintext. For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636
+ * - state                      - A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred.
+ * - prompt                     - Indicates the type of user interaction that is required.
+ *          login: will force the user to enter their credentials on that request, negating single-sign on
+ *          none:  will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error
+ *          consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app
+ *          select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account
+ *          create: will direct the user to the account creation experience instead of the log in experience
+ *          no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY.
+ * - account                    - AccountInfo obtained from a getAccount API. Will be used in certain scenarios to generate login_hint if both loginHint and sid params are not provided.
+ * - loginHint                  - Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the preferred_username claim.
+ * - sid                        - Session ID, unique identifier for the session. Available as an optional claim on ID tokens.
+ * - domainHint                 - Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant.
+ * - extraQueryParameters       - String to string map of custom query parameters added to the /authorize call
+ * - tokenQueryParameters       - String to string map of custom query parameters added to the /token call
+ * - nonce                      - A value included in the request that is returned in the id token. A randomly generated unique value is typically used to mitigate replay attacks.
+ * - resourceRequestMethod      - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
+ * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
+ */
+export type CommonAuthorizationUrlRequest = BaseAuthRequest & {
+    redirectUri: string;
+    responseMode: ResponseMode;
+    account?: AccountInfo;
+    codeChallenge?: string;
+    codeChallengeMethod?: string;
+    domainHint?: string;
+    extraQueryParameters?: StringDict;
+    extraScopesToConsent?: Array<string>;
+    loginHint?: string;
+    nonce?: string;
+    prompt?: string;
+    sid?: string;
+    state?: string;
+    nativeBroker?: boolean;
+};
 //# sourceMappingURL=CommonAuthorizationUrlRequest.d.ts.map

package/dist/request/CommonClientCredentialRequest.d.ts

@@ -1,18 +1,18 @@
-import { BaseAuthRequest } from "./BaseAuthRequest";
-import { AzureRegion } from "../authority/AzureRegion";
-import { ClientAssertion } from "../account/ClientCredentials";
-/**
- * CommonClientCredentialRequest
- * - scopes                             - Array of scopes the application is requesting access to.
- * - authority                          - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
- * - correlationId                      - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - skipCache                          - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
- * - preferredAzureRegionOptions        - Options of the user's preferred azure region
- * - tokenQueryParameters               - String to string map of custom query parameters added to the /token call
- */
-export type CommonClientCredentialRequest = BaseAuthRequest & {
-    skipCache?: boolean;
-    azureRegion?: AzureRegion;
-    clientAssertion?: ClientAssertion;
-};
+import { BaseAuthRequest } from "./BaseAuthRequest";
+import { AzureRegion } from "../authority/AzureRegion";
+import { ClientAssertion } from "../account/ClientCredentials";
+/**
+ * CommonClientCredentialRequest
+ * - scopes                             - Array of scopes the application is requesting access to.
+ * - authority                          - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
+ * - correlationId                      - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - skipCache                          - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
+ * - preferredAzureRegionOptions        - Options of the user's preferred azure region
+ * - tokenQueryParameters               - String to string map of custom query parameters added to the /token call
+ */
+export type CommonClientCredentialRequest = BaseAuthRequest & {
+    skipCache?: boolean;
+    azureRegion?: AzureRegion;
+    clientAssertion?: ClientAssertion;
+};
 //# sourceMappingURL=CommonClientCredentialRequest.d.ts.map

package/dist/request/CommonDeviceCodeRequest.d.ts

@@ -1,22 +1,22 @@
-import { DeviceCodeResponse } from "../response/DeviceCodeResponse";
-import { StringDict } from "../utils/MsalTypes";
-import { BaseAuthRequest } from "./BaseAuthRequest";
-/**
- * Parameters for Oauth2 device code flow.
- * - scopes                     - Array of scopes the application is requesting access to.
- * - authority:                 - URL of the authority, the security token service (STS) from which MSAL will acquire tokens. If authority is set on client application object, this will override that value. Overriding the value will cause for authority validation to happen each time. If the same authority will be used for all request, set on the application object instead of the requests.
- * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - deviceCodeCallback         - Callback containing device code response. Message should be shown to end user. End user can then navigate to the verification_uri, input the user_code, and input credentials.
- * - cancel                     - Boolean to cancel polling of device code endpoint. While the user authenticates on a separate device, MSAL polls the the token endpoint of security token service for the interval specified in the device code response (usually 15 minutes). To stop polling and cancel the request, set cancel=true.
- * - resourceRequestMethod      - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
- * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
- * - timeout                    - Timeout period in seconds which the user explicitly configures for the polling of the device code endpoint. At the end of this period; assuming the device code has not expired yet; the device code polling is stopped and the request cancelled. The device code expiration window will always take precedence over this set period.
- * - extraQueryParameters       - String to string map of custom query parameters added to the query string
- */
-export type CommonDeviceCodeRequest = Omit<BaseAuthRequest, "tokenQueryParameters"> & {
-    deviceCodeCallback: (response: DeviceCodeResponse) => void;
-    cancel?: boolean;
-    timeout?: number;
-    extraQueryParameters?: StringDict;
-};
+import { DeviceCodeResponse } from "../response/DeviceCodeResponse";
+import { StringDict } from "../utils/MsalTypes";
+import { BaseAuthRequest } from "./BaseAuthRequest";
+/**
+ * Parameters for Oauth2 device code flow.
+ * - scopes                     - Array of scopes the application is requesting access to.
+ * - authority:                 - URL of the authority, the security token service (STS) from which MSAL will acquire tokens. If authority is set on client application object, this will override that value. Overriding the value will cause for authority validation to happen each time. If the same authority will be used for all request, set on the application object instead of the requests.
+ * - correlationId              - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - deviceCodeCallback         - Callback containing device code response. Message should be shown to end user. End user can then navigate to the verification_uri, input the user_code, and input credentials.
+ * - cancel                     - Boolean to cancel polling of device code endpoint. While the user authenticates on a separate device, MSAL polls the the token endpoint of security token service for the interval specified in the device code response (usually 15 minutes). To stop polling and cancel the request, set cancel=true.
+ * - resourceRequestMethod      - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
+ * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
+ * - timeout                    - Timeout period in seconds which the user explicitly configures for the polling of the device code endpoint. At the end of this period; assuming the device code has not expired yet; the device code polling is stopped and the request cancelled. The device code expiration window will always take precedence over this set period.
+ * - extraQueryParameters       - String to string map of custom query parameters added to the query string
+ */
+export type CommonDeviceCodeRequest = Omit<BaseAuthRequest, "tokenQueryParameters"> & {
+    deviceCodeCallback: (response: DeviceCodeResponse) => void;
+    cancel?: boolean;
+    timeout?: number;
+    extraQueryParameters?: StringDict;
+};
 //# sourceMappingURL=CommonDeviceCodeRequest.d.ts.map

package/dist/request/CommonEndSessionRequest.d.ts

@@ -1,22 +1,22 @@
-import { AccountInfo } from "../account/AccountInfo";
-import { StringDict } from "../utils/MsalTypes";
-/**
- * CommonEndSessionRequest
- * - account                - Account object that will be logged out of. All tokens tied to this account will be cleared.
- * - postLogoutRedirectUri  - URI to navigate to after logout page.
- * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - idTokenHint            - ID Token used by B2C to validate logout if required by the policy
- * - state                  - A value included in the request to the logout endpoint which will be returned in the query string upon post logout redirection
- * - logoutHint             - A string that specifies the account that is being logged out in order to skip the server account picker on logout
- * - extraQueryParameters   - String to string map of custom query parameters added to the /authorize call
- */
-export type CommonEndSessionRequest = {
-    correlationId: string;
-    account?: AccountInfo | null;
-    postLogoutRedirectUri?: string | null;
-    idTokenHint?: string;
-    state?: string;
-    logoutHint?: string;
-    extraQueryParameters?: StringDict;
-};
+import { AccountInfo } from "../account/AccountInfo";
+import { StringDict } from "../utils/MsalTypes";
+/**
+ * CommonEndSessionRequest
+ * - account                - Account object that will be logged out of. All tokens tied to this account will be cleared.
+ * - postLogoutRedirectUri  - URI to navigate to after logout page.
+ * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - idTokenHint            - ID Token used by B2C to validate logout if required by the policy
+ * - state                  - A value included in the request to the logout endpoint which will be returned in the query string upon post logout redirection
+ * - logoutHint             - A string that specifies the account that is being logged out in order to skip the server account picker on logout
+ * - extraQueryParameters   - String to string map of custom query parameters added to the /authorize call
+ */
+export type CommonEndSessionRequest = {
+    correlationId: string;
+    account?: AccountInfo | null;
+    postLogoutRedirectUri?: string | null;
+    idTokenHint?: string;
+    state?: string;
+    logoutHint?: string;
+    extraQueryParameters?: StringDict;
+};
 //# sourceMappingURL=CommonEndSessionRequest.d.ts.map

package/dist/request/CommonOnBehalfOfRequest.d.ts

@@ -1,14 +1,14 @@
-import { BaseAuthRequest } from "./BaseAuthRequest";
-/**
- * - scopes                  - Array of scopes the application is requesting access to.
- * - authority               - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
- * - correlationId           - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - oboAssertion            - The access token that was sent to the middle-tier API. This token must have an audience of the app making this OBO request.
- * - skipCache               - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
- * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
- */
-export type CommonOnBehalfOfRequest = BaseAuthRequest & {
-    oboAssertion: string;
-    skipCache?: boolean;
-};
+import { BaseAuthRequest } from "./BaseAuthRequest";
+/**
+ * - scopes                  - Array of scopes the application is requesting access to.
+ * - authority               - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
+ * - correlationId           - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - oboAssertion            - The access token that was sent to the middle-tier API. This token must have an audience of the app making this OBO request.
+ * - skipCache               - Skip token cache lookup and force request to authority to get a a new token. Defaults to false.
+ * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
+ */
+export type CommonOnBehalfOfRequest = BaseAuthRequest & {
+    oboAssertion: string;
+    skipCache?: boolean;
+};
 //# sourceMappingURL=CommonOnBehalfOfRequest.d.ts.map

package/dist/request/CommonRefreshTokenRequest.d.ts

@@ -1,23 +1,23 @@
-import { BaseAuthRequest } from "./BaseAuthRequest";
-import { CcsCredential } from "../account/CcsCredential";
-import { StringDict } from "../utils/MsalTypes";
-/**
- * CommonRefreshTokenRequest
- * - scopes                  - Array of scopes the application is requesting access to.
- * - claims                  - A stringified claims request which will be added to all /authorize and /token calls
- * - authority               - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
- * - correlationId           - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - refreshToken            - A refresh token returned from a previous request to the Identity provider.
- * - resourceRequestMethod   - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
- * - resourceRequestUri      - URI that token will be used for. Used for proof-of-possession flows.
- * - forceCache              - Force MSAL to cache a refresh token flow response when there is no account in the cache. Used for migration scenarios.
- * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
- */
-export type CommonRefreshTokenRequest = BaseAuthRequest & {
-    refreshToken: string;
-    ccsCredential?: CcsCredential;
-    forceCache?: boolean;
-    tokenBodyParameters?: StringDict;
-    redirectUri?: string;
-};
+import { BaseAuthRequest } from "./BaseAuthRequest";
+import { CcsCredential } from "../account/CcsCredential";
+import { StringDict } from "../utils/MsalTypes";
+/**
+ * CommonRefreshTokenRequest
+ * - scopes                  - Array of scopes the application is requesting access to.
+ * - claims                  - A stringified claims request which will be added to all /authorize and /token calls
+ * - authority               - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
+ * - correlationId           - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - refreshToken            - A refresh token returned from a previous request to the Identity provider.
+ * - resourceRequestMethod   - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
+ * - resourceRequestUri      - URI that token will be used for. Used for proof-of-possession flows.
+ * - forceCache              - Force MSAL to cache a refresh token flow response when there is no account in the cache. Used for migration scenarios.
+ * - tokenQueryParameters    - String to string map of custom query parameters added to the /token call
+ */
+export type CommonRefreshTokenRequest = BaseAuthRequest & {
+    refreshToken: string;
+    ccsCredential?: CcsCredential;
+    forceCache?: boolean;
+    tokenBodyParameters?: StringDict;
+    redirectUri?: string;
+};
 //# sourceMappingURL=CommonRefreshTokenRequest.d.ts.map

package/dist/request/CommonSilentFlowRequest.d.ts

@@ -1,28 +1,28 @@
-import { AccountInfo } from "../account/AccountInfo";
-import { StringDict } from "../utils/MsalTypes";
-import { BaseAuthRequest } from "./BaseAuthRequest";
-/**
- * SilentFlow parameters passed by the user to retrieve credentials silently
- * - scopes                 - Array of scopes the application is requesting access to.
- * - claims                 - A stringified claims request which will be added to all /authorize and /token calls. When included on a silent request, cache lookup will be skipped and token will be refreshed.
- * - authority              - Url of the authority which the application acquires tokens from.
- * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - account                - Account entity to lookup the credentials.
- * - forceRefresh           - Forces silent requests to make network calls if true.
- * - resourceRequestMethod  - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
- * - resourceRequestUri     - URI that token will be used for. Used for proof-of-possession flows.
- * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call
- */
-export type CommonSilentFlowRequest = BaseAuthRequest & {
-    /** Account object to lookup the credentials */
-    account: AccountInfo;
-    /** Skip cache lookup and forces network call(s) to get fresh tokens */
-    forceRefresh: boolean;
-    /** RedirectUri registered on the app registration - only required in brokering scenarios */
-    redirectUri?: string;
-    /** Key value pairs to include on the POST body to the /token endpoint */
-    tokenBodyParameters?: StringDict;
-    /** If refresh token will expire within the configured value, consider it already expired. Used to pre-emptively invoke interaction when cached refresh token is close to expiry. */
-    refreshTokenExpirationOffsetSeconds?: number;
-};
+import { AccountInfo } from "../account/AccountInfo";
+import { StringDict } from "../utils/MsalTypes";
+import { BaseAuthRequest } from "./BaseAuthRequest";
+/**
+ * SilentFlow parameters passed by the user to retrieve credentials silently
+ * - scopes                 - Array of scopes the application is requesting access to.
+ * - claims                 - A stringified claims request which will be added to all /authorize and /token calls. When included on a silent request, cache lookup will be skipped and token will be refreshed.
+ * - authority              - Url of the authority which the application acquires tokens from.
+ * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - account                - Account entity to lookup the credentials.
+ * - forceRefresh           - Forces silent requests to make network calls if true.
+ * - resourceRequestMethod  - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.).  Used for proof-of-possession flows.
+ * - resourceRequestUri     - URI that token will be used for. Used for proof-of-possession flows.
+ * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call
+ */
+export type CommonSilentFlowRequest = BaseAuthRequest & {
+    /** Account object to lookup the credentials */
+    account: AccountInfo;
+    /** Skip cache lookup and forces network call(s) to get fresh tokens */
+    forceRefresh: boolean;
+    /** RedirectUri registered on the app registration - only required in brokering scenarios */
+    redirectUri?: string;
+    /** Key value pairs to include on the POST body to the /token endpoint */
+    tokenBodyParameters?: StringDict;
+    /** If refresh token will expire within the configured value, consider it already expired. Used to pre-emptively invoke interaction when cached refresh token is close to expiry. */
+    refreshTokenExpirationOffsetSeconds?: number;
+};
 //# sourceMappingURL=CommonSilentFlowRequest.d.ts.map

package/dist/request/CommonUsernamePasswordRequest.d.ts

@@ -1,18 +1,18 @@
-import { BaseAuthRequest } from "./BaseAuthRequest";
-/**
- * CommonUsernamePassword parameters passed by the user to retrieve credentials
- * Note: The latest OAuth 2.0 Security Best Current Practice disallows the password grant entirely. This flow is added for internal testing.
- *
- * - scopes                 - Array of scopes the application is requesting access to.
- * - claims                 - A stringified claims request which will be added to all /authorize and /token calls. When included on a silent request, cache lookup will be skipped and token will be refreshed.
- * - authority              - Url of the authority which the application acquires tokens from.
- * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
- * - username               - username of the client
- * - password               - credentials
- * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call
- */
-export type CommonUsernamePasswordRequest = BaseAuthRequest & {
-    username: string;
-    password: string;
-};
+import { BaseAuthRequest } from "./BaseAuthRequest";
+/**
+ * CommonUsernamePassword parameters passed by the user to retrieve credentials
+ * Note: The latest OAuth 2.0 Security Best Current Practice disallows the password grant entirely. This flow is added for internal testing.
+ *
+ * - scopes                 - Array of scopes the application is requesting access to.
+ * - claims                 - A stringified claims request which will be added to all /authorize and /token calls. When included on a silent request, cache lookup will be skipped and token will be refreshed.
+ * - authority              - Url of the authority which the application acquires tokens from.
+ * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - username               - username of the client
+ * - password               - credentials
+ * - tokenQueryParameters   - String to string map of custom query parameters added to the /token call
+ */
+export type CommonUsernamePasswordRequest = BaseAuthRequest & {
+    username: string;
+    password: string;
+};
 //# sourceMappingURL=CommonUsernamePasswordRequest.d.ts.map

package/dist/request/NativeRequest.d.ts

@@ -1,20 +1,20 @@
-import { StringDict } from "../utils/MsalTypes";
-export type NativeRequest = {
-    clientId: string;
-    authority: string;
-    correlationId: string;
-    redirectUri: string;
-    scopes: Array<string>;
-    claims?: string;
-    authenticationScheme?: string;
-    resourceRequestMethod?: string;
-    resourceRequestUri?: string;
-    shrNonce?: string;
-    accountId?: string;
-    forceRefresh?: boolean;
-    extraParameters?: StringDict;
-    extraScopesToConsent?: Array<string>;
-    loginHint?: string;
-    prompt?: string;
-};
+import { StringDict } from "../utils/MsalTypes";
+export type NativeRequest = {
+    clientId: string;
+    authority: string;
+    correlationId: string;
+    redirectUri: string;
+    scopes: Array<string>;
+    claims?: string;
+    authenticationScheme?: string;
+    resourceRequestMethod?: string;
+    resourceRequestUri?: string;
+    shrNonce?: string;
+    accountId?: string;
+    forceRefresh?: boolean;
+    extraParameters?: StringDict;
+    extraScopesToConsent?: Array<string>;
+    loginHint?: string;
+    prompt?: string;
+};
 //# sourceMappingURL=NativeRequest.d.ts.map

package/dist/request/NativeSignOutRequest.d.ts

@@ -1,6 +1,6 @@
-export type NativeSignOutRequest = {
-    clientId: string;
-    accountId: string;
-    correlationId: string;
-};
+export type NativeSignOutRequest = {
+    clientId: string;
+    accountId: string;
+    correlationId: string;
+};
 //# sourceMappingURL=NativeSignOutRequest.d.ts.map