AWSCognitoIdentityProviderUserPoolClientType
Objective-C
@interface AWSCognitoIdentityProviderUserPoolClientType
Swift
class AWSCognitoIdentityProviderUserPoolClientType
Contains information about a user pool client.
-
The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and can’t 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 Amazon 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 Amazon Web Services 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 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.
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 user pool request of the client type.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable clientName;
Swift
var clientName: String? { get set }
-
The client secret from the user pool request of the client type.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable clientSecret;
Swift
var clientSecret: String? { get set }
-
The date the user pool client was created.
Declaration
Objective-C
@property (nonatomic, strong) NSDate *_Nullable creationDate;
Swift
var creationDate: Date? { 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 }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable enableTokenRevocation;
Swift
var enableTokenRevocation: NSNumber? { get set }
-
The authentication flows that are supported by the user pool clients. Flow names without the
ALLOW_
prefix are no longer supported in favor of new names with theALLOW_
prefix. Note that values withALLOW_
prefix must be used only along with values including theALLOW_
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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.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.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable explicitAuthFlows;
Swift
var explicitAuthFlows: [String]? { get set }
-
The time limit specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and can’t be used.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable idTokenValidity;
Swift
var idTokenValidity: NSNumber? { get set }
-
The date the user pool client was last modified.
Declaration
Objective-C
@property (nonatomic, strong) NSDate *_Nullable lastModifiedDate;
Swift
var lastModifiedDate: Date? { 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 }
-
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 toLEGACY
, those APIs return aUserNotFoundException
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 Cognito where user existence related errors aren’t prevented.
Declaration
Objective-C
@property (nonatomic) AWSCognitoIdentityProviderPreventUserExistenceErrorTypes preventUserExistenceErrors;
Swift
var preventUserExistenceErrors: AWSCognitoIdentityProviderPreventUserExistenceErrorTypes { get set }
-
The Read-only attributes.
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 can’t 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 time units used to specify the token validity times of their respective token.
Declaration
Objective-C
@property (nonatomic, strong) AWSCognitoIdentityProviderTokenValidityUnitsType *_Nullable tokenValidityUnits;
Swift
var tokenValidityUnits: AWSCognitoIdentityProviderTokenValidityUnitsType? { get set }
-
The user pool ID for the user pool client.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable userPoolId;
Swift
var userPoolId: String? { get set }
-
The writeable attributes.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable writeAttributes;
Swift
var writeAttributes: [String]? { get set }