.. _iam-client:

.. note::
   - **Last modified by**: Rob Barnsley
   - **Last modified date**: 14/11/2024
   - **Support**: TBC.

IAM Client Configuration
========================

Creating a new IAM Client
-------------------------

A generic recipe to create a new IAM client is provided below. This supplements the official guide
`here <https://indigo-iam.github.io/v/v1.7.2/docs/tasks/user/client-registration/>`_. Service specific attributes
e.g. grant types, scopes, redirect_uris are specific to the service that the client is for & can be found in the
corresponding service documentation.

1. **Create an Account (if not previously created)**:
   
   - Register if you are not a member or log in `here <https://ska-iam.stfc.ac.uk/>`_.

2. **Log in and Set Up a Client**

   - Go to the dashboard `here <https://ska-iam.stfc.ac.uk/dashboard#!/home>`_.

3. **Configure the Client**

   - Navigate to `My Clients` and select `New Client`.
   - On the `Main` tab:

       - Enter a suitable name in the format ``service_<node>_<servicename>``, e.g. ``service_skaosrc_gatekeeper``
       - Enter a description of what this service is for.

4. **Configure Redirect URIs**

   - On the *Main* tab:

       - Add any redirect uris required for this service.

5. **Grant types**

   - On the *Grant types* tab:

       - Select the grant types required for the service.

6. **Authorised Scopes**

   - On the *Scopes* tab:

       - Select the scopes required for the the service. Custom scopes can be added using the text box at the bottom of
         the page.

7. **Save the Client**

   - Make sure you save the client before leave the page. The button is at the bottom.

The client ID and secret are available on the ``Main`` and ``Credentials`` tab respectively; they will need to be
provided to the service using the client.