Module Awso_cognito_idp.AdminRemoveUserFromGroupRequestSource

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 Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

Sourcetype nonrec t = {
  1. userPoolId : UserPoolIdType.t;
    (*

    The ID of the user pool that contains the group and the user that you want to remove.

    *)
  2. username : UsernameType.t;
    (*

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

    *)
  3. groupName : GroupNameType.t;
    (*

    The name of the group that you want to remove the user from, for example MyTestGroup.

    *)
}
Sourceval context_ : string
Sourceval make : userPoolId:UserPoolIdType.t -> username:UsernameType.t -> groupName:GroupNameType.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `String of UserPoolIdType.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t