Amazon Cognito · Schema

AdminGetDeviceRequest

Represents the request to get the device, as an administrator.

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Properties

Name Type Description
DeviceKey object
UserPoolId object
Username object
View JSON Schema on GitHub

JSON Schema

cognito-idp-admin-get-device-request-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "DeviceKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceKeyType"
        },
        {
          "description": "The device key."
        }
      ]
    },
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name."
        }
      ]
    }
  },
  "required": [
    "DeviceKey",
    "UserPoolId",
    "Username"
  ],
  "description": "Represents the request to get the device, as an administrator.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-idp-admin-get-device-request-schema.json",
  "title": "AdminGetDeviceRequest"
}