Skip to content

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

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 ID of the user pool where you want to view a user's groups.

Limit

The maximum number of groups that you want Amazon Cognito to return in the response.

NextToken

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

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"
)