Skip to content

Commit 318bdbb

Browse files
committed
feat(auth): doc update for cognito oidc parameters during managed login
1 parent f02cbb3 commit 318bdbb

File tree

1 file changed

+63
-0
lines changed
  • src/pages/[platform]/build-a-backend/auth/sign-in-with-web-ui

1 file changed

+63
-0
lines changed

src/pages/[platform]/build-a-backend/auth/sign-in-with-web-ui/index.mdx

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,26 @@ RxAmplify.Auth.signInWithWebUI(this)
123123
</Block>
124124
</BlockSwitcher>
125125

126+
### Additional options during signIn
127+
128+
You may pass additional parameters to the `Amplify.Auth.signInWithWebUI` which are added as query parameters in the requests to [Cognito authorization endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html).
129+
130+
```kotlin
131+
val options = AWSCognitoAuthWebUISignInOptions.builder()
132+
.nonce("randomUUID")
133+
.language("en")
134+
.loginHint("username")
135+
.prompt(AuthWebUIPrompt.LOGIN, AuthWebUIPrompt.CONSENT)
136+
.resource("https://localhost")
137+
.build()
138+
139+
Amplify.Auth.signInWithWebUI(
140+
this,
141+
options,
142+
result -> Log.i("AuthQuickStart", result.toString()),
143+
error -> Log.e("AuthQuickStart", error.toString())
144+
);
145+
```
126146

127147
</InlineFilter>
128148
<InlineFilter filters={['swift']}>
@@ -262,6 +282,25 @@ try await Amplify.Auth.signInWithWebUI(
262282
}
263283
```
264284

285+
### Additional options during signIn
286+
287+
You may pass additional parameters to the `Amplify.Auth.signInWithWebUI` which are added as query parameters in the requests to [Cognito authorization endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html).
288+
289+
```swift
290+
let options = AuthWebUISignInRequest.Options(
291+
pluginOptions: AWSAuthWebUISignInOptions.init(
292+
nonce: "randomUUID",
293+
language: "en",
294+
loginHint: "username",
295+
prompt: [.login, .consent],
296+
resource: "http://localhost"))
297+
298+
let signInResult = try await Amplify.Auth.signInWithWebUI(
299+
presentationAnchor: self.view.window!,
300+
options: options)
301+
```
302+
303+
265304
</InlineFilter>
266305
<InlineFilter filters={['flutter']}>
267306
## Prerequisites
@@ -396,4 +435,28 @@ Future<void> signInWithWebUIAndPrivateSession() async {
396435
}
397436
```
398437

438+
### Additional options during signIn
439+
440+
You may pass additional parameters to the `Amplify.Auth.signInWithWebUI` which are added as query parameters in the requests to [Cognito authorization endpoint](https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html).
441+
442+
```dart
443+
Future<void> signInWithWebUIAndOptions() async {
444+
try {
445+
final result = await Amplify.Auth.Amplify.Auth.signInWithWebUI(
446+
options: SignInWithWebUIOptions(pluginOptions: CognitoSignInWithWebUIPluginOptions(
447+
nonce: 'randomUUID',
448+
language: 'en',
449+
loginHint: 'username',
450+
prompt: List.from([CognitoSignInWithWebUIPrompt.login, CognitoSignInWithWebUIPrompt.consent]),
451+
resource: 'http://localhost'
452+
)
453+
)
454+
);
455+
safePrint('Sign in result: $result');
456+
} on AuthException catch (e) {
457+
safePrint('Error signing in: ${e.message}');
458+
}
459+
}
460+
```
461+
399462
</InlineFilter>

0 commit comments

Comments
 (0)