rancher-docs/versioned_docs/version-2.13/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-generic-oidc.md at 8c8f8a5f2edec3d7f5abc321e7ca42e681919fdb

public/rancher-docs

Fork 0

mirror of https://github.com/rancher/rancher-docs.git synced 2026-05-05 04:33:18 +00:00

Files

T

Lucas Saintarbor 2386faad52 Move Configuring OIDC Single Logout (SLO) section on relevant pages (#2233 )

2026-03-16 11:37:28 -07:00

8.2 KiB

Raw Blame History

title, description

title	description
Configure Generic OIDC	Create an OpenID Connect (OIDC) client and configure Rancher to work with your authentication provider. Your users can then sign into Rancher using their login from the authentication provider.

Generic OpenID Connect (OIDC) allows users to sign in to Rancher using their credentials from their existing account at an OIDC Identity Provider (IdP). Rancher supports integration with the OIDC protocol and the SAML protocol. Both implementations are functionally equivalent when used with Rancher. The following instructions describe how to create an OIDC client and configure Rancher to work with your authentication provider. Users can then sign into Rancher using their login from the OIDC IdP.

Prerequisites

Identity Provider

In Rancher, Generic OIDC is disabled.

:::note

Consult the documentation for your specific IdP to complete the listed prerequisites.

:::

OIDC Client

In your IdP, create a new client with the settings below:

Setting	Value
`Client ID`	<CLIENT_ID> (e.g. `rancher`)
`Name`	<CLIENT_NAME> (e.g. `rancher`)
`Client Protocol`	`openid-connect`
`Access Type`	`confidential`
`Valid Redirect URI`	`https://yourRancherHostURL/verify-auth`

In the new OIDC client, create mappers to expose the user's fields.

:::note

The groups and full_group_path claims generated by the Groups and Group Path mappers, which you create within the OIDC client in your Identity Provider, should be JSON arrays, e.g. "groups":["admins","devs","qa"] and "full_group_path":["/admins","/devs","/qa"].

:::

Create a new Groups Mapper with the settings below:

Setting | Value
------------|------------
`Name` | `Groups Mapper`
`Mapper Type` | `Group Membership`
`Token Claim Name` | `groups`
`Add to ID token` | `OFF`
`Add to access token` | `OFF`
`Add to user info` | `ON`

Create a new Client Audience with the settings below:

Setting | Value
------------|------------
`Name` | `Client Audience`
`Mapper Type` | `Audience`
`Included Client Audience` | `CLIENT_NAME`
`Add to access token` | `ON`

Create a new Groups Path with the settings below.

Setting | Value
------------|------------
`Name` | `Group Path`
`Mapper Type` | `Group Membership`
`Token Claim Name` | `full_group_path`
`Full group path` | `ON`
`Add to user info` | `ON`

:::warning

Rancher uses the value received in the "sub" claim to form the PrincipalID which is the unique identifier in Rancher. It is important to make this a value that is unique and immutable.

:::

Configuring Generic OIDC in Rancher

In the upper left corner of the Rancher UI, click ☰ > Users & Authentication.
In the left navigation bar, click Auth Provider.
Select Generic OIDC.
Complete the Configure an OIDC account form. For help with filling the form, see the configuration reference.
Click Enable.

Rancher will redirect you to the IdP login page. Enter your IdP credentials to validate your Rancher Keycloak configuration.

:::note

You may need to disable your popup blocker to see the IdP login page.

:::

Result: Rancher is configured to work with your provider using the OIDC protocol. Your users can now sign into Rancher using their IdP logins.

Custom Claim Mapping

Custom claim mapping within the Generic OIDC configuration is supported for name, email and groups claims. This allows you to manually map these OIDC claims when your IdP doesn't use standard names in tokens.

How a Custom Groups Claim Works

A custom groups claim influences how user groups work:

If both the standard OIDC groups claim and the custom groups claim are present in the user's token, the custom claim supplements the list of groups provided by the standard claim.
If there is no standard groups claim in the token, the groups listed in the custom claim will form the user's only groups.

:::note There is no search functionality available for groups sourced from a custom claim. To assign a role to one of these groups, you must manually enter the group's exact name into the RBAC field. :::

Configuring Custom Claims

When on the Configure an OIDC account form:

Select Add custom claims.
Add your custom name, email or groups claims to the appropriate Custom Claims field.

For example, if your IdP sends groups in a claim called custom_roles, enter custom_roles into the Custom Groups Claim field. Rancher then supplements the standard OIDC groups claim or looks for that specific claim when processing the user's token.

Configuration Reference

Field	Description
Client ID	The Client ID of your OIDC client.
Client Secret	The generated Secret of your OIDC client.
Private Key/Certificate	A key/certificate pair to create a secure shell between Rancher and your IdP. Required if HTTPS/SSL is enabled on your OIDC server.
Endpoints	Choose whether to use the generated values for the Rancher URL, Issue, and Auth Endpoint fields or to provide manual overrides if incorrect.
Rancher URL	The URL for your Rancher Server.
Issuer	The URL of your IdP. If your provider has discovery enabled, Rancher uses the Issuer URL to fetch all of the required URLs.
Auth Endpoint	The URL where users are redirected to authenticate.

Custom Claims

Custom Claim Field	Default OIDC Claim	Custom Claim Description
Custom Name Claim	`name`	The name of the claim in the OIDC token that contains the user's full name or display name.
Custom Email Claim	`email`	The name of the claim in the OIDC token that contains the user's email address.
Custom Groups Claim	`groups`	The name of the claim in the OIDC token that contains the user's group memberships (used for RBAC).

Configuring OIDC Single Logout (SLO)

Troubleshooting

If you are experiencing issues while testing the connection to the OIDC server, first double-check the configuration options of your OIDC client. You can also inspect the Rancher logs to help pinpoint what's causing issues. Debug logs may contain more detailed information about the error. Please refer to How can I enable debug logging in this documentation.

All Generic OIDC related log entries are prepended with either [generic oidc] or [oidc].

You are not redirected to your authentication provider

If you fill out the Configure a Generic OIDC account form and click on Enable, and you are not redirected to your IdP, verify your OIDC client configuration.

The generated `Issuer` and `Auth Endpoint` are incorrect

If the Issuer and Auth Endpoint are generated incorrectly, open the Configure an OIDC account form, change Endpoints to Specify (advanced) and override the Issuer value.

Error: "Invalid grant_type"

In some cases, the "Invalid grant_type" error message may be misleading and is actually caused by setting the Valid Redirect URI incorrectly.

8.2 KiB Raw Blame History