Class SignInUrlOptions
Options to customize the behaviour of signInUrl()
.
Inheritance
System.Object
SignInUrlOptions
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class SignInUrlOptions : Object, ISignInUrlOptions, IBaseUrlOptions
Syntax (vb)
Public Class SignInUrlOptions
Inherits Object
Implements ISignInUrlOptions, IBaseUrlOptions
Remarks
ExampleMetadata: infused
Examples
var userpool = new UserPool(this, "UserPool", new UserPoolProps { });
var client = userpool.AddClient("Client", new UserPoolClientOptions {
// ...
OAuth = new OAuthSettings {
Flows = new OAuthFlows {
ImplicitCodeGrant = true
},
CallbackUrls = new [] { "https://myapp.com/home", "https://myapp.com/users" }
}
});
var domain = userpool.AddDomain("Domain", new UserPoolDomainOptions { });
var signInUrl = domain.SignInUrl(client, new SignInUrlOptions {
RedirectUri = "https://myapp.com/home"
});
Synopsis
Constructors
SignInUrlOptions() |
Properties
Fips | Whether to return the FIPS-compliant endpoint. |
RedirectUri | Where to redirect to after sign in. |
SignInPath | The path in the URI where the sign-in page is located. |
Constructors
SignInUrlOptions()
public SignInUrlOptions()
Properties
Fips
Whether to return the FIPS-compliant endpoint.
public Nullable<bool> Fips { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: return the standard URL
RedirectUri
Where to redirect to after sign in.
public string RedirectUri { get; set; }
Property Value
System.String
SignInPath
The path in the URI where the sign-in page is located.
public string SignInPath { get; set; }
Property Value
System.String
Remarks
Default: '/login'