Skip to main content

Identity Brokering

DescriptionLearn about identity brokering/federation and how to add an external identity provider to authenticate your users.
Learning OutcomesIn this module you will:
  • Learn about Identity Providers
  • Add a new identity provider
  • Example with Google Login
Prerequisites

What is Identity Brokering and Federated Identities?#

Federated identity management is an arrangement built upon the trust between two or more domains. Users of these domains are allowed to access applications and services using the same identity. This identity is known as federated identity and the pattern behind this as identity federation.

A service provider that specializes in brokering access control between multiple service providers (also referred to as relying parties) is called identity broker. Federated identity management is an arrangement that is made between two or more such identity brokers across organizations.

Example: If Google is configured as identity provider on your organization, the user will get the option to use his Google Account on the Login Screen of ZITADEL (1). ZITADEL will redirect the user to the login screen of Google where he as to authenticated himself (2) and is sent back after he has finished that (3). Because Google is registered as trusted identity provider the user will be able to login in with the Google account after he linked an existing ZITADEL Account or just registered a new one with the claims provided by Google (4)(5).

Identity Brokering

Exercise: Register an external identity provider#

In this exercise we will add a new Google identity provider to federate identities with ZITADEL.

1. Create new OIDC Client#

  1. Register an OIDC Client in your preferred provider
  2. Make sure you add the ZITADEL callback redirect uris https://accounts.zitadel.ch/register/externalidp/callbackhttps://accounts.zitadel.ch/login/externalidp/callback

Information: Make sure the provider is OIDC 1.0 compliant with a proper Discovery Endpoint

Google Example:

  1. Go to the Google Gloud Platform and choose youre project: https://console.cloud.google.com/apis/credentials
  2. Click on "+ CREATE CREDENTIALS" and choose "OAuth client ID"
  3. Choose Web application as Application type and give a name
  4. Add the redirect uris from above
  5. Save clientid and client secret

Add new oAuth credentials in Google Console

2. Add custom login policy on your organization#

  1. Go to your organization settings by clicking on "Organization" in the menu or using the following link: https://console.zitadel.ch/org
  2. Modify your login policy
  3. As long as you have the default policy, you can't change the policy. Click create custom policy to set your on settings.

Add custom login policy

3.Configure new identity provider#

  1. Go to the identity providers section and click new
  2. Fill out the form
    • Use the issuer, clientid and client secret provided by your provider
    • The scopes will be prefilled with openid, profile and email, because this information is relevant for ZITADEL
    • You can choose what fields you like to map as the display name and as username. The fields you can choose are preferred_username and email (Example: For Google you should choose email for both fields)
  3. Save your configuration
  4. Link your new configuration to your login policy. By searching in the organization category you will get you own configuration. If you choose system you can link all predefined providers.

Configure identity provider

Your user will now be able to choose Google for login instead of username/password or mfa.

Knowledge Check#

  • The issuer for your identity provider is https://issuer.zitadel.ch
    • yes
    • no
  • The identity provider has to be oAuth 2.0 compliant
    • yes
    • no
Solutions

Summary#

  • You can federate identities of all oAuth 2.0 compliant external identity providers
  • Configure the provider in your custom login policy

Where to go from here:

  • ZITADEL Projects
  • Service users