AWSCognitoIdentityProviderSchemaAttributeType

Objective-C

@interface AWSCognitoIdentityProviderSchemaAttributeType

Swift

class AWSCognitoIdentityProviderSchemaAttributeType

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

  • The data format of the values for your attribute. When you choose an AttributeDataType, Amazon Cognito validates the input against the data type. A custom attribute value in your user’s ID token is always a string, for example "custom:isMember" : "true" or "custom:YearsAsMember" : "12".

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityProviderAttributeDataType attributeDataType;

    Swift

    var attributeDataType: AWSCognitoIdentityProviderAttributeDataType { get set }

  • You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

    Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won’t be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can’t be updated using UpdateUserAttributes.

    Declaration

    Objective-C

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

    Swift

    var developerOnlyAttribute: NSNumber? { get set }

  • Specifies whether the value of the attribute can be changed.

    Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

    Declaration

    Objective-C

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

    Swift

    var varying: NSNumber? { get set }

  • The name of your user pool attribute. When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a Name value of MyAttribute, Amazon Cognito creates the custom attribute custom:MyAttribute. When DeveloperOnlyAttribute is true, Amazon Cognito creates your attribute as dev:MyAttribute. In an operation that describes a user pool, Amazon Cognito returns this value as value for standard attributes, custom:value for custom attributes, and dev:value for developer-only attributes..

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }

  • Specifies the constraints for an attribute of the number type.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderNumberAttributeConstraintsType *_Nullable numberAttributeConstraints;

    Swift

    var numberAttributeConstraints: AWSCognitoIdentityProviderNumberAttributeConstraintsType? { get set }

  • Specifies whether a user pool attribute is required. If the attribute is required and the user doesn’t provide a value, registration or sign-in will fail.

    Declaration

    Objective-C

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

    Swift

    var required: NSNumber? { get set }

  • Specifies the constraints for an attribute of the string type.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderStringAttributeConstraintsType *_Nullable stringAttributeConstraints;

    Swift

    var stringAttributeConstraints: AWSCognitoIdentityProviderStringAttributeConstraintsType? { get set }