-
Notifications
You must be signed in to change notification settings - Fork 6
/
HybridSpaAuthorizationCodeClient.yml
184 lines (172 loc) · 5.91 KB
/
HybridSpaAuthorizationCodeClient.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
### YamlMime:TSType
name: HybridSpaAuthorizationCodeClient
uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient'
package: '@azure/msal-browser'
summary: ''
fullName: HybridSpaAuthorizationCodeClient
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: HybridSpaAuthorizationCodeClient(ClientConfiguration)
uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.constructor'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'new HybridSpaAuthorizationCodeClient(config: ClientConfiguration)'
parameters:
- id: config
type: ClientConfiguration
description: ''
inheritedProperties:
- name: authority
uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.authority'
package: '@azure/msal-browser'
summary: ''
fullName: authority
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'authority: Authority'
return:
description: ''
type: Authority
inheritanceDescription: <b>Inherited From</b> BaseClient.authority
- name: logger
uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.logger'
package: '@azure/msal-browser'
summary: ''
fullName: logger
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'logger: Logger'
return:
description: ''
type: Logger
inheritanceDescription: <b>Inherited From</b> BaseClient.logger
inheritedMethods:
- name: 'acquireToken(CommonAuthorizationCodeRequest, AuthorizationCodePayload)'
uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.acquireToken'
package: '@azure/msal-browser'
summary: >-
API to acquire a token in exchange of 'authorization_code` acquired by the
user in the first leg of the
authorization_code_grant
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function acquireToken(request: CommonAuthorizationCodeRequest,
authCodePayload?: AuthorizationCodePayload):
Promise<AuthenticationResult>
parameters:
- id: request
type: CommonAuthorizationCodeRequest
description: |+
- id: authCodePayload
type: AuthorizationCodePayload
description: ''
return:
description: ''
type: Promise<AuthenticationResult>
inheritanceDescription: <b>Inherited From</b> AuthorizationCodeClient.acquireToken
- name: getAuthCodeUrl(CommonAuthorizationUrlRequest)
uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.getAuthCodeUrl'
package: '@azure/msal-browser'
summary: >-
Creates the URL of the authorization request letting the user input
credentials and consent to the
application. The URL target the /authorize endpoint of the authority
configured in the
application object.
Once the user inputs their credentials and consents, the authority will
send a response to the redirect URI
sent in the request and should contain an authorization code, which can
then be used to acquire tokens via
acquireToken(AuthorizationCodeRequest)
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function getAuthCodeUrl(request: CommonAuthorizationUrlRequest):
Promise<string>
parameters:
- id: request
type: CommonAuthorizationUrlRequest
description: |+
return:
description: ''
type: Promise<string>
inheritanceDescription: <b>Inherited From</b> AuthorizationCodeClient.getAuthCodeUrl
- name: getLogoutUri(CommonEndSessionRequest)
uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.getLogoutUri'
package: '@azure/msal-browser'
summary: >-
Used to log out the current user, and redirect the user to the
postLogoutRedirectUri.
Default behaviour is to redirect the user to `window.location.href`.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function getLogoutUri(logoutRequest: CommonEndSessionRequest): string'
parameters:
- id: logoutRequest
type: CommonEndSessionRequest
description: ''
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> AuthorizationCodeClient.getLogoutUri
- name: 'handleFragmentResponse(string, string)'
uid: >-
@azure/msal-browser.HybridSpaAuthorizationCodeClient.handleFragmentResponse
package: '@azure/msal-browser'
summary: >-
Handles the hash fragment response from public client code request.
Returns a code response used by
the client to exchange for a token in acquireToken.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function handleFragmentResponse(hashFragment: string, cachedState:
string): AuthorizationCodePayload
parameters:
- id: hashFragment
type: string
description: |+
- id: cachedState
type: string
description: ''
return:
description: ''
type: AuthorizationCodePayload
inheritanceDescription: <b>Inherited From</b> AuthorizationCodeClient.handleFragmentResponse
- name: updateAuthority(Authority)
uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.updateAuthority'
package: '@azure/msal-browser'
summary: >-
Updates the authority object of the client. Endpoint discovery must be
completed.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function updateAuthority(updatedAuthority: Authority)'
parameters:
- id: updatedAuthority
type: Authority
description: |+
inheritanceDescription: <b>Inherited From</b> BaseClient.updateAuthority
extends: AuthorizationCodeClient