mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-19 07:17:38 +00:00
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
|
---
|
||
|
|
title: Auth code flow of Keyclock
|
||
|
|
slug: /deployment/security/keycloak/auth-code-flow
|
||
|
|
collate: false
|
||
|
|
---
|
||
|
|
|
||
|
|
# Auth Code Flow
|
||
|
|
|
||
|
|
|
||
|
|
### Step 1: Create OpenMetadata as a new Client
|
||
|
|
- Click on `Clients` in the menu.
|
||
|
|
- Click on `Create Client` button.
|
||
|
|
- Select the `Client type`.
|
||
|
|
- Enter the `Client ID`.
|
||
|
|
- Enter the Name and Description `(Optional)`.
|
||
|
|
- Click on `Next` button.
|
||
|
|
|
||
|
|
{% image src="/images/v1.7/deployment/security/keycloak/keycloak-step-3.png" alt="add-client" /%}
|
||
|
|
|
||
|
|
### Step 2: Edit Configs of the client
|
||
|
|
- Enable `Client authentication` and `Authorization`.
|
||
|
|
- Select `Standard flow` as an `Authentication flow`.
|
||
|
|
- Click `Next`.
|
||
|
|
|
||
|
|
{% image src="/images/v1.7/deployment/security/keycloak/keycloak-step-4.png" alt="compatibility configs" /%}
|
||
|
|
|
||
|
|
### Step 3: Add Login Settings
|
||
|
|
- fill the required options
|
||
|
|
|
||
|
|
{% image src="/images/v1.7/deployment/security/keycloak/keycloak-step-5.png" alt="edit-settings-url.png" /%}
|
||
|
|
|
||
|
|
- Click on `Save` button.
|
||
|
|
|
||
|
|
{% note %}
|
||
|
|
|
||
|
|
Note: Scopes `openid`, `email` & `profile` are required to fetch the user details so you will have to add these scopes in your client.
|
||
|
|
|
||
|
|
{% /note %}
|
||
|
|
|
||
|
|
### Step 3: Where to Find the Credentials
|
||
|
|
|
||
|
|
- Navigate to the `Credentials` tab.
|
||
|
|
- You will find your `Client Secret` related to the Client id "open-metadata"
|
||
|
|
|
||
|
|
{% image src="/images/v1.7/deployment/security/keycloak/keycloak-step-6.png" alt="client-credentials" /%}
|