You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admin/runai-setup/authentication/sso.md
+41-4Lines changed: 41 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,9 @@
1
1
# Single Sign-On
2
2
3
-
Single Sign-On (SSO) is an authentication scheme that allows a user to log in with a single ID to other, independent, software systems. SSO solves security issues involving multiple user/password data entries, multiple compliance schemes, etc.
3
+
Single Sign-On (SSO) is an authentication scheme allowing users to log in with a single ID to other, independent, software systems. SSO solves security issues involving multiple user/password data entries, multiple compliance schemes, etc.
4
+
5
+
Run:ai supports SSO using the [SAML 2.0](https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language){target=_blank} protocol, Open ID Connect [OIDC](https://openid.net/developers/how-connect-works/){target=_blank} and [OpenShift V4](https://en.wikipedia.org/wiki/OpenShift){target=_blank}.
4
6
5
-
Run:ai supports SSO using the [SAML 2.0](https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language){target=_blank} protocol and Open ID Connect or [OIDC](https://openid.net/developers/how-connect-works/){target=_blank}.
6
7
7
8
!!! Caution
8
9
Single sign-on is only available with SaaS installations where the tenant has been created post-January 2022 or any Self-hosted installation of release 2.0.58 or later. If you are using single sign-on with older versions of Run:ai, please contact Run:ai customer support
@@ -13,14 +14,41 @@ Run:ai supports SSO using the [SAML 2.0](https://en.wikipedia.org/wiki/Security_
13
14
14
15
## SAML Prerequisites
15
16
16
-
**XML Metadata**—you must have an *XML Metadata file* retrieved from your IdP. Upload the file to a web server such that you will have a URL to the file. The URL must have the *XML* file extension. For example, to connect using Google, you must create a custom SAML App [here](https://admin.google.com/ac/apps/unified){target=_blank}, download the Metadata file, and upload it to a web server.
17
+
**XML Metadata**—you must have an *XML Metadata file* retrieved from your IdP. Upload the file to a web server so that you have a URL to the file. The URL must have the *XML* file extension. For example, to connect using Google, you must create a custom SAML App [here](https://admin.google.com/ac/apps/unified){target=_blank}, download the Metadata file, and upload it to a web server.
17
18
18
19
## OIDC Prerequisites
19
20
20
21
***Discovery URL**—the OpenID server where the content discovery information is published.
21
22
***ClientID**—the ID used to identify the client with the Authorization Server.
22
23
***Client Secret**—a secret password that only the Client and Authorization Server know.
23
24
25
+
26
+
## OpenShift Prerequisites
27
+
28
+
Before using OpenShift, first define OAuthClient to control various aspects of the OAuth flow, such as redirect URIs and authentication methods to ensure secure and approprpriate access to resources.
29
+
30
+
To define OAuthClient, follow these steps:
31
+
32
+
1. Create a new ```OAuthClient``` Kubernetes object with the following content
2. Run the following command to apply the OAuthClient object to the environment. Create the object on OpenShift cluster where you define your OpenShift IDP:
44
+
```
45
+
oc apply <file name>
46
+
```
47
+
3. Check that the file has been applied successfully by running the following command:
48
+
```
49
+
oc get oauthclient
50
+
```
51
+
24
52
### Additional attribute mappings
25
53
26
54
You can configure your IdP to map several IdP attributes:
@@ -71,10 +99,19 @@ You can configure your IdP to map several IdP attributes:
71
99
1. In the `Discovery URL` field, enter the discovery URL .
72
100
2. In the `Client ID` field, enter the client ID.
73
101
3. In the `Client Secret` field, enter the client secret.
74
-
4. Add OIDC scope to be used during authentication to authorize access to a user's details. Each scope returns a set of user attributes. The scope must match the names in your identity provider.
102
+
4. Add the OIDC scope to be used during authentication to authorize access to a user's details. Each scope returns a set of user attributes. The scope must match the names in your identity provider.
75
103
5. In the `User attributes` field enter the attribute and the value in the identity provider. (optional)
76
104
6.When complete, press `Save`.
77
105
106
+
=== "OpenShift V4"
107
+
108
+
1. In the `Discovery URL` field, enter the discovery URL .
109
+
2. In the `Client ID` field, enter the client ID.
110
+
3. In the `Client Secret` field, enter the client secret.
111
+
4. Add the OIDC scope to be used during authentication to authorize access to a user's details. Each scope returns a set of user attributes. The scope must match the names in your identity provider.
112
+
5. In the `User attributes` field enter the attribute and the value in the identity provider. (optional)
113
+
6. When complete, press `Save`.
114
+
78
115
4. In the `Logout uri` field, enter the desired URL logout page. If left empty, you will be redirected to the Run:ai portal.
79
116
5. In the `Session timeout` field, enter the amount of idle time before users are automatically logged out. (Default is 60 minutes)
0 commit comments