.. getting-started.rst


.. _getting-started-label:

===============
Getting Started
===============


Welcome to YubiEnterprise Services! This section provides guidance to supporting content for common tasks performed by different user categories working with the YubiEnterprise Console and the YubiEnterprise API. 

.. _login:

Logging in
============

To access the YubiEnterprise Console, your organization must first be set up, and your account must be activated through a first-time log in with a registered YubiKey as described in :ref:`onboard-users`.

.. important:: For enhanced security, the Console is being upgraded to use passwordless authentication. If you have not yet upgraded your Console account to passwordless authentication, you will be given the option to move to passwordless when logging in. For a limited time, you can still log in with your password. See :ref:`passkey-upgrade`.


To log in to the Console, do the following:

1. Have your YubiKey ready and go to https://console.yubico.com/login.
2. Click **Sign in with Passkey**.

   .. image:: graphics/welcome-dialog.png
      :width: 450

3. Ensure to select the *security key* passkey option if your browser suggests other (synced) passkey options. For example in the Chrome scenario below, click **Use a different passkey** to locate and select the passkey associated with the YubiKey registered with your Console account.

   .. image:: graphics/security-key-option.png
      :width: 400

4. When prompted, tap your YubiKey and provide the PIN associated with the YubiKey.
5. You will be logged in and taken to the **Dashboard** from where you can start working with your Console tasks.

.. note:: To ensure that the YubiKey (device-bound passkey) is always used when logging in, it is recommended to remove any existing synced passkeys. See :ref:`Best Practices - Synced Passkeys <passkey-remove>`.

.. _notifications:

Viewing Notifications
=====================

Notifications provide an overview of activities in the system, as well as important information regarding for example failed shipments requiring your interaction. Notifications are a good starting point when you first log in to the Console.

The **Notifications** (bell) icon in the top menu indicates the number of unread notifications if any. 

.. image:: graphics/notifications.png
   :width: 700

You can do the following when working with notifications:

* Click the **Notifications** icon to check the list of notifications to see if there are any activities that require user interaction, for example shipments with failed address validation.
* Click the unread notifications to read them and take action if needed. Notifications remain in the list after being read until they expire after 30 days.
* To filter notifications, click the **Filter** icon at the top right and select the desired option. You can for example filter notifications to only view unread ones.
* To keep desired notifications, click **Archive** for a notification to move it to the archive where it will be stored until deleted. Click **Archived** to view all archived notifications.
* Click **Mark all as read** to clear all unread indications. Notifications that have been read remain visible and you can see their record and take action at any time.
  
.. note:: Notification interactions are personalized. When you mark a notification as read, it will only be marked as read for you. Other Console users in your organization will still see the notification as unread until they mark the notification as read.


Working in the Console and API
===============================

.. Note:: What you can do in the Console depends on your role and permissions. The descriptions below are specific to each user category. For more information, see :ref:`user-permissions-label`.

Customers
----------

**Organization account owner with CONSOLE OWNER role**
  You are an account owner working with purchasing plans for your organization. You want to set up your organization's account, order a first set of YubiKeys, add more Console users for your organization, and manage their permissions. As Console Owner, you can also reset accounts if needed.
  
  **Understanding purchasing and delivery**

    * :ref:`Purchasing models <modes-of-purchase>`

    * :ref:`Shipping costs and taxes <shipping-costs-label>`

    * :ref:`Destinations, delivery types, and quantities <key-quantity-label>` 
  
  **Onboarding and accessing the Console**

    * :ref:`Onboarding steps <onboarding-label>`

    * :ref:`Viewing initial purchase <procedure-label>`

    * :ref:`Requesting initial shipping of YubiKeys <shipping-single-label>` 

  **Managing Console users in your organization**

    * :ref:`Adding users and permissions <add-users-label>`
  
    * :ref:`Resetting accounts <account-reset-label>`

**Organization IT administrator with CONSOLE ADMIN role**
  You manage deployment of YubiKeys for your organization. You want to see the inventory, understand how many keys are available, and ship keys to various parts of your organization. You want to check the status of shipments, and update shipment request details if needed.
  
  **Monitoring your inventory**

    * :ref:`Checking available inventory <dashboard-customer-view-label>`

    * :ref:`Viewing purchase orders <purchase-orders-label>`

    * :ref:`Managing customizations <customizations-label>`
  
  **Creating shipment requests**

    *  :ref:`Getting an overview of shipments <shipments-label>`

    *  :ref:`Requesting shipment to a single address <shipping-single-label>`
  
    *  :ref:`Requesting shipment to multiple addresses <shipping-multiple-label>`
   
  **Managing shipments**

    *  :ref:`Viewing shipments <shipment-viewing-label>` 

    *  :ref:`Correcting shipment addresses <incompletes-label>`

    *  :ref:`Editing and deleting shipments <editing-shipment-label>`

    *  :ref:`Viewing refunds for failed shipments  <refunds-label>`


**Organization auditor with CONSOLE AUDITOR role**
  You are an auditor for an organization and want to review data like purchase orders, shipments and permission settings. You also want to download information for reporting purposes.
  
  **Viewing data for an organization**

    * :ref:`Purchase orders <purchase-orders-label>`

    * :ref:`Shipment requests <shipments-label>`

    * :ref:`Processed refunds <refunds-label>`

    * :ref:`Users and their permissions <viewing-users-label>`
  
  **Downloading information**

    * :ref:`Shipment requests <shipments-csv-label>`

    * :ref:`Processed refunds <download-refund-csv>`


Distributors
--------------

**User with DISTRIBUTOR VIEW access**
  Distributors are organizations that sell Yubico products to associated resellers that in turn sell the products to end customers. As a distributor you want to see what was sold by your resellers, monitor customer inventories, and provide your resellers with access to view purchase orders.
  
  **Getting an overview**

    * :ref:`Reseller and customer overview <distributor-view-label>`

    * :ref:`Viewing inventory for a reseller's customer <distributor-inventory-view-label>`
  
  
  **Viewing purchase orders**

    * :ref:`Checking what was sold per reseller and customer <distributor-view-label>` 
  
    * :ref:`Viewing purchase order details <purchase-order-popup-label>` 

    * :ref:`Checking if a customer can use automated delivery (YE Delivery) <po-dist-column-headings>` 

  **Managing view permissions**

    * :ref:`Allowing resellers to view purchase orders <dist-manage-settings-label>` 

Resellers
-----------

**User with RESELLER VIEW access**
  Resellers are organizations that sell Yubico products to end customers. As a reseller you want to see what was sold to your customers, monitor their inventories, and provide access for customers to view purchase orders.
  
  **Getting an overview**

    * :ref:`Customer overview <reseller-view-label>` 

    * :ref:`Viewing inventory for a customer <reseller-inventory-view-label>` 
  
  **Viewing purchase orders**

    * :ref:`Checking what was sold for a customer <reseller-view-label>`
  
    * :ref:`Viewing purchase order details <purchase-order-popup-label>`  
  
    * :ref:`Checking if a customer can use automated delivery (YE Delivery) <po-resell-column-headings>` 

  **Managing view permissions**

    * :ref:`Allowing customers to view purchase orders <resell-manage-settings-label>` 

Integrators
------------

**Developer with CONSOLE ADMIN role**
  You are a developer integrating the YubiEnterprise API into a system on behalf of a customer organization. You want to understand how to get started with the YubiEnterprise API, and how to use it for example to create shipment requests.
  
  **Getting started with the YubiEnterprise API**

    * :ref:`API Onboarding Playbook <api-onboarding-pb-label>`

    * :ref:`Setting up an API caller with access token <api-caller-token-setup>` 

    * :ref:`Building a self-service delivery portal <yed-ss-wb>`
  
  **Working with the YubiEnterprise API**
    
    * :ref:`Requesting shipments <api-shipment-request>` 
  
    * :ref:`Listing, tracking, and searching shipments <api-tracking-label>`
  
    * :ref:`Requesting pre-registered YubiKeys through Okta <fpr-okta-label>` 

    * :ref:`Requesting pre-registered YubiKeys through Microsoft Entra <fpr-microsoft>` 

    * :ref:`Managing API tokens <lifecycle-label>`


  **Integration examples**

    * :ref:`Integrating with ServiceNow <servicenow-label>`


-------------------------------------

To file a support ticket for YubiEnterprise Delivery, click `Support <https://www.yubico.com/products/yubikey-as-a-service/contact-support/?selectForm=I+need+help+with+YubiEnterprise+Delivery>`_.