Delete Group

cognitoidentityprovider_delete_group

R Documentation

Deletes a group from the specified user pool

Description

Deletes a group from the specified user pool. When you delete a group, that group no longer contributes to users' cognito:preferred_group or cognito:groups claims, and no longer influence access-control decision that are based on group membership. For more information about user pool groups, 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

Usage

cognitoidentityprovider_delete_group(GroupName, UserPoolId)

Arguments

GroupName

[required] The name of the group that you want to delete.

UserPoolId

[required] The ID of the user pool where you want to delete the group.

Value

An empty list.

Request syntax

svc$delete_group(
  GroupName = "string",
  UserPoolId = "string"
)