openapi: 3.0.0 info: version: '2014-06-30' x-release: v4 title: 'Amazon Cognito Identity #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.CreateUserPoolClient API' description: Amazon Cognito Federated Identities

Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.

For more information see Amazon Cognito Federated Identities.

x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: cognito-identity x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-identity-2014-06-30.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://cognito-identity.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Cognito Identity multi-region endpoint - url: https://cognito-identity.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon Cognito Identity multi-region endpoint - url: http://cognito-identity.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia) - url: https://cognito-identity.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=AWSCognitoIdentityProviderService.CreateUserPoolClient' paths: /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPoolClient: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateUserPoolClient description:

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.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateUserPoolClientResponse' examples: CreateUserPoolClient200Example: summary: Default CreateUserPoolClient 200 response x-microcks-default: true value: UserPoolClient: example '480': description: InvalidParameterException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterException' examples: CreateUserPoolClient480Example: summary: Default CreateUserPoolClient 480 response x-microcks-default: true value: example '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: CreateUserPoolClient481Example: summary: Default CreateUserPoolClient 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateUserPoolClient482Example: summary: Default CreateUserPoolClient 482 response x-microcks-default: true value: example '483': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateUserPoolClient483Example: summary: Default CreateUserPoolClient 483 response x-microcks-default: true value: example '484': description: NotAuthorizedException content: application/json: schema: $ref: '#/components/schemas/NotAuthorizedException' examples: CreateUserPoolClient484Example: summary: Default CreateUserPoolClient 484 response x-microcks-default: true value: example '485': description: ScopeDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/ScopeDoesNotExistException' examples: CreateUserPoolClient485Example: summary: Default CreateUserPoolClient 485 response x-microcks-default: true value: example '486': description: InvalidOAuthFlowException content: application/json: schema: $ref: '#/components/schemas/InvalidOAuthFlowException' examples: CreateUserPoolClient486Example: summary: Default CreateUserPoolClient 486 response x-microcks-default: true value: example '487': description: InternalErrorException content: application/json: schema: $ref: '#/components/schemas/InternalErrorException' examples: CreateUserPoolClient487Example: summary: Default CreateUserPoolClient 487 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateUserPoolClientRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.CreateUserPoolClient summary: Amazon Cognito Create User Pool Client x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=AWSCognitoIdentityProviderService.CreateUserPoolClient' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false schemas: TimeUnitsType: type: string enum: - seconds - minutes - hours - days ClientIdType: type: string pattern: '[\w+]+' minLength: 1 maxLength: 128 format: password ClientPermissionListType: type: array items: $ref: '#/components/schemas/ClientPermissionType' ResourceNotFoundException: {} DateType: type: string format: date-time BooleanType: type: boolean AuthSessionValidityType: type: integer minimum: 3 maximum: 15 CallbackURLsListType: type: array items: $ref: '#/components/schemas/RedirectUrlType' minItems: 0 maxItems: 100 AccessTokenValidityType: type: integer minimum: 1 maximum: 86400 ClientPermissionType: type: string minLength: 1 maxLength: 2048 InvalidParameterException: {} ArnType: type: string pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)? minLength: 20 maxLength: 2048 ClientSecretType: type: string pattern: '[\w+]+' minLength: 1 maxLength: 64 format: password AnalyticsConfigurationType: type: object properties: ApplicationId: allOf: - $ref: '#/components/schemas/HexStringType' - description: The application ID for an Amazon Pinpoint application. ApplicationArn: allOf: - $ref: '#/components/schemas/ArnType' - description: The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares. RoleArn: allOf: - $ref: '#/components/schemas/ArnType' - description: The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. ExternalId: allOf: - $ref: '#/components/schemas/StringType' - description: The external ID. UserDataShared: allOf: - $ref: '#/components/schemas/BooleanType' - description: If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics. description:

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

In Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

HexStringType: type: string pattern: ^[0-9a-fA-F]+$ CreateUserPoolClientResponse: type: object properties: UserPoolClient: allOf: - $ref: '#/components/schemas/UserPoolClientType' - description: The user pool client that was just created. description: Represents the response from the server to create a user pool client. WrappedBooleanType: type: boolean TokenValidityUnitsType: type: object properties: AccessToken: allOf: - $ref: '#/components/schemas/TimeUnitsType' - description: ' A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours. AccessTokenValidity duration can range from five minutes to one day.' IdToken: allOf: - $ref: '#/components/schemas/TimeUnitsType' - description: A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours. IdTokenValidity duration can range from five minutes to one day. RefreshToken: allOf: - $ref: '#/components/schemas/TimeUnitsType' - description: A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days. RefreshTokenValidity duration can range from 60 minutes to 10 years. description: The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens. OAuthFlowsType: type: array items: $ref: '#/components/schemas/OAuthFlowType' minItems: 0 maxItems: 3 ExplicitAuthFlowsListType: type: array items: $ref: '#/components/schemas/ExplicitAuthFlowsType' UserPoolClientType: type: object properties: UserPoolId: allOf: - $ref: '#/components/schemas/UserPoolIdType' - description: The user pool ID for the user pool client. ClientName: allOf: - $ref: '#/components/schemas/ClientNameType' - description: The client name from the user pool request of the client type. ClientId: allOf: - $ref: '#/components/schemas/ClientIdType' - description: The ID of the client associated with the user pool. ClientSecret: allOf: - $ref: '#/components/schemas/ClientSecretType' - description: The client secret from the user pool request of the client type. LastModifiedDate: allOf: - $ref: '#/components/schemas/DateType' - description: The date and time, in ISO 8601 format, when the item was modified. CreationDate: allOf: - $ref: '#/components/schemas/DateType' - description: The date and time, in ISO 8601 format, when the item was created. RefreshTokenValidity: allOf: - $ref: '#/components/schemas/RefreshTokenValidityType' - description:

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.

AccessTokenValidity: allOf: - $ref: '#/components/schemas/AccessTokenValidityType' - description:

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.

IdTokenValidity: allOf: - $ref: '#/components/schemas/IdTokenValidityType' - description:

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 IdTokenValidity 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.

TokenValidityUnits: allOf: - $ref: '#/components/schemas/TokenValidityUnitsType' - description: 'The time units used to specify the token validity times of each token type: ID, access, and refresh.' ReadAttributes: allOf: - $ref: '#/components/schemas/ClientPermissionListType' - description: The Read-only attributes. WriteAttributes: allOf: - $ref: '#/components/schemas/ClientPermissionListType' - description: The writeable attributes. ExplicitAuthFlows: allOf: - $ref: '#/components/schemas/ExplicitAuthFlowsListType' - description: '

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.

' SupportedIdentityProviders: allOf: - $ref: '#/components/schemas/SupportedIdentityProvidersListType' - description: 'A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google, SignInWithApple, LoginWithAmazon, and the names of your own SAML and OIDC providers.' CallbackURLs: allOf: - $ref: '#/components/schemas/CallbackURLsListType' - description:

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.

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

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

LogoutURLs: allOf: - $ref: '#/components/schemas/LogoutURLsListType' - description: A list of allowed logout URLs for the IdPs. DefaultRedirectURI: allOf: - $ref: '#/components/schemas/RedirectUrlType' - description:

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.

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

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

AllowedOAuthFlows: allOf: - $ref: '#/components/schemas/OAuthFlowsType' - description:

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.

AllowedOAuthScopes: allOf: - $ref: '#/components/schemas/ScopeListType' - description: The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers. AllowedOAuthFlowsUserPoolClient: allOf: - $ref: '#/components/schemas/BooleanType' - description: '

Set to true to use OAuth 2.0 features in your user pool app client.

AllowedOAuthFlowsUserPoolClient must be true before you can configure the following features in your app client.

CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don''t set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false.

' AnalyticsConfiguration: allOf: - $ref: '#/components/schemas/AnalyticsConfigurationType' - description:

The Amazon Pinpoint analytics configuration for the user pool client.

Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.

PreventUserExistenceErrors: allOf: - $ref: '#/components/schemas/PreventUserExistenceErrorTypes' - description:

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 old behavior of Amazon Cognito where user existence related errors aren't prevented.

EnableTokenRevocation: allOf: - $ref: '#/components/schemas/WrappedBooleanType' - description: Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken. EnablePropagateAdditionalUserContextData: allOf: - $ref: '#/components/schemas/WrappedBooleanType' - description:

When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.

When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.

You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.

AuthSessionValidity: allOf: - $ref: '#/components/schemas/AuthSessionValidityType' - description: 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. description: Contains information about a user pool client. ScopeDoesNotExistException: {} StringType: type: string minLength: 0 maxLength: 131072 RedirectUrlType: type: string pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+' minLength: 1 maxLength: 1024 OAuthFlowType: type: string enum: - code - implicit - client_credentials ExplicitAuthFlowsType: type: string enum: - ADMIN_NO_SRP_AUTH - CUSTOM_AUTH_FLOW_ONLY - USER_PASSWORD_AUTH - ALLOW_ADMIN_USER_PASSWORD_AUTH - ALLOW_CUSTOM_AUTH - ALLOW_USER_PASSWORD_AUTH - ALLOW_USER_SRP_AUTH - ALLOW_REFRESH_TOKEN_AUTH UserPoolIdType: type: string pattern: '[\w-]+_[0-9a-zA-Z]+' minLength: 1 maxLength: 55 ProviderNameType: type: string pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+' minLength: 1 maxLength: 32 ScopeListType: type: array items: $ref: '#/components/schemas/ScopeType' maxItems: 50 IdTokenValidityType: type: integer minimum: 1 maximum: 86400 CreateUserPoolClientRequest: type: object required: - UserPoolId - ClientName title: CreateUserPoolClientRequest properties: UserPoolId: allOf: - $ref: '#/components/schemas/UserPoolIdType' - description: The user pool ID for the user pool where you want to create a user pool client. ClientName: allOf: - $ref: '#/components/schemas/ClientNameType' - description: The client name for the user pool client you would like to create. GenerateSecret: allOf: - $ref: '#/components/schemas/GenerateSecret' - description: Boolean to specify whether you want to generate a secret for the user pool client being created. RefreshTokenValidity: allOf: - $ref: '#/components/schemas/RefreshTokenValidityType' - description: