AWSCognitoIdentityProviderUserPoolClientType

Objective-C

@interface AWSCognitoIdentityProviderUserPoolClientType

Swift

class AWSCognitoIdentityProviderUserPoolClientType

Contains information about a user pool client.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable accessTokenValidity;

    Swift

    var accessTokenValidity: NSNumber? { get set }

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

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

    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 }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable authSessionValidity;

    Swift

    var authSessionValidity: NSNumber? { get set }

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

    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 }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable enablePropagateAdditionalUserContextData;

    Swift

    var enablePropagateAdditionalUserContextData: NSNumber? { 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 the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the ALLOW_ prefix.

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

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

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

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable refreshTokenValidity;

    Swift

    var refreshTokenValidity: NSNumber? { get set }

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

    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 each token type: ID, access, and refresh.

    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 }