Skip to content

Commit

Permalink
[#486] Update config_cli.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
danielmursa-dev committed Dec 18, 2024
1 parent 1293e55 commit fcb0bf1
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/installation/config_cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
...
Expand All @@ -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: [email protected]
permissions:
- object_type: b0e8553f-8b1a-4d55-ab90-6d02f1bcf2c2
mode: read_and_write
...
Mozilla-django-oidc-db
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit fcb0bf1

Please sign in to comment.