Skip to content
v2.274.0

SignInUrlOptions Struct ​

Options to customize the behaviour of signInUrl().

Example ​

ts
const userpool = new cognito.UserPool(this, 'UserPool', {
  // ...
});
const client = userpool.addClient('Client', {
  // ...
  oAuth: {
    flows: {
      implicitCodeGrant: true,
    },
    callbackUrls: [
      'https://myapp.com/home',
      'https://myapp.com/users',
    ],
  },
});
const domain = userpool.addDomain('Domain', {
  // ...
});
const signInUrl = domain.signInUrl(client, {
  redirectUri: 'https://myapp.com/home', // must be a URL configured under 'callbackUrls' with the client
});

Properties ​

fipsbooleanfipsboolfipsBooleanFipsboolFips*bool#
Whether to return the FIPS-compliant endpoint.

Default: return the standard URL

redirectUristringredirect_uristrredirectUriStringRedirectUristringRedirectUri*stringrequired#
Where to redirect to after sign in.
signInPathstringsign_in_pathstrsignInPathStringSignInPathstringSignInPath*string= '/login'#
The path in the URI where the sign-in page is located.