{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"2e6cc0ed-a27a-4c75-bd8c-d94d3569dbd5"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"1ff43cd9-e208-43b7-88a2-6f003f468544"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"The Authorization Customization feature provides flexible role management by allowing users to tailor how roles are defined and displayed. Roles are assigned through a scoped role string managed by an identity provider (IDP), and this feature introduces several customization options:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Customizable scoped role delimiter","type":"text","marks":[{"type":"strong"}]},{"text":": Users can define their own delimiter to separate parts of the scoped role string. By default, a period (","type":"text"},{"text":".","type":"text","marks":[{"type":"code"}]},{"text":") is used, but it can be changed to an underscore (","type":"text"},{"text":"_","type":"text","marks":[{"type":"code"}]},{"text":") or any other character, enhancing integration with different IDP configurations.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Customizable Wildcard","type":"text","marks":[{"type":"strong"}]},{"text":": The second part of a three-part scoped role string specifies a configuration area, and a wildcard character can represent access to all non-confidential areas. While the default wildcard is an asterisk (","type":"text"},{"text":"*","type":"text","marks":[{"type":"code"}]},{"text":"), users can now customize it to any character or string, providing more flexibility in defining access levels.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Role Claim configuration","type":"text","marks":[{"type":"strong"}]},{"text":": Allows to define which claim in the token coming from the IDP should be used as the scoped role claim. Depending on that different formats for role display names can be configured within the application. This allows for more intuitive and organization-specific naming conventions that align with the user’s role and access permissions.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"These enhancements enable organizations to align role management and display with their specific needs and identity provider configurations, facilitating more precise control over user access and role representation in the application.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Customizable Scoped Role Delimiter","type":"text"}]},{"type":"paragraph","content":[{"text":"The CDCM application allows the delimiter used in scoped role strings to be customized, providing flexibility in how roles are structured and integrated with various identity providers.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Configuration","type":"text","marks":[{"type":"strong"}]},{"text":": The delimiter can be set using the environment variable ","type":"text"},{"text":"ROLE_DELIMITER","type":"text","marks":[{"type":"code"}]},{"text":". By default, the delimiter is a period (","type":"text"},{"text":".","type":"text","marks":[{"type":"code"}]},{"text":"), but it can be changed to any character, such as an underscore (","type":"text"},{"text":"_","type":"text","marks":[{"type":"code"}]},{"text":"), to match the format used in the IDP.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Usage Example","type":"text","marks":[{"type":"strong"}]},{"text":": If ","type":"text"},{"text":"ROLE_DELIMITER","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"_","type":"text","marks":[{"type":"code"}]},{"text":", the scoped role string can be formatted as ","type":"text"},{"text":"spaceKey_areaKey_roleKey","type":"text","marks":[{"type":"code"}]},{"text":", enabling clearer separation of the space, configuration area, and role components.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Customizable Wildcard","type":"text"}]},{"type":"paragraph","content":[{"text":"The CDCM application provides the ability to customize the wildcard used in scoped role strings, enhancing flexibility in defining access across multiple configuration areas.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Configuration","type":"text","marks":[{"type":"strong"}]},{"text":": The wildcard character can be set using the environment variable ","type":"text"},{"text":"CONFIGURATION_AREA_WILDCARD","type":"text","marks":[{"type":"code"}]},{"text":". By default, the wildcard is an asterisk (","type":"text"},{"text":"*","type":"text","marks":[{"type":"code"}]},{"text":"), but it can be changed to any character or string, such as ","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"%","type":"text","marks":[{"type":"code"}]},{"text":", to meet specific organizational needs.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Usage Example","type":"text","marks":[{"type":"strong"}]},{"text":": If ","type":"text"},{"text":"CONFIGURATION_AREA_WILDCARD","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"any","type":"text","marks":[{"type":"code"}]},{"text":", the scoped role string ","type":"text"},{"text":"spaceKey_any_roleKey","type":"text","marks":[{"type":"code"}]},{"text":" allows users to have the specified role in all non-confidential configuration areas.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"This feature allows organizations to customize access patterns and streamline role management by using intuitive and relevant wildcard symbols that align with their identity provider and access control strategies.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Role Claim configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"The CDCM application allows the usage of different claims in the token coming from the IDP. By doing this this the roles set in a specific claim are used for authorization in the CDCM application and different fields in that claim can be used for the display names. This enhances clarity and alignment with organizational naming conventions. It is also possible to specify a prefix that should be ignored when parsing the role claim string coming from the identity provider. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Configuration","type":"text","marks":[{"type":"strong"}]},{"text":": Display names are configured using the environment variable ","type":"text"},{"text":"OAUTH_CLAIM_CONFIGURATION","type":"text","marks":[{"type":"code"}]},{"text":". This variable should contain a JSON array, where each object defines the claim attribute (=","type":"text"},{"text":"roleClaimAttribut","type":"text","marks":[{"type":"code"}]},{"text":") and the corresponding display name format (=","type":"text"},{"text":"displayNameForma","type":"text","marks":[{"type":"code"}]},{"text":") as well as an ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"strong"}]},{"text":" field for the prefix that should be ignored while parsing the role string(=","type":"text"},{"text":"prefix","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"JSON Format","type":"text","marks":[{"type":"strong"}]},{"text":": Each object in the array specifies a ","type":"text"},{"text":"roleClaimAttribute","type":"text","marks":[{"type":"code"}]},{"text":", a ","type":"text"},{"text":"displayNameFormat","type":"text","marks":[{"type":"code"}]},{"text":" and a ","type":"text"},{"text":"prefix","type":"text","marks":[{"type":"code"}]},{"text":". The display name format can include placeholders (","type":"text"},{"text":"<<>>","type":"text","marks":[{"type":"code"}]},{"text":") to dynamically insert token attributes into the display name.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Example Configuration","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"[\n {\n \"roleClaimAttribute\": \"roles\",\n \"prefix\": \"I_will_be_ignored\",\n \"displayNameFormat\": \"System user <>\"\n },\n {\n \"roleClaimAttribute\": \"groups\",\n \"displayNameFormat\": \"<> <>\"\n },\n {\n \"roleClaimAttribute\": \"cdcm.groups\",\n \"displayNameFormat\": \"<> <> | <>\"\n }\n]\n","type":"text"}]},{"type":"paragraph"}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Usage","type":"text","marks":[{"type":"strong"}]},{"text":": This configuration allows display names to be dynamically generated based on user attributes, providing personalized and informative identifiers. For example, a display name might appear as \"System user 12345\" or \"John Doe | Sales\" based on the claims found in the user token.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Email To Role Admin Mapping","type":"text"}]},{"type":"paragraph","content":[{"text":"CDCM can add the ","type":"text"},{"text":"roleAdmin","type":"text","marks":[{"type":"code"}]},{"text":" Role that is created during space creation to arbitrary users by adding their email address to a comma-separated list in the environment variable ","type":"text"},{"text":"ROLE_ADMINS","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"export ROLE_ADMINS=\"alice@example.com bob@example.com\"","type":"text"}]},{"type":"paragraph","content":[{"text":"CDCM will add the ","type":"text"},{"text":"roleAdmin","type":"text","marks":[{"type":"code"}]},{"text":" role for all spaces the the users alice and bob that are mapped via the email addresses in the OIDC Token Response from the IAM system.","type":"text"}]}],"version":1}

Browser not supported