AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateUserPoolClientInput

import "github.com/aws/aws-sdk-go/service/cognitoidentityprovider"

type CreateUserPoolClientInput struct { AllowedOAuthFlows []*string `type:"list"` AllowedOAuthFlowsUserPoolClient *bool `type:"boolean"` AllowedOAuthScopes []*string `type:"list"` AnalyticsConfiguration *AnalyticsConfigurationType `type:"structure"` CallbackURLs []*string `type:"list"` ClientName *string `min:"1" type:"string" required:"true"` DefaultRedirectURI *string `min:"1" type:"string"` ExplicitAuthFlows []*string `type:"list"` GenerateSecret *bool `type:"boolean"` LogoutURLs []*string `type:"list"` ReadAttributes []*string `type:"list"` RefreshTokenValidity *int64 `type:"integer"` SupportedIdentityProviders []*string `type:"list"` UserPoolId *string `min:"1" type:"string" required:"true"` WriteAttributes []*string `type:"list"` }

Represents the request to create a user pool client.

AllowedOAuthFlows

Type: []*string

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.

AllowedOAuthFlowsUserPoolClient

Type: *bool

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

AllowedOAuthScopes

Type: []*string

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

AnalyticsConfiguration

The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

CallbackURLs

Type: []*string

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2).

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

ClientName

Type: *string

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

ClientName is a required field

DefaultRedirectURI

Type: *string

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

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2).

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

ExplicitAuthFlows

Type: []*string

The explicit authentication flows.

GenerateSecret

Type: *bool

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

LogoutURLs

Type: []*string

A list of allowed logout URLs for the identity providers.

ReadAttributes

Type: []*string

The read attributes.

RefreshTokenValidity

Type: *int64

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

SupportedIdentityProviders

Type: []*string

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

UserPoolId

Type: *string

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

UserPoolId is a required field

WriteAttributes

Type: []*string

The user pool attributes that the app client can write to.

If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html).

Method

GoString

func (s CreateUserPoolClientInput) GoString() string

GoString returns the string representation

SetAllowedOAuthFlows

func (s *CreateUserPoolClientInput) SetAllowedOAuthFlows(v []*string) *CreateUserPoolClientInput

SetAllowedOAuthFlows sets the AllowedOAuthFlows field's value.

SetAllowedOAuthFlowsUserPoolClient

func (s *CreateUserPoolClientInput) SetAllowedOAuthFlowsUserPoolClient(v bool) *CreateUserPoolClientInput

SetAllowedOAuthFlowsUserPoolClient sets the AllowedOAuthFlowsUserPoolClient field's value.

SetAllowedOAuthScopes

func (s *CreateUserPoolClientInput) SetAllowedOAuthScopes(v []*string) *CreateUserPoolClientInput

SetAllowedOAuthScopes sets the AllowedOAuthScopes field's value.

SetAnalyticsConfiguration

func (s *CreateUserPoolClientInput) SetAnalyticsConfiguration(v *AnalyticsConfigurationType) *CreateUserPoolClientInput

SetAnalyticsConfiguration sets the AnalyticsConfiguration field's value.

SetCallbackURLs

func (s *CreateUserPoolClientInput) SetCallbackURLs(v []*string) *CreateUserPoolClientInput

SetCallbackURLs sets the CallbackURLs field's value.

SetClientName

func (s *CreateUserPoolClientInput) SetClientName(v string) *CreateUserPoolClientInput

SetClientName sets the ClientName field's value.

SetDefaultRedirectURI

func (s *CreateUserPoolClientInput) SetDefaultRedirectURI(v string) *CreateUserPoolClientInput

SetDefaultRedirectURI sets the DefaultRedirectURI field's value.

SetExplicitAuthFlows

func (s *CreateUserPoolClientInput) SetExplicitAuthFlows(v []*string) *CreateUserPoolClientInput

SetExplicitAuthFlows sets the ExplicitAuthFlows field's value.

SetGenerateSecret

func (s *CreateUserPoolClientInput) SetGenerateSecret(v bool) *CreateUserPoolClientInput

SetGenerateSecret sets the GenerateSecret field's value.

SetLogoutURLs

func (s *CreateUserPoolClientInput) SetLogoutURLs(v []*string) *CreateUserPoolClientInput

SetLogoutURLs sets the LogoutURLs field's value.

SetReadAttributes

func (s *CreateUserPoolClientInput) SetReadAttributes(v []*string) *CreateUserPoolClientInput

SetReadAttributes sets the ReadAttributes field's value.

SetRefreshTokenValidity

func (s *CreateUserPoolClientInput) SetRefreshTokenValidity(v int64) *CreateUserPoolClientInput

SetRefreshTokenValidity sets the RefreshTokenValidity field's value.

SetSupportedIdentityProviders

func (s *CreateUserPoolClientInput) SetSupportedIdentityProviders(v []*string) *CreateUserPoolClientInput

SetSupportedIdentityProviders sets the SupportedIdentityProviders field's value.

SetUserPoolId

func (s *CreateUserPoolClientInput) SetUserPoolId(v string) *CreateUserPoolClientInput

SetUserPoolId sets the UserPoolId field's value.

SetWriteAttributes

func (s *CreateUserPoolClientInput) SetWriteAttributes(v []*string) *CreateUserPoolClientInput

SetWriteAttributes sets the WriteAttributes field's value.

String

func (s CreateUserPoolClientInput) String() string

String returns the string representation

Validate

func (s *CreateUserPoolClientInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: