.. _om-machine-clients:

Machine clients
===============

Machine clients give scripts, integrations and other systems access to the tenant
without a user account. Each client has its own credentials (Client ID and Client
secret) and only the permissions you select for it.

Use machine clients for automated access, and :ref:`users <om-tenant-users>` for people.
For example, a developer signs in with their own user account but configures their
integration to use a machine client. If the developer leaves, the integration keeps
working.

On the **Machine clients** page you can:

* :ref:`Create a client <om-create-machine-client>`
* See the clients of the tenant
* :ref:`Edit a client <om-edit-machine-client>`
* :ref:`Delete a client <om-delete-machine-client>`

.. figure:: ../images/machine-clients-view.png
   :alt: Machine clients page
   :width: 100%
   :align: center

.. _om-create-machine-client:

Create client
-------------

1. Click **+ Create client**.
2. Enter the client's name.
3. Select one or more permissions from the list.
4. Click **Create**.
5. Copy the credentials (Client ID and Client secret) and click **Done**.

.. figure:: ../images/create-machine-client.png
   :alt: Create machine client window with the permissions list
   :width: 100%
   :align: center

After you click **Create**, the **Machine client created successfully** window shows the
client's credentials:

* **Client ID**: the identifier of the client
* **Client secret**: the password the client signs in with, together with its Client ID
* **Example command to get the auth token**: a ready command with both credentials
  that gets an access token for the client

Click the copy icon next to a field to copy its value.

.. figure:: ../images/machine-client-success.png
   :alt: Machine client created successfully window with the client credentials
   :width: 100%
   :align: center

.. important:: The client secret is shown only once and cannot be viewed again. Store it
   securely, for example in a password manager. If you lose it, generate new credentials
   as described in :ref:`om-edit-machine-client`. This ends the client's existing sessions.

.. _om-edit-machine-client:

Edit client
-----------

1. On the **Machine clients** page, click the client.
2. In **Machine client details**, click **Generate new creds**.
3. Change the client's details, the same way as when creating a client.
4. Click **Generate new creds**.
5. Click **Done** in the credentials view.

.. figure:: ../images/generate-new-creds.png
   :alt: Generate new credentials for the machine client window
   :width: 100%
   :align: center

.. _om-delete-machine-client:

Delete client
-------------

1. On the **Machine clients** page, click the client.
2. Click the red **Delete client** button.
3. Confirm by clicking the red **Delete** button.

.. figure:: ../images/delete-machine-client.png
   :alt: Delete machine client confirmation
   :width: 100%
   :align: center