Interface IOAuthFlows

Types of OAuth grant flows.

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IOAuthFlows

Syntax (vb)

Public Interface IOAuthFlows

Remarks

See: - the 'Allowed OAuth Flows' section at https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-app-idp-settings.html

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

Properties

AuthorizationCodeGrant	Initiate an authorization code grant flow, which provides an authorization code as the response.
ClientCredentials	Client should get the access token and ID token from the token endpoint using a combination of client and client_secret.
ImplicitCodeGrant	The client should get the access token and ID token directly.

Properties

AuthorizationCodeGrant

Initiate an authorization code grant flow, which provides an authorization code as the response.

virtual Nullable<bool> AuthorizationCodeGrant { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

ClientCredentials

Client should get the access token and ID token from the token endpoint using a combination of client and client_secret.

virtual Nullable<bool> ClientCredentials { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

ImplicitCodeGrant

The client should get the access token and ID token directly.

virtual Nullable<bool> ImplicitCodeGrant { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false