1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package cognitoidentityprovider
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates the user pool client. When you create a new user pool client, token
// revocation is automatically activated. For more information about revoking
// tokens, see RevokeToken
// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html).
func (c *Client) CreateUserPoolClient(ctx context.Context, params *CreateUserPoolClientInput, optFns ...func(*Options)) (*CreateUserPoolClientOutput, error) {
if params == nil {
params = &CreateUserPoolClientInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateUserPoolClient", params, optFns, c.addOperationCreateUserPoolClientMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateUserPoolClientOutput)
out.ResultMetadata = metadata
return out, nil
}
// Represents the request to create a user pool client.
type CreateUserPoolClientInput struct {
// The client name for the user pool client you would like to create.
//
// This member is required.
ClientName *string
// The user pool ID for the user pool where you want to create a user pool client.
//
// This member is required.
UserPoolId *string
// The access token time limit. After this limit expires, your user can't use their
// access token. To specify the time unit for AccessTokenValidity as seconds,
// minutes, hours, or days, set a TokenValidityUnits value in your API request. For
// example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours,
// your user can authorize access with their access token for 10 hours. The default
// time unit for AccessTokenValidity in an API request is hours. Valid range is
// displayed below in seconds. If you don't specify otherwise in the configuration
// of your app client, your access tokens are valid for one hour.
AccessTokenValidity *int32
// The allowed OAuth flows. code Use a code grant flow, which provides an
// authorization code as the response. This code can be exchanged for access tokens
// with the /oauth2/token endpoint. implicit Issue the access token (and,
// optionally, ID token, based on scopes) directly to your user. client_credentials
// Issue the access token from the /oauth2/token endpoint directly to a non-person
// user using a combination of the client ID and client secret.
AllowedOAuthFlows []types.OAuthFlowType
// Set to true if the client is allowed to follow the OAuth protocol when
// interacting with Amazon Cognito user pools.
AllowedOAuthFlowsUserPoolClient bool
// The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
// openid, and profile. Possible values provided by Amazon Web Services are
// aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are
// also supported.
AllowedOAuthScopes []string
// The user pool analytics configuration for collecting metrics and sending them to
// your Amazon Pinpoint campaign. In Amazon Web Services Regions where Amazon
// Pinpoint isn't available, user pools only support sending events to Amazon
// Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where
// Amazon Pinpoint is available, user pools support sending events to Amazon
// Pinpoint projects within that same Region.
AnalyticsConfiguration *types.AnalyticsConfigurationType
// Amazon Cognito creates a session token for each API request in an authentication
// flow. AuthSessionValidity is the duration, in minutes, of that session token.
// Your user pool native user must respond to each authentication challenge before
// the session expires.
AuthSessionValidity *int32
// A list of allowed redirect (callback) URLs for the IdPs. 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.
CallbackURLs []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.
DefaultRedirectURI *string
// Activates the propagation of additional user context data. For more information
// about propagation of user context data, see Adding advanced security to a user
// pool
// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html).
// If you don’t include this parameter, you can't send device fingerprint
// information, including source IP address, to Amazon Cognito advanced security.
// You can only activate EnablePropagateAdditionalUserContextData in an app client
// that has a client secret.
EnablePropagateAdditionalUserContextData *bool
// Activates or deactivates token revocation. For more information about revoking
// tokens, see RevokeToken
// (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html).
// If you don't include this parameter, token revocation is automatically activated
// for the new user pool client.
EnableTokenRevocation *bool
// The authentication flows that you want your user pool client to support. For
// each app client in your user pool, you can sign in your users with any
// combination of one or more flows, including with a user name and Secure Remote
// Password (SRP), a user name and password, or a custom authentication process
// that you define with Lambda functions. If you don't specify a value for
// ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH,
// ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH. Valid values include:
//
// *
// ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication
// flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH
// setting. With this authentication flow, your app passes a user name and password
// to Amazon Cognito in the request, instead of using the Secure Remote Password
// (SRP) protocol to securely transmit the password.
//
// * ALLOW_CUSTOM_AUTH: Enable
// Lambda trigger based authentication.
//
// * ALLOW_USER_PASSWORD_AUTH: Enable user
// password-based authentication. In this flow, Amazon Cognito receives the
// password in the request instead of using the SRP protocol to verify
// passwords.
//
// * ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
//
// *
// ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
//
// In some
// environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY,
// or USER_PASSWORD_AUTH. You can't assign these legacy ExplicitAuthFlows values to
// user pool clients at the same time as values that begin with ALLOW_, like
// ALLOW_USER_SRP_AUTH.
ExplicitAuthFlows []types.ExplicitAuthFlowsType
// Boolean to specify whether you want to generate a secret for the user pool
// client being created.
GenerateSecret bool
// The ID token time limit. After this limit expires, your user can't use their ID
// token. To specify the time unit for IdTokenValidity as seconds, minutes, hours,
// or days, set a TokenValidityUnits value in your API request. For example, when
// you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can
// authenticate their session with their ID token for 10 hours. The default time
// unit for AccessTokenValidity in an API request is hours. Valid range is
// displayed below in seconds. If you don't specify otherwise in the configuration
// of your app client, your ID tokens are valid for one hour.
IdTokenValidity *int32
// A list of allowed logout URLs for the IdPs.
LogoutURLs []string
// Errors and responses that you want Amazon Cognito APIs to return during
// authentication, account confirmation, and password recovery when the user
// doesn't exist in the user pool. When set to ENABLED and the user doesn't exist,
// authentication returns an error indicating either the username or password was
// incorrect. Account confirmation and password recovery return a response
// indicating a code was sent to a simulated destination. When set to LEGACY, those
// APIs return a UserNotFoundException exception if the user doesn't exist in the
// user pool. Valid values include:
//
// * ENABLED - This prevents user
// existence-related errors.
//
// * LEGACY - This represents the early behavior of
// Amazon Cognito where user existence related errors aren't prevented.
PreventUserExistenceErrors types.PreventUserExistenceErrorTypes
// The read attributes.
ReadAttributes []string
// The refresh token time limit. After this limit expires, your user can't use
// their refresh token. To specify the time unit for RefreshTokenValidity as
// seconds, minutes, hours, or days, set a TokenValidityUnits value in your API
// request. For example, when you set RefreshTokenValidity as 10 and
// TokenValidityUnits as days, your user can refresh their session and retrieve new
// access and ID tokens for 10 days. The default time unit for RefreshTokenValidity
// in an API request is days. You can't set RefreshTokenValidity to 0. If you do,
// Amazon Cognito overrides the value with the default value of 30 days. Valid
// range is displayed below in seconds. If you don't specify otherwise in the
// configuration of your app client, your refresh tokens are valid for 30 days.
RefreshTokenValidity int32
// A list of provider names for the identity providers (IdPs) that are supported on
// this client. The following are supported: COGNITO, Facebook, Google,
// SignInWithApple, and LoginWithAmazon. You can also specify the names that you
// configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP
// or MyOIDCIdP.
SupportedIdentityProviders []string
// The units in which the validity times are represented. The default unit for
// RefreshToken is days, and default for ID and access tokens are hours.
TokenValidityUnits *types.TokenValidityUnitsType
// The user pool attributes that the app client can write to. If your app client
// allows users to sign in through an IdP, this array must include all attributes
// that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes
// when users sign in to your application through an IdP. If your app client does
// not have write access to a mapped attribute, Amazon Cognito throws an error when
// it tries to update the attribute. For more information, see Specifying IdP
// Attribute Mappings for Your user pool
// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html).
WriteAttributes []string
noSmithyDocumentSerde
}
// Represents the response from the server to create a user pool client.
type CreateUserPoolClientOutput struct {
// The user pool client that was just created.
UserPoolClient *types.UserPoolClientType
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateUserPoolClientMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateUserPoolClient{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateUserPoolClient{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpCreateUserPoolClientValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateUserPoolClient(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateUserPoolClient(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "cognito-idp",
OperationName: "CreateUserPoolClient",
}
}
|