From 318bdbb8f1e62387d63939d702968b631ec3d175 Mon Sep 17 00:00:00 2001 From: Abhash Kumar Singh Date: Wed, 19 Nov 2025 12:27:03 -0800 Subject: [PATCH] feat(auth): doc update for cognito oidc parameters during managed login --- .../auth/sign-in-with-web-ui/index.mdx | 63 +++++++++++++++++++ 1 file changed, 63 insertions(+) diff --git a/src/pages/[platform]/build-a-backend/auth/sign-in-with-web-ui/index.mdx b/src/pages/[platform]/build-a-backend/auth/sign-in-with-web-ui/index.mdx index cda3ce8918a..e46bb44b12f 100644 --- a/src/pages/[platform]/build-a-backend/auth/sign-in-with-web-ui/index.mdx +++ b/src/pages/[platform]/build-a-backend/auth/sign-in-with-web-ui/index.mdx @@ -123,6 +123,26 @@ RxAmplify.Auth.signInWithWebUI(this) +### Additional options during signIn + +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). + +```kotlin +val options = AWSCognitoAuthWebUISignInOptions.builder() + .nonce("randomUUID") + .language("en") + .loginHint("username") + .prompt(AuthWebUIPrompt.LOGIN, AuthWebUIPrompt.CONSENT) + .resource("https://localhost") + .build() + +Amplify.Auth.signInWithWebUI( + this, + options, + result -> Log.i("AuthQuickStart", result.toString()), + error -> Log.e("AuthQuickStart", error.toString()) +); +``` @@ -262,6 +282,25 @@ try await Amplify.Auth.signInWithWebUI( } ``` +### Additional options during signIn + +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). + +```swift +let options = AuthWebUISignInRequest.Options( + pluginOptions: AWSAuthWebUISignInOptions.init( + nonce: "randomUUID", + language: "en", + loginHint: "username", + prompt: [.login, .consent], + resource: "http://localhost")) + +let signInResult = try await Amplify.Auth.signInWithWebUI( + presentationAnchor: self.view.window!, + options: options) +``` + + ## Prerequisites @@ -396,4 +435,28 @@ Future signInWithWebUIAndPrivateSession() async { } ``` +### Additional options during signIn + +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). + +```dart +Future signInWithWebUIAndOptions() async { + try { + final result = await Amplify.Auth.Amplify.Auth.signInWithWebUI( + options: SignInWithWebUIOptions(pluginOptions: CognitoSignInWithWebUIPluginOptions( + nonce: 'randomUUID', + language: 'en', + loginHint: 'username', + prompt: List.from([CognitoSignInWithWebUIPrompt.login, CognitoSignInWithWebUIPrompt.consent]), + resource: 'http://localhost' + ) + ) + ); + safePrint('Sign in result: $result'); + } on AuthException catch (e) { + safePrint('Error signing in: ${e.message}'); + } +} +``` +