-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathcom.microsoft.aad.msal4j.AuthorizationCodeParameters.yml
122 lines (122 loc) · 10.2 KB
/
com.microsoft.aad.msal4j.AuthorizationCodeParameters.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
### YamlMime:JavaType
uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters"
name: "AuthorizationCodeParameters"
nameWithType: "AuthorizationCodeParameters"
summary: "Object containing parameters for authorization code flow."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **AuthorizationCodeParameters**</br> implements <xref href=\"com.microsoft.aad.msal4j.IAcquireTokenParameters?alt=com.microsoft.aad.msal4j.IAcquireTokenParameters&text=IAcquireTokenParameters\" data-throw-if-not-resolved=\"False\" />"
methods:
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.authorizationCode()"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.authorizationCode()"
name: "authorizationCode()"
nameWithType: "AuthorizationCodeParameters.authorizationCode()"
summary: "Authorization code acquired in the first step of OAuth2.0 authorization code flow."
syntax: "public @NonNull String authorizationCode()"
desc: "Authorization code acquired in the first step of OAuth2.0 authorization code flow. For more details, see https://aka.ms/msal4j-authorization-code-flow"
returns:
type: "<xref href=\"@lombok.NonNull java.lang.String?alt=@lombok.NonNull java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.builder(java.lang.String,java.net.URI)"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.builder(String authorizationCode, URI redirectUri)"
name: "builder(String authorizationCode, URI redirectUri)"
nameWithType: "AuthorizationCodeParameters.builder(String authorizationCode, URI redirectUri)"
summary: "Builder for <xref uid=\"com.microsoft.aad.msal4j.AuthorizationCodeParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthorizationCodeParameters\"></xref>"
modifiers:
- "static"
parameters:
- description: "code received from the service authorization endpoint"
name: "authorizationCode"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "URI where authorization code was received"
name: "redirectUri"
type: "<xref href=\"java.net.URI?alt=java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static AuthorizationCodeParameters.AuthorizationCodeParametersBuilder builder(String authorizationCode, URI redirectUri)"
desc: "Builder for <xref uid=\"com.microsoft.aad.msal4j.AuthorizationCodeParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthorizationCodeParameters\"></xref>"
returns:
description: "builder object that can be used to construct <xref uid=\"com.microsoft.aad.msal4j.AuthorizationCodeParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthorizationCodeParameters\"></xref>"
type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder?alt=com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder&text=AuthorizationCodeParametersBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.claims()"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.claims()"
name: "claims()"
nameWithType: "AuthorizationCodeParameters.claims()"
summary: "Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims"
syntax: "public ClaimsRequest claims()"
desc: "Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims"
returns:
type: "<xref href=\"com.microsoft.aad.msal4j.ClaimsRequest?alt=com.microsoft.aad.msal4j.ClaimsRequest&text=ClaimsRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.codeVerifier()"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.codeVerifier()"
name: "codeVerifier()"
nameWithType: "AuthorizationCodeParameters.codeVerifier()"
summary: "Code verifier used for PKCE."
syntax: "public String codeVerifier()"
desc: "Code verifier used for PKCE. For more details, see https://tools.ietf.org/html/rfc7636"
returns:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.extraHttpHeaders()"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.extraHttpHeaders()"
name: "extraHttpHeaders()"
nameWithType: "AuthorizationCodeParameters.extraHttpHeaders()"
summary: "Adds additional headers to the token request"
syntax: "public Map<String,String> extraHttpHeaders()"
desc: "Adds additional headers to the token request"
returns:
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.extraQueryParameters()"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.extraQueryParameters()"
name: "extraQueryParameters()"
nameWithType: "AuthorizationCodeParameters.extraQueryParameters()"
summary: "Adds additional query parameters to the token request"
syntax: "public Map<String,String> extraQueryParameters()"
desc: "Adds additional query parameters to the token request"
returns:
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.redirectUri()"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.redirectUri()"
name: "redirectUri()"
nameWithType: "AuthorizationCodeParameters.redirectUri()"
summary: "Redirect URI registered in the Azure portal, and which was used in the first step of OAuth2.0 authorization code flow."
syntax: "public @NonNull URI redirectUri()"
desc: "Redirect URI registered in the Azure portal, and which was used in the first step of OAuth2.0 authorization code flow. For more details, see https://aka.ms/msal4j-authorization-code-flow"
returns:
type: "<xref href=\"@lombok.NonNull java.net.URI?alt=@lombok.NonNull java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.scopes()"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.scopes()"
name: "scopes()"
nameWithType: "AuthorizationCodeParameters.scopes()"
summary: "Scopes to which the application is requesting access"
syntax: "public Set<String> scopes()"
desc: "Scopes to which the application is requesting access"
returns:
type: "<xref href=\"java.util.Set?alt=java.util.Set&text=Set\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.tenant()"
fullName: "com.microsoft.aad.msal4j.AuthorizationCodeParameters.tenant()"
name: "tenant()"
nameWithType: "AuthorizationCodeParameters.tenant()"
summary: "Overrides the tenant value in the authority URL for this request"
syntax: "public String tenant()"
desc: "Overrides the tenant value in the authority URL for this request"
returns:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Object containing parameters for authorization code flow. Can be used as parameter to <xref uid=\"com.microsoft.aad.msal4j.PublicClientApplication.acquireToken*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PublicClientApplication#acquireToken(AuthorizationCodeParameters)\"></xref> or to <xref uid=\"com.microsoft.aad.msal4j.ConfidentialClientApplication.acquireToken*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfidentialClientApplication#acquireToken(AuthorizationCodeParameters)\"></xref>"
implements:
- "<xref href=\"com.microsoft.aad.msal4j.IAcquireTokenParameters?alt=com.microsoft.aad.msal4j.IAcquireTokenParameters&text=IAcquireTokenParameters\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.aad.msal4j"
artifact: com.microsoft.azure:msal4j:1.17.2