Generic OIDC

import { Tabs, TabItem, Render, APIRequest } from "~/components";

Cloudflare Access has a generic OpenID Connect (OIDC) connector to help you integrate IdPs not already set in Access.

1. Create an application in your identity provider

1. Visit your identity provider and create a client/app.

2. When creating a client/app, your IdP may request an authorized redirect URI. Enter the following URL:

   https://<your-team-name>.cloudflareaccess.com/cdn-cgi/access/callback
   

3. Copy the content of these fields:

   • Client ID
   • Client secret
   • Auth URL: The authorization_endpoint URL of your IdP
   • Token URL: The token_endpoint URL of your IdP
   • Certificate URL: The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens

   You can find these values on your identity provider's OIDC discovery endpoint. Some providers call this the "well-known URL".

2. Add an OIDC provider to Cloudflare One

1. In the Cloudflare dashboard, go to Zero Trust > Integrations > Identity providers.

2. Under Your identity providers, select Add new identity provider.

3. Choose OpenID Connect.

4. Name your identity provider and fill in the required fields with the information obtained from your identity provider.

5. (Optional) Enable Proof of Key Exchange (PKCE) if the protocol is supported by your IdP. PKCE will be performed on all login attempts.

6. (Optional) To enable SCIM, refer to Synchronize users and groups.

7. (Optional) Under Optional configurations, enter custom OIDC claims that you wish to add to users' identity. This information will be available in the user identity endpoint.

8. Select Save.

Make a POST request to the Identity Providers endpoint:

<APIRequest path="/accounts/{account_id}/access/identity_providers" method="POST" json={{ name: "Generic OIDC example", type: "oidc", config: { client_id: "", client_secret: "", auth_url: "https://accounts.google.com/o/oauth2/auth", token_url: "https://accounts.google.com/o/oauth2/token", certs_url: "https://www.googleapis.com/oauth2/v3/certs", pkce_enabled: false, email_claim_name: "email", claims: ["employeeID", "groups"], scopes: ["openid", "email", "profile"], }, }} />

1. Add the following permission to your cloudflare_api_token:

   • Access: Organizations, Identity Providers, and Groups Write

2. Configure the cloudflare_zero_trust_access_identity_provider resource:

   	```tf
   	resource "cloudflare_zero_trust_access_identity_provider" "generic_oidc_example" {
   		account_id = var.cloudflare_account_id
   		name       = "Generic OIDC example"
   		type       = "oidc"
   		config 		 = {
   			client_id = "<your client id>"
   			client_secret = "<your client secret>"
   			auth_url = "https://accounts.google.com/o/oauth2/auth"
   			token_url = "https://accounts.google.com/o/oauth2/token"
   			certs_url = "https://www.googleapis.com/oauth2/v3/certs"
   			pkce_enabled = false
   			email_claim_name = "email"
   			claims = ["employeeID", "groups"]
   			scopes = ["openid", "email", "profile"]
   		}
   	}
   	```
   

3. Test the connection

To test that your connection is working, go to Authentication > Login methods and select Test next to the login method you want to test. On success, a confirmation screen displays.

Synchronize users and groups

The generic OIDC integration allows you to synchronize user groups and automatically deprovision users using SCIM.

Prerequisites

Your identity provider must support SCIM version 2.0.

1. Enable SCIM in Cloudflare One

<Render file="access/enable-scim-on-dashboard" product="cloudflare-one" params={{ idp: "IdP" }} />

2. Configure SCIM in the IdP

Setup instructions vary depending on the identity provider. In your identity provider, you will either need to edit the original SSO application or create a new SCIM application. Refer to your identity provider's documentation for more details. For example instructions, refer to our Okta or Jumpcloud guides.

IdP groups

If you would like to build policies based on IdP groups:

• Ensure that your IdP sends a groups field. The naming must match exactly (case insensitive). All other values will be sent as a OIDC claim.
• If your IdP requires a new SCIM application, ensure that its groups match the groups in the original SSO application. Matching the groups keeps the Gateway identity synchronized with the groups that the IdP returns when the user authenticates to Access.

3. Verify SCIM provisioning

Optional configurations

Custom OIDC claims

All OIDC IdP integrations support the use of custom OIDC claims. Once configured, Access will add the claims to the Access JWT for consumption by your origin services. You can reference the custom OIDC claims in Access policies and Gateway policies, offering a means to control user access to applications based on custom identity attributes.

To add a custom OIDC claim to an IdP integration:

1. In your identity provider, ensure that the custom claim is included in your OIDC ID token.

2. In the Cloudflare dashboard, go to Zero Trust > Integrations > Identity providers.

3. Under Your identity providers, find your identity provider and select Edit.

4. Under OIDC Claims, enter the name of your custom claim (for example, oid).

5. Select Save.

6. Select Test and verify that the custom claim appears in oidc_fields. For example,

   ```json
   	"oidc_fields": {
   		"oid": "54eb1ed2-7150-44e6-bbe4-ead24c132fd4"
   	},
   ```
   

You can now build an Access policy for the custom claim using the OIDC Claim or IdP OIDC Claim selector. You can also use custom OIDC claims as identity-based selectors in Gateway policies. The custom claim will be passed to origins behind Access in a JWT.

Email claim

You can specify a custom Email claim name that Access will use to identify user emails. This is useful if your IdP does not return the standard email claim in the OIDC ID token.

Multi-record OIDC claims

Cloudflare Access extends support for multi-record OIDC claims. These claims are parsed out and can be individually referenced in policies. This feature enables granular access control and precise user authorization in applications.

Cloudflare Access does not support partial OIDC claim value references or OIDC scopes.

Supported algorithms for generic OIDC tokens

Cloudflare supports the following algorithms for verifying generic OIDC tokens:

• RS512
• RS256
• PS512
• ES256
• ES384
• ES512