View source: R/cognitoidentityprovider_operations.R
cognitoidentityprovider_create_user_pool_client | R Documentation |
Creates the user pool client.
See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_create_user_pool_client/ for full documentation.
cognitoidentityprovider_create_user_pool_client(
UserPoolId,
ClientName,
GenerateSecret = NULL,
RefreshTokenValidity = NULL,
AccessTokenValidity = NULL,
IdTokenValidity = NULL,
TokenValidityUnits = NULL,
ReadAttributes = NULL,
WriteAttributes = NULL,
ExplicitAuthFlows = NULL,
SupportedIdentityProviders = NULL,
CallbackURLs = NULL,
LogoutURLs = NULL,
DefaultRedirectURI = NULL,
AllowedOAuthFlows = NULL,
AllowedOAuthScopes = NULL,
AllowedOAuthFlowsUserPoolClient = NULL,
AnalyticsConfiguration = NULL,
PreventUserExistenceErrors = NULL,
EnableTokenRevocation = NULL,
EnablePropagateAdditionalUserContextData = NULL,
AuthSessionValidity = NULL
)
UserPoolId |
[required] The user pool ID for the user pool where you want to create a user pool client. |
ClientName |
[required] The client name for the user pool client you would like to create. |
GenerateSecret |
Boolean to specify whether you want to generate a secret for the user pool client being created. |
RefreshTokenValidity |
The refresh token time limit. After this limit expires, your user can't
use their refresh token. To specify the time unit for
For example, when you set The default time unit for If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days. |
AccessTokenValidity |
The access token time limit. After this limit expires, your user can't
use their access token. To specify the time unit for
For example, when you set The default time unit for If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour. |
IdTokenValidity |
The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for For example, when you set The default time unit for If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour. |
TokenValidityUnits |
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. |
ReadAttributes |
The list of user attributes that you want your app client to have
read-only access to. After your user authenticates in your app, their
access token authorizes them to read their own attribute value for any
attribute in this list. An example of this kind of activity is when your
user selects a link to view their profile information. Your app makes a
When you don't specify the |
WriteAttributes |
The list of user attributes that you want your app client to have write
access to. After your user authenticates in your app, their access token
authorizes them to set or modify their own attribute value for any
attribute in this list. An example of this kind of activity is when you
present your user with a form to update their profile information and
they change their last name. Your app then makes an
When you don't specify the 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. |
ExplicitAuthFlows |
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 Valid values include:
In some environments, you will see the values |
SupportedIdentityProviders |
A list of provider names for the identity providers (IdPs) that are
supported on this client. The following are supported: |
CallbackURLs |
A list of allowed redirect (callback) URLs for the IdPs. A redirect URI must:
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 |
A list of allowed logout URLs for the IdPs. |
DefaultRedirectURI |
The default redirect URI. In app clients with one assigned IdP, replaces
A redirect URI must:
For more information, see Default redirect URI. 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 |
The OAuth grant types that you want your app client to generate. To
create an app client that generates client credentials grants, you must
add code Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
implicit Issue the access token (and, optionally, ID token, based on scopes) directly to your user. client_credentials Issue the access token from the |
AllowedOAuthScopes |
The allowed OAuth scopes. Possible values provided by OAuth are |
AllowedOAuthFlowsUserPoolClient |
Set to
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set |
AnalyticsConfiguration |
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. |
PreventUserExistenceErrors |
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 Valid values include:
|
EnableTokenRevocation |
Activates or deactivates token revocation. For more information about
revoking tokens, see
If you don't include this parameter, token revocation is automatically activated for the new user pool client. |
EnablePropagateAdditionalUserContextData |
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.
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
|
AuthSessionValidity |
Amazon Cognito creates a session token for each API request in an
authentication flow. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.