OpenMetadata/docs/install/Okta_OAuth_Setup.md

66 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

2021-08-01 14:27:44 -07:00
# How to use Okta for OAuth.
**This document is all about how to create an Okta app and configure it for oauth.
It will generate information which is required to perform single sign on activity.**
## Step 1: Create an Okta Account
* **Go to [Create Okta Account](https://developer.okta.com/signup/).**
* **Provide the required input and click on `Sign Up`.**
* **Else you can `continue with Google or Gitthub`.**
## Step 2: Create the OIDC app integration.
* **Once done with `signup/signin` you will be redirected to the `getting started` page of okta.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376300-e600d100-d5a7-11eb-8ceb-e90b5e265ce9.png)
****
* **Click `Applications -> Applications` available on the left side of the panel.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376308-e7ca9480-d5a7-11eb-84f8-9d8dce921c68.png)
****
* **Click on `Create App Integration` button.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376309-e8632b00-d5a7-11eb-8d5c-34c5f981786c.png)
****
## Step 3: Configuring the app
* **Once you click on `Create App Integration` button.**
* **Select `OIDC - OpenID Connect`.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376312-e8fbc180-d5a7-11eb-882f-a9083cb0ea87.png)
****
* **Then select the `Application type`.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376314-e9945800-d5a7-11eb-866b-5af5ca003f1e.png)
****
* **Once selected, click `Next`.**
* **Provide the necessary input and click `Save`.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376319-eac58500-d5a7-11eb-9167-a0d1cb8aedce.png)
****
* **The app is now configured.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376795-b43c3a00-d5a8-11eb-8a83-f146959f31c9.png)
****
## Step 4: Where to find the credentials
* **Once the app is configured, now the `Client Id` and `Client secret` can be used.**
* **You can also go to `Appication -> Application` like in step 2.**
* **You should be able to see your application in the list.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376803-b605fd80-d5a8-11eb-94ce-42f38dca99a1.png)
****
* **Click on your application.**
* **You will find your `Client id`,`Client secret` and `Okta domain`.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376795-b43c3a00-d5a8-11eb-8a83-f146959f31c9.png)
****
* **To get you `issuer` and `audience` click on `Sign On` available on top of the form.**
![Alt text](https://user-images.githubusercontent.com/83201188/123376802-b56d6700-d5a8-11eb-89b3-a59b3192fce6.png)
****
## Step 5: Adding the details in openmetadata-security.yaml
2021-08-01 14:27:44 -07:00
* **Once the `Client Id`, `Client secret`, `issuer` and `audience` is generated.
Add those details in openmetadata-security.yaml file in the respective field.**
2021-08-01 14:27:44 -07:00
![Alt text](https://user-images.githubusercontent.com/83201188/123380400-054e2d00-d5ad-11eb-9937-2813f69cb268.png)
****