@amazon-devices/kepler-identifiers - Amazon Vega Docs

Amazon Developer

Console

as

Settings

Sign out

Notifications

Alexa

Amazon Appstore

Ring

AWS

Documentation

Support

Contact Us

My Cases

Console

as

Vega Developer Docs

Get Started

Design and Develop

Publish

Reference

Support

The Vega Identifiers API provides functionality for generating, retrieving, and managing identifiers such as UUIDs, device name, and user agent as well as tracking and ad identifiers.

Getting started

Setup

Add the following library dependency to the dependencies section of your package.json file.

"@amazon-devices/kepler-identifiers": "~0.2.1"

In your manifest.toml, add the following privileges required to access the device-friendly name.

[[needs.privilege]]
id = "com.amazon.devconf.privilege.identifiers.device-friendly-name"

Usage

Generate UUID v4

This example demonstrates how to generate a UUID v4. The code shows a simple handler function that wraps the generateUuidV4() method with basic error handling. You can use this pattern to integrate into your app’s event handlers or utility functions.

import {KeplerIdentifiers as Identifiers} from '@amazon-devices/kepler-identifiers';

const handleGenerateUuidV4 = () => {
  try {
    let result = Identifiers.generateUuidV4();
    return result;
  } catch (error) {
    console.error(error);
  }
};

Get the friendly device name

The getFriendlyDeviceName() method returns the friendly name of the device for the current persona. Returns one of the following:

The user-customized device name if it exists and the caller has the com.amazon.devconf.privilege.identifiers.device-friendly-name run-time privilege
The device model name in the following cases:
- No user-customized name is set
- The caller lacks the required privilege

import {KeplerIdentifiers as Identifiers} from '@amazon-devices/kepler-identifiers';

const handleGetFriendlyDeviceName = async () => {
  try {
    let result = await Identifiers.getFriendlyDeviceName();
    return result;
  } catch (error) {
    console.error(error);
  }
};

Request run-time privileges

To acquire run-time privileges, get the consent of the user. You can open the user consent dialog by requesting run-time the “com.amazon.devconf.privilege.identifiers.device-friendly-name” privilege using the Security Manager API.

import {SecurityManager, PrivilegeState} from '@amazon-devices/security-manager-lib';
import { KeplerIdentifiers as Identifiers } from '@amazon-devices/kepler-identifiers';

const DEVICE_NAME_PRIVILEGE = 'com.amazon.devconf.privilege.identifiers.device-friendly-name';
SecurityManager.getPrivilegeState(DEVICE_NAME_PRIVILEGE).then(
      function(state: PrivilegeState) {
        if (state == PrivilegeState.ALLOW) {
          // User had consented.
          return Identifiers.getFriendlyDeviceName();
        } else {
          // Request for user consent
          // This call blocks, each app will integrate this call into their threading model or event loop
          SecurityManager.requestPrivilege(DEVICE_NAME_PRIVILEGE).then(
            function(state: PrivilegeState) {
              if (state == PrivilegeState.ALLOW) {
                // User has consented now.
                return Identifiers.getFriendlyDeviceName();
              } else {
                // User didn't consent.
              }
            },
            function(error: Object) { KPLOG().error("Failed to request privilege: {}", error["message"]); }
          )
        }
      },
      function(error: Object) { KPLOG().error("Failed to get privilege state: {}", error["message"]); }
    )

Modules

Last modified on February 19, 2026