Skip to content

Admin List Devices

cognitoidentityprovider_admin_list_devices R Documentation

Lists a user's registered devices

Description

Lists a user's registered devices. Remembered devices are used in authentication services where you offer a "Remember me" option for users who you want to permit to sign in without MFA from a trusted device. Users can bypass MFA while your application performs device SRP authentication on the back end. For more information, see Working with devices.

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_devices(UserPoolId, Username, Limit,
  PaginationToken)

Arguments

UserPoolId

[required] The ID of the user pool where the device owner is a user.

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.

Limit

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

PaginationToken

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(
  Devices = list(
    list(
      DeviceKey = "string",
      DeviceAttributes = list(
        list(
          Name = "string",
          Value = "string"
        )
      ),
      DeviceCreateDate = as.POSIXct(
        "2015-01-01"
      ),
      DeviceLastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      DeviceLastAuthenticatedDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  PaginationToken = "string"
)

Request syntax

svc$admin_list_devices(
  UserPoolId = "string",
  Username = "string",
  Limit = 123,
  PaginationToken = "string"
)