From fcb0bf104c78871cacb9854320f334854290647b Mon Sep 17 00:00:00 2001 From: Daniel Mursa Date: Wed, 18 Dec 2024 10:00:54 +0100 Subject: [PATCH] [#486] Update config_cli.rst --- docs/installation/config_cli.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/installation/config_cli.rst b/docs/installation/config_cli.rst index 4445262a..5e9a4056 100644 --- a/docs/installation/config_cli.rst +++ b/docs/installation/config_cli.rst @@ -68,6 +68,7 @@ To configure objecttypes the following configuration could be used: name: Object Type 2 service_identifier: objecttypen-bar ... + .. note:: The ``uuid`` field will be used to lookup existing ``ObjectType``'s. Objecttypes require a corresponding ``Service`` to work correctly. Creating @@ -102,12 +103,15 @@ created. An example of a configuration could be seen below: auth_type: api_key header_key: Authorization header_value: Token b9f100590925b529664ed9d370f5f8da124b2c20 - .... + ... Tokens configuration -------------------- Create or update the (single) YAML configuration file with your settings: +.. note:: To ensure the proper functioning of the tokens, it is essential to first configure the ``objecttypes``. + Then, the token configuration must be completed to guarantee the correct configuration of the ``Permissions``. + .. code-block:: yaml ... @@ -121,12 +125,20 @@ Create or update the (single) YAML configuration file with your settings: organization: Organization XYZ # optional application: Application XYZ # optional administration: Administration XYZ # optional - is_superuser: true # optional + permissions: + - object_type: b427ef84-189d-43aa-9efd-7bb2c459e281 + mode: read_only + use_fields: true + fields: + key1: value1 - identifier: token-2 token: 7b2b212d9f16d171a70a1d927cdcfbd5ca7a4799 contact_person: Person 2 email: person-2@example.com + permissions: + - object_type: b0e8553f-8b1a-4d55-ab90-6d02f1bcf2c2 + mode: read_and_write ... Mozilla-django-oidc-db @@ -184,7 +196,7 @@ item present that matches the ``notifications_api_service_identifier`` in the notification_delivery_max_retries: 1 notification_delivery_retry_backoff: 2 notification_delivery_retry_backoff_max: 3 - .... + ... Execution