Container for the parameters to the AdminRemoveUserFromGroup operation.
Given a username and a group name, removes them from the group. User pool groups are
identifiers that you can reference from the contents of ID and access tokens, and
set preferred IAM roles for identity-pool authentication. For more information, see
Adding
groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests
for this API operation. For this operation, you must use IAM credentials to authorize
requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.AdminRemoveUserFromGroupRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class AdminRemoveUserFromGroupRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminRemoveUserFromGroupRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AdminRemoveUserFromGroupRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
GroupName | System.String |
Gets and sets the property GroupName.
The name of the group that you want to remove the user from, for example |
|
|
Username | System.String |
Gets and sets the property Username.
The name 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
|
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool that contains the group and the user that you want to remove. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5