AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateUserPoolClient operation. Creates the user pool client.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.CreateUserPoolClientRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public class CreateUserPoolClientRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The CreateUserPoolClientRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AllowedOAuthFlows System.Collections.Generic.List<System.String>

Gets and sets the property AllowedOAuthFlows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Public Property AllowedOAuthFlowsUserPoolClient System.Boolean

Gets and sets the property AllowedOAuthFlowsUserPoolClient.

Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Public Property AllowedOAuthScopes System.Collections.Generic.List<System.String>

Gets and sets the property AllowedOAuthScopes.

A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

Public Property CallbackURLs System.Collections.Generic.List<System.String>

Gets and sets the property CallbackURLs.

A list of allowed callback URLs for the identity providers.

Public Property ClientName System.String

Gets and sets the property ClientName.

The client name for the user pool client you would like to create.

Public Property DefaultRedirectURI System.String

Gets and sets the property DefaultRedirectURI.

The default redirect URI. Must be in the CallbackURLs list.

Public Property ExplicitAuthFlows System.Collections.Generic.List<System.String>

Gets and sets the property ExplicitAuthFlows.

The explicit authentication flows.

Public Property GenerateSecret System.Boolean

Gets and sets the property GenerateSecret.

Boolean to specify whether you want to generate a secret for the user pool client being created.

Public Property LogoutURLs System.Collections.Generic.List<System.String>

Gets and sets the property LogoutURLs.

A list of allowed logout URLs for the identity providers.

Public Property ReadAttributes System.Collections.Generic.List<System.String>

Gets and sets the property ReadAttributes.

The read attributes.

Public Property RefreshTokenValidity System.Int32

Gets and sets the property RefreshTokenValidity.

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Public Property SupportedIdentityProviders System.Collections.Generic.List<System.String>

Gets and sets the property SupportedIdentityProviders.

A list of provider names for the identity providers that are supported on this client.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

The user pool ID for the user pool where you want to create a user pool client.

Public Property WriteAttributes System.Collections.Generic.List<System.String>

Gets and sets the property WriteAttributes.

The write attributes.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms