| Mikhail Ivanov | 7913310 | 2018-05-29 13:27:45 +0400 | [diff] [blame] | 1 | |
| 2 | ================================== |
| 3 | Keycloak Formula |
| 4 | ================================== |
| 5 | |
| 6 | Service keycloak description |
| 7 | |
| 8 | |
| 9 | Sample Metadata |
| 10 | =============== |
| 11 | |
| 12 | Single keycloak service |
| 13 | |
| 14 | .. code-block:: yaml |
| 15 | |
| 16 | keycloak: |
| 17 | server: |
| 18 | enabled: true |
| 19 | |
| Adam Tengler | d761af0 | 2018-10-23 18:08:46 +0000 | [diff] [blame] | 20 | Keycloak service with realm using LDAP identity provider |
| 21 | |
| 22 | .. code-block:: yaml |
| 23 | |
| 24 | keycloak: |
| 25 | server: |
| Martin Polreich | 05c816b | 2019-01-24 10:48:03 +0100 | [diff] [blame^] | 26 | enabled: true |
| Adam Tengler | d761af0 | 2018-10-23 18:08:46 +0000 | [diff] [blame] | 27 | realm: |
| 28 | ldap-realm: |
| 29 | enabled: true |
| 30 | id: ldap-realm |
| 31 | client: |
| 32 | ldap-app: |
| 33 | enabled: true |
| 34 | base_url: /ldap-portal |
| 35 | redirect_uris: |
| 36 | - /ldap-portal/* |
| Adam Tengler | 4576ba1 | 2018-10-26 18:00:43 +0200 | [diff] [blame] | 37 | web_origins: |
| 38 | - "*" |
| 39 | public_client: false |
| Adam Tengler | d761af0 | 2018-10-23 18:08:46 +0000 | [diff] [blame] | 40 | admin_url: /ldap-portal |
| 41 | secret: password |
| 42 | protocol_mapper: |
| 43 | oidc-usermodel-property-mapper: |
| 44 | username: |
| 45 | name: username |
| 46 | user_attribute: username |
| 47 | claim_name: preferred_username |
| 48 | given_name: |
| 49 | name: given name |
| 50 | user_attribute: firstName |
| 51 | claim_name: given_name |
| 52 | family_name: |
| 53 | name: family name |
| 54 | user_attribute: lastName |
| 55 | claim_name: family_name |
| 56 | email: |
| 57 | name: email |
| 58 | user_attribute: email |
| 59 | claim_name: email |
| 60 | oidc-full-name-mapper: |
| 61 | full_name: |
| 62 | name: full_name |
| 63 | federation_provider: |
| 64 | ldap: |
| 65 | display_name: ldap-server |
| 66 | users_dn: ou=people,dc=keycloak,dc=org |
| 67 | user_object_classes: inetOrgPerson, organizationalPerson |
| 68 | username_ldap_attribute: uid |
| 69 | bind_dn: cn=admin,dc=keycloak,dc=org |
| 70 | bind_credential: password |
| 71 | rdn_ldap_attribute: uid |
| 72 | edit_mode: READ_ONLY |
| 73 | uuid_ldap_attribute: entryUUID |
| 74 | connection_url: ldap://localhost:10389 |
| 75 | sync_registrations: false |
| 76 | federation_mapper: |
| 77 | user-attribute-ldap-mapper: |
| 78 | username: |
| 79 | name: username |
| 80 | provider_display_name: ldap-server |
| 81 | ldap_attribute: uid |
| 82 | model_attribute: username |
| 83 | mandatory: true |
| 84 | read_only: false |
| 85 | always_read: false |
| 86 | first_name: |
| 87 | name: first name |
| 88 | provider_display_name: ldap-server |
| 89 | ldap_attribute: cn |
| 90 | model_attribute: firstName |
| 91 | mandatory: true |
| 92 | read_only: false |
| 93 | always_read: false |
| 94 | last_name: |
| 95 | name: last name |
| 96 | provider_display_name: ldap-server |
| 97 | ldap_attribute: sn |
| 98 | model_attribute: lastName |
| 99 | mandatory: true |
| 100 | read_only: false |
| 101 | always_read: false |
| 102 | email: |
| 103 | name: email |
| 104 | provider_display_name: ldap-server |
| 105 | ldap_attribute: mail |
| 106 | model_attribute: email |
| 107 | mandatory: false |
| 108 | read_only: false |
| 109 | always_read: false |
| 110 | role-ldap-mapper: |
| 111 | realm_roles: |
| 112 | name: realm roles |
| 113 | provider_display_name: ldap-server |
| 114 | roles_dn: ou=groups,dc=cicd,dc=local |
| 115 | membership_ldap_attribute: member |
| 116 | role_name_ldap_attribute: cn |
| 117 | role_object_classes: groupOfNames |
| 118 | mode: LDAP_ONLY |
| 119 | realm_roles_mapping: true |
| 120 | |
| Mikhail Ivanov | 7913310 | 2018-05-29 13:27:45 +0400 | [diff] [blame] | 121 | |
| 122 | References |
| 123 | ========== |
| 124 | |
| 125 | * A link to the documentation |
| 126 | * A link to the home page |
| 127 | * A link to the source code |