Admin List Groups for User

cognitoidentityprovider_admin_list_groups_for_user

R Documentation

Lists the groups that a user belongs to¶

Description¶

Lists the groups that a user belongs to.

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_admin_list_groups_for_user(Username, UserPoolId,
  Limit, NextToken)

Arguments¶

Username: [required] 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.
UserPoolId: [required] The user pool ID for the user pool.
Limit: The limit of the request to list groups.
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(
  Groups = list(
    list(
      GroupName = "string",
      UserPoolId = "string",
      Description = "string",
      RoleArn = "string",
      Precedence = 123,
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      CreationDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$admin_list_groups_for_user(
  Username = "string",
  UserPoolId = "string",
  Limit = 123,
  NextToken = "string"
)