Skip to content

Commit e8a1f7a

Browse files
SaisangSaisang
committed
Merege from live
2 parents e609a94 + 139691f commit e8a1f7a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+4917
-0
lines changed

‎docs-ref-autogen/@azure/msal-node/ApiId.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
### YamlMime:TSEnum
2+
name: ApiId
3+
uid: '@azure/msal-node.ApiId'
4+
package: '@azure/msal-node'
5+
summary: >-
6+
API Codes for Telemetry purposes.
7+
8+
Before adding a new code you must claim it in the MSAL Telemetry tracker as
9+
these number spaces are shared across all MSALs
10+
11+
0-99 Silent Flow
12+
13+
600-699 Device Code Flow
14+
15+
800-899 Auth Code Flow
16+
fullName: ApiId
17+
remarks: ''
18+
isPreview: false
19+
isDeprecated: false
20+
fields:
21+
- name: acquireTokenSilent
22+
uid: '@azure/msal-node.ApiId.acquireTokenSilent'
23+
package: '@azure/msal-node'
24+
summary: ''
25+
numericValue: 62
26+
- name: acquireTokenByUsernamePassword
27+
uid: '@azure/msal-node.ApiId.acquireTokenByUsernamePassword'
28+
package: '@azure/msal-node'
29+
summary: ''
30+
numericValue: 371
31+
- name: acquireTokenByDeviceCode
32+
uid: '@azure/msal-node.ApiId.acquireTokenByDeviceCode'
33+
package: '@azure/msal-node'
34+
summary: ''
35+
numericValue: 671
36+
- name: acquireTokenByClientCredential
37+
uid: '@azure/msal-node.ApiId.acquireTokenByClientCredential'
38+
package: '@azure/msal-node'
39+
summary: ''
40+
numericValue: 771
41+
- name: acquireTokenByCode
42+
uid: '@azure/msal-node.ApiId.acquireTokenByCode'
43+
package: '@azure/msal-node'
44+
summary: ''
45+
numericValue: 871
46+
- name: acquireTokenByRefreshToken
47+
uid: '@azure/msal-node.ApiId.acquireTokenByRefreshToken'
48+
package: '@azure/msal-node'
49+
summary: ''
50+
numericValue: 872

‎docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
### YamlMime:TSTypeAlias
2+
name: AuthorizationCodeRequest
3+
uid: '@azure/msal-node.AuthorizationCodeRequest'
4+
package: '@azure/msal-node'
5+
summary: >-
6+
Request object passed by user to acquire a token from the server exchanging a
7+
valid authorization code (second leg of OAuth2.0 Authorization Code flow)
8+
9+
- scopes - Array of scopes the application is requesting
10+
access to.
11+
12+
- claims - A stringified claims request which will be added
13+
to all /authorize and /token calls
14+
15+
- authority: - URL of the authority, the security token service
16+
(STS) from which MSAL will acquire tokens. If authority is set on client
17+
application object, this will override that value. Overriding the value will
18+
cause for authority validation to happen each time. If the same authority will
19+
be used for all request, set on the application object instead of the
20+
requests.
21+
22+
- correlationId - Unique GUID set per request to trace a request
23+
end-to-end for telemetry purposes.
24+
25+
- redirectUri - The redirect URI of your app, where the authority
26+
will redirect to after the user inputs credentials and consents. It must
27+
exactly match one of the redirect URIs you registered in the portal.
28+
29+
- tokenQueryParameters - String to string map of custom query parameters
30+
added to the /token call
31+
32+
- code - The authorization_code that the user acquired in
33+
the first leg of the flow.
34+
35+
- codeVerifier - The same code_verifier that was used to obtain the
36+
authorization_code. Required if PKCE was used in the authorization code grant
37+
request.For more information, see the PKCE RFC:
38+
https://tools.ietf.org/html/rfc7636
39+
40+
- state - Unique GUID generated by the user that is cached
41+
by the user and sent to the server during the first leg of the flow. This
42+
string is sent back by the server with the authorization code. The user cached
43+
state is then compared with the state received from the server to mitigate the
44+
risk of CSRF attacks. See
45+
https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.
46+
fullName: AuthorizationCodeRequest
47+
remarks: ''
48+
isPreview: false
49+
isDeprecated: false
50+
syntax: >
51+
type AuthorizationCodeRequest = Partial<
52+
Omit<
53+
CommonAuthorizationCodeRequest,
54+
| "scopes"
55+
| "redirectUri"
56+
| "code"
57+
| "authenticationScheme"
58+
| "resourceRequestMethod"
59+
| "resourceRequestUri"
60+
| "requestedClaimsHash"
61+
>
62+
> & { code: string, redirectUri: string, scopes: Array<string>, state?: string
63+
}

‎docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
### YamlMime:TSTypeAlias
2+
name: AuthorizationUrlRequest
3+
uid: '@azure/msal-node.AuthorizationUrlRequest'
4+
package: '@azure/msal-node'
5+
summary: >-
6+
Request object passed by user to retrieve a Code from the server (first leg of
7+
authorization code grant flow)
8+
9+
- scopes - Array of scopes the application is requesting
10+
access to.
11+
12+
- claims - A stringified claims request which will be
13+
added to all /authorize and /token calls
14+
15+
- authority - Url of the authority which the application
16+
acquires tokens from.
17+
18+
- correlationId - Unique GUID set per request to trace a request
19+
end-to-end for telemetry purposes.
20+
21+
- redirectUri - The redirect URI where authentication responses
22+
can be received by your application. It must exactly match one of the redirect
23+
URIs registered in the Azure portal.
24+
25+
- extraScopesToConsent - Scopes for a different resource when the user
26+
needs consent upfront.
27+
28+
- responseMode - Specifies the method that should be used to
29+
send the authentication result to your app. Can be query, form_post, or
30+
fragment. If no value is passed in, it defaults to query.
31+
32+
- codeChallenge - Used to secure authorization code grant via
33+
Proof of Key for Code Exchange (PKCE). For more information, see the PKCE
34+
RCF:https://tools.ietf.org/html/rfc7636
35+
36+
- codeChallengeMethod - The method used to encode the code verifier for
37+
the code challenge parameter. Can be "plain" or "S256". If excluded, code
38+
challenge is assumed to be plaintext. For more information, see the PKCE RCF:
39+
https://tools.ietf.org/html/rfc7636
40+
41+
- state - A value included in the request that is also
42+
returned in the token response. A randomly generated unique value is typically
43+
used for preventing cross site request forgery attacks. The state is also used
44+
to encode information about the user's state in the app before the
45+
authentication request occurred.
46+
47+
- prompt - Indicates the type of user interaction that is
48+
required.
49+
login: will force the user to enter their credentials on that request, negating single-sign on
50+
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
51+
consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app
52+
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
53+
create: will direct the user to the account creation experience instead of the log in experience
54+
- account - AccountInfo obtained from a getAccount API.
55+
Will be used in certain scenarios to generate login_hint if both loginHint and
56+
sid params are not provided.
57+
58+
- loginHint - Can be used to pre-fill the username/email
59+
address field of the sign-in page for the user, if you know the username/email
60+
address ahead of time. Often apps use this parameter during re-authentication,
61+
having already extracted the username from a previous sign-in using the
62+
preferred_username claim.
63+
64+
- sid - Session ID, unique identifier for the session.
65+
Available as an optional claim on ID tokens.
66+
67+
- domainHint - Provides a hint about the tenant or ___domain that
68+
the user should use to sign in. The value of the ___domain hint is a registered
69+
___domain for the tenant.
70+
71+
- extraQueryParameters - String to string map of custom query parameters
72+
added to the /authorize call
73+
74+
- tokenQueryParameters - String to string map of custom query parameters
75+
added to the /token call
76+
77+
- nonce - A value included in the request that is
78+
returned in the id token. A randomly generated unique value is typically used
79+
to mitigate replay attacks.
80+
fullName: AuthorizationUrlRequest
81+
remarks: ''
82+
isPreview: false
83+
isDeprecated: false
84+
syntax: |
85+
type AuthorizationUrlRequest = Partial<
86+
Omit<
87+
CommonAuthorizationUrlRequest,
88+
| "scopes"
89+
| "redirectUri"
90+
| "resourceRequestMethod"
91+
| "resourceRequestUri"
92+
| "authenticationScheme"
93+
| "requestedClaimsHash"
94+
>
95+
> & { redirectUri: string, scopes: Array<string> }

‎docs-ref-autogen/@azure/msal-node/CacheKVStore.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### YamlMime:TSTypeAlias
2+
name: CacheKVStore
3+
uid: '@azure/msal-node.CacheKVStore'
4+
package: '@azure/msal-node'
5+
summary: Key value store for in-memory cache
6+
fullName: CacheKVStore
7+
remarks: ''
8+
isPreview: false
9+
isDeprecated: false
10+
syntax: |
11+
type CacheKVStore = Record<string, ValidCacheType>

‎docs-ref-autogen/@azure/msal-node/CacheOptions.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### YamlMime:TSTypeAlias
2+
name: CacheOptions
3+
uid: '@azure/msal-node.CacheOptions'
4+
package: '@azure/msal-node'
5+
summary: |-
6+
Use this to configure the below cache configuration options:
7+
- cachePlugin - Plugin for reading and writing token cache to disk.
8+
fullName: CacheOptions
9+
remarks: ''
10+
isPreview: false
11+
isDeprecated: false
12+
syntax: |
13+
type CacheOptions = { cachePlugin?: ICachePlugin }

0 commit comments

Comments
 (0)