AWSCognitoIdentityProviderGroupType

@interface AWSCognitoIdentityProviderGroupType

The group type.

  • The date the group was created.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSDate *_Nullable creationDate;

    Swift

    var creationDate: Date? { get set }
  • A string containing the description of the group.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }
  • The name of the group.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable groupName;

    Swift

    var groupName: String? { get set }
  • The date the group was last modified.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSDate *_Nullable lastModifiedDate;

    Swift

    var lastModifiedDate: Date? { get set }
  • A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user’s tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.

    Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users’ tokens.

    The default Precedence value is null.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSNumber *_Nullable precedence;

    Swift

    var precedence: NSNumber? { get set }
  • The role ARN for the group.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable roleArn;

    Swift

    var roleArn: String? { get set }
  • The user pool ID for the user pool.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable userPoolId;

    Swift

    var userPoolId: String? { get set }