AWSCognitoIdentityProviderAdminDisableUserRequest

Objective-C

@interface AWSCognitoIdentityProviderAdminDisableUserRequest

Swift

class AWSCognitoIdentityProviderAdminDisableUserRequest

Represents the request to disable the user as an administrator.

Required parameters: [UserPoolId, Username]

  • The user pool ID for the user pool where you want to disable the user.

    Declaration

    Objective-C

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

    Swift

    var userPoolId: String? { get set }

  • The username of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If username isn’t an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

    Declaration

    Objective-C

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

    Swift

    var username: String? { get set }