public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-28 14:08:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update okta

Browse Source
This commit is contained in:
Logan
2019-03-22 10:06:33 -07:00
committed by Denise Schannon
parent 948a3fe751
commit f875698fea
1 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rancher/v2.x/en/admin-settings/authentication/okta/_index.md
+10 -12
View File
@@ -1,47 +1,45 @@
--- ---
title: Configuring OKTA (SAML) title: Configuring Okta (SAML)
weight: 1200 weight: 1200
--- ---
_Available as of v2.2.0_ _Available as of v2.2.0_
If your organization uses OKTA Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials. If your organization uses Okta Identity Provider (IdP) for user authentication, you can configure Rancher to allow your users to log in using their IdP credentials.
## Prerequisites ## Prerequisites
In Okta, create a SAML Application with the settings below. See the [Okta documentation](https://developer.okta.com/standards/SAML/setting_up_a_saml_application_in_okta) for help. In Okta, create a SAML Application with the settings below. See the [Okta documentation](https://developer.okta.com/standards/SAML/setting_up_a_saml_application_in_okta) for help.
>**Note:** You should set `Single Sign on URL` and `Audience URI (SP Entity ID)` as the following description.
Setting | Value Setting | Value
------------|------------ ------------|------------
`Single Sign on URL` | `https://[rancher server address]/v1-saml/okta/saml/acs` `Single Sign on URL` | `https://yourRancherHostURL/v1-saml/okta/saml/acs`
`Audience URI (SP Entity ID)` | `https://[rancher server address]/v1-saml/okta/saml/metadata` `Audience URI (SP Entity ID)` | `https://yourRancherHostURL/v1-saml/okta/saml/metadata`
## Configuring OKTA in Rancher ## Configuring Okta in Rancher
1. From the **Global** view, select **Security > Authentication** from the main menu. 1. From the **Global** view, select **Security > Authentication** from the main menu.
1. Select **OKTA**. 1. Select **Okta**.
1. Complete the **Configure Okta Account** form. The examples below describe how you can map OKTA attributes to fields within Rancher. 1. Complete the **Configure Okta Account** form. The examples below describe how you can map Okta attributes to fields within Rancher.
| Field | Description | | Field | Description |
| ------------------------- | ----------------------------------------------------------------------------- | | ------------------------- | ----------------------------------------------------------------------------- |
| Display Name Field | The attribute that contains the display name of users. | | Display Name Field | The attribute that contains the display name of users. |
| User Name Field | The attribute that contains the user name/given name. | | User Name Field | The attribute that contains the user name/given name. |
| UID Field | An attribute that is unique to every user. Either it can be the same as `User Name Field` or you can define a different one according to your own request. | | UID Field | An attribute that is unique to every user. |
| Groups Field | Make entries for managing group memberships. | | Groups Field | Make entries for managing group memberships. |
| Rancher API Host | The URL for your Rancher Server. | | Rancher API Host | The URL for your Rancher Server. |
| Private Key / Certificate | A key/certificate pair to create a secure shell between Rancher and your IdP. | | Private Key / Certificate | A key/certificate pair to create a secure shell between Rancher and your IdP. |
| Metadata XML | The `metadata.xml` file that you restored from your IdP server. | | Metadata XML | The `Identity Provider metadata` file that you find in the application `Sign On` section. |
>**Tip:** You can generate a key/certificate pair using an openssl command. For example: >**Tip:** You can generate a key/certificate pair using an openssl command. For example:
> >
> openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout myservice.key -out myservice.cert > openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 -keyout myservice.key -out myservice.crt
1. After you complete the **Configure Okta Account** form, click **Authenticate with Okta**, which is at the bottom of the page. 1. After you complete the **Configure Okta Account** form, click **Authenticate with Okta**, which is at the bottom of the page.