AWSCognitoIdentityProviderUpdateUserPoolClientRequest
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserPoolClientRequest
Swift
class AWSCognitoIdentityProviderUpdateUserPoolClientRequest
Represents the request to update the user pool client.
Required parameters: [UserPoolId, ClientId]
-
The time limit, after which the access token is no longer valid and cannot be used.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable accessTokenValidity;
Swift
var accessTokenValidity: NSNumber? { get set }
-
The allowed OAuth flows.
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
implicit
to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.Set to
client_credentials
to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable allowedOAuthFlows;
Swift
var allowedOAuthFlows: [String]? { get set }
-
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable allowedOAuthFlowsUserPoolClient;
Swift
var allowedOAuthFlowsUserPoolClient: NSNumber? { get set }
-
The allowed OAuth scopes. Possible values provided by OAuth are:
phone
,email
,openid
, andprofile
. Possible values provided by AWS are:aws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable allowedOAuthScopes;
Swift
var allowedOAuthScopes: [String]? { get set }
-
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsConfigurationType *_Nullable analyticsConfiguration;
Swift
var analyticsConfiguration: AWSCognitoIdentityProviderAnalyticsConfigurationType? { get set }
-
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.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable callbackURLs;
Swift
var callbackURLs: [String]? { get set }
-
The ID of the client associated with the user pool.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable clientId;
Swift
var clientId: String? { get set }
-
The client name from the update user pool client request.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable clientName;
Swift
var clientName: String? { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable defaultRedirectURI;
Swift
var defaultRedirectURI: String? { get set }
-
The authentication flows that are supported by the user pool clients. Flow names without the
ALLOW_
prefix are deprecated in favor of new names with theALLOW_
prefix. Note that values withALLOW_
prefix cannot be used along with values withoutALLOW_
prefix.Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, 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.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable explicitAuthFlows;
Swift
var explicitAuthFlows: [String]? { get set }
-
The time limit, after which the ID token is no longer valid and cannot be used.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable idTokenValidity;
Swift
var idTokenValidity: NSNumber? { get set }
-
A list of allowed logout URLs for the identity providers.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable logoutURLs;
Swift
var logoutURLs: [String]? { get set }
-
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool.Valid values include:
ENABLED
- This prevents user existence-related errors.LEGACY
- This represents the old behavior of Cognito where user existence related errors are not prevented.
After February 15th 2020, the value of
PreventUserExistenceErrors
will default toENABLED
for newly created user pool clients if no value is provided.Declaration
Objective-C
@property (nonatomic) AWSCognitoIdentityProviderPreventUserExistenceErrorTypes preventUserExistenceErrors;
Swift
var preventUserExistenceErrors: AWSCognitoIdentityProviderPreventUserExistenceErrorTypes { get set }
-
The read-only attributes of the user pool.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable readAttributes;
Swift
var readAttributes: [String]? { get set }
-
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable refreshTokenValidity;
Swift
var refreshTokenValidity: NSNumber? { get set }
-
A list of provider names for the identity providers that are supported on this client.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable supportedIdentityProviders;
Swift
var supportedIdentityProviders: [String]? { get set }
-
The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.
Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderTokenValidityUnitsType *_Nullable tokenValidityUnits;
Swift
var tokenValidityUnits: AWSCognitoIdentityProviderTokenValidityUnitsType? { get set }
-
The user pool ID for the user pool where you want to update the user pool client.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable userPoolId;
Swift
var userPoolId: String? { get set }
-
The writeable attributes of the user pool.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable writeAttributes;
Swift
var writeAttributes: [String]? { get set }