Skip to content

Settings

Welcome to the "Settings" section of the Agntcy AGNTCY Identity Service. This section provides a comprehensive guide to managing critical configurations, including API Keys, Devices and Organizations & Users. This documentation will help you navigate the settings interface and utilize its functionalities effectively.

API Keys

The API Keys subsection allows administrators to create, view, and manage API Keys within the AGNTCY Identity Service. These keys are essential for authenticating and securing interactions between Agentic Services and external systems.

Accessing API Keys

  1. Navigate to API Keys: From the "Settings" menu on the left-hand navigation panel, select the "API Key" tab.

Access API Keys Section

Creating an API Key

  1. Create API Key: If no API Keys are found, click on the "+ Create API Key" button to initiate the creation process. Create API Key

  2. Generate API Key: Upon clicking "Create API Key," the system will generate a new API Key for use. Generate API Key

Managing API Keys

  1. Viewing API Keys: The API Keys tab will display all existing keys. Each key can be copied for use by clicking the copy icon next to it. Generate API Key

  2. Refresh API Key: To refresh an existing API Key, click the "Refresh" button. This will generate a new key and invalidate the old one. Generate API Key

Devices

The Devices section within the AGNTCY Identity Service allows you to register and manage your personal devices for secure authentication and notification purposes. By onboarding a device, you enable it to receive push notifications for identity approvals and enhance the overall security posture of your Agent Identity environment. This guide details the process of adding a new device and managing existing ones.

Adding a New Device

Follow these steps to register and configure your device:

  1. Access the Devices Section:

  2. From the main dashboard, locate and click on Settings in the left-hand navigation menu.

  3. Within the Settings section, select Devices.

  4. On the Devices management page, click the + Add Device button to initiate the connection wizard.

    Access Devices Section

  5. Onboard Your Device:

  6. A pop-up window titled "Onboard Device" will appear, displaying a QR code. This QR code is unique to your session and is used to link your mobile device.

    Device popup

  7. Using your mobile device's camera, scan the displayed QR code. Alternatively, you can click the "or click here" link if scanning is not feasible.

    Mobile device scan

  8. Enable Notifications on Your Mobile Device:

  9. After scanning the QR code, your mobile device will open a web page. Initially, you might see a "Notification Status: Push Notifications Not Supported" message.

    Mobile page

  10. To enable notifications, you may need to add the AGNTCY Identity Service web page to your mobile device's home screen. Access your browser's options (e.g., the share icon on iOS) and select "Add to Home Screen".

    Mobile Device Home setting

    Mobile Device Home setting

  11. Confirm the addition. An icon for the AGNTCY Identity Service will appear on your home screen.

    Mobile Device Home Addition

  12. Open the newly created home screen application. You will be prompted to authorize notifications. Select Authorize.

    Mobile Device notification status

  13. Upon successful authorization, the "Notification Status" on the web page should update to "Push Notifications Enabled".

    Mobile Device notification status

Managing Registered Devices

Once a device is successfully added, you can view and manage it from the Devices section in the AGNTCY Identity Service portal.

  1. Viewing Registered Devices:

  2. The Devices dashboard will now display a list of your registered devices, including details such as the device name (e.g., "iPhone (iOS 18.5) - Safari"), User ID, and the "Created At" timestamp.

Mobile Device Registered

  1. Testing Device Notifications:

  2. To ensure your device is receiving notifications correctly, you can send a test notification.

  3. Locate the desired device in the list and click the options menu next to its entry.

    Mobile Device notification testing

  4. From the dropdown menu, select Test.

  5. A test notification will be sent to your registered device, appearing as a push notification on your mobile screen.

Mobile Device notification testing

  1. Deleting a Device:

  2. If a device is no longer needed or you wish to remove it from your account, you can delete it.

  3. From the options menu next to the device entry, select Delete.

    Mobile Device Deletion

  4. Confirm the deletion when prompted.

Organizations & Users

The Organizations & Users subsection provides tools for managing organizational structures and user roles within the AGNTCY Identity Service. This section is crucial for defining user access and maintaining organizational oversight.

Accessing Organizations & Users

  1. Navigate to Organizations & Users: From the "Settings" menu, select the "Organizations & Users" tab to view existing organizations.

Access Orgs and Users Section

Creating and Managing Organizations

  1. Create New Organization: Click on the "+ New Organization" button to start the organization creation wizard.

Create new organization

  1. Confirmation and Creation: A dialog box will appear asking for confirmation to create a new organization. Click "Continue" to proceed.

Create new organization

  1. Organization Listing: Once created, the organization will appear in the list. You can manage existing organizations by selecting options such as "Invite," "Edit," or "Delete."

Create new organization

Inviting Users

  1. Invite User: Click on "Invite User" to open the user invitation interface.

Invite user

  1. Enter User Details: Provide the email of the user you wish to invite and click "Invite" to send an invitation.

Invite user details

Managing Users