Skip to content

List Users In Group

cognitoidentityprovider_list_users_in_group R Documentation

Lists the users in the specified group

Description

Lists the users in the specified group.

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

Usage

cognitoidentityprovider_list_users_in_group(UserPoolId, GroupName,
  Limit, NextToken)

Arguments

UserPoolId

[required] The user pool ID for the user pool.

GroupName

[required] The name of the group.

Limit

The maximum number of users that you want to retrieve before pagination.

NextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Value

A list with the following syntax: 

list(
  Users = list(
    list(
      Username = "string",
      Attributes = list(
        list(
          Name = "string",
          Value = "string"
        )
      ),
      UserCreateDate = as.POSIXct(
        "2015-01-01"
      ),
      UserLastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      Enabled = TRUE|FALSE,
      UserStatus = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD"|"EXTERNAL_PROVIDER",
      MFAOptions = list(
        list(
          DeliveryMedium = "SMS"|"EMAIL",
          AttributeName = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_users_in_group(
  UserPoolId = "string",
  GroupName = "string",
  Limit = 123,
  NextToken = "string"
)