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.

Contains information about a user pool client.

Inheritance Hierarchy

System.Object
  Amazon.CognitoIdentityProvider.Model.UserPoolClientType

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

Syntax

C#
public class UserPoolClientType

The UserPoolClientType type exposes the following members

Constructors

NameDescription
Public Method UserPoolClientType()

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 ClientId System.String

Gets and sets the property ClientId.

The ID of the client associated with the user pool.

Public Property ClientName System.String

Gets and sets the property ClientName.

The client name from the user pool request of the client type.

Public Property ClientSecret System.String

Gets and sets the property ClientSecret.

The client secret from the user pool request of the client type.

Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

The date the user pool client was created.

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 LastModifiedDate System.DateTime

Gets and sets the property LastModifiedDate.

The date the user pool client was last modified.

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-only 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 client.

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

Gets and sets the property WriteAttributes.

The writeable 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