search

camunda / camunda-docs

Camunda 8 Documentation, including all components and features
https://docs.camunda.io/
Other
51 stars 166 forks source link

Document environment variables for mapping rule initialization #3990

Open Ben-Sheppard opened 6 days ago

Ben-Sheppard commented 6 days ago

Description

Mapping rules are a method for Users to configure a mapping from a claim in their OIDC to a role/tenant in Camunda, there are two methods to achieve this, one is via the Identity UI which is documented, the other is via environment variables which is not documented. This programatic style of creating mapping rules can be useful to both customers and internal users for environment initialisation.

We should document these variables in a way that enables our users to access the functionality.

Variables

IDENTITY_MAPPINGRULES_<index>_NAME
IDENTITY_MAPPINGRULES_<index>_CLAIMNAME
IDENTITY_MAPPINGRULES_<index>_CLAIMVALUE
IDENTITY_MAPPINGRULES_<index>_OPERATOR
IDENTITY_MAPPINGRULES_<index>_RULETYPE
IDENTITY_MAPPINGRULES_<index>_APPLIEDROLENAMES_<index>
IDENTITY_MAPPINGRULES_<index>_APPLIEDTENANTIDS_<index>

Field values

IDENTITY_MAPPINGRULES_<index>_OPERATOR can have a value of equals (string) or contains (multivalue matching) IDENTITY_MAPPINGRULES_<index>_RULETYPE can have a value of tenant or role

Field interactions

Only one of these variables is set based on the IDENTITY_MAPPINGRULES_<index>_RULETYPE value.

IDENTITY_MAPPINGRULES_<index>_APPLIEDROLENAMES_<index>
IDENTITY_MAPPINGRULES_<index>_APPLIEDTENANTIDS_<index>