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
# Discover OpenID Connect endpoints of {{ product_name }}
1
+
# Discover OpenID Connect endpoints and configurations
2
2
3
-
When you build OpenID Connect login in your application using {{product_name}} as your identity provider, you need to get the OpenID Connect endpoints and configurations from {{ product_name }}.
3
+
When building OpenID Connect (OIDC) login in your application using {{product_name}} as your identity provider, your application needs the relevant OIDC endpoints and configurations. Your application can get these endpoints in **two main steps**:
4
4
5
-
You can do this by invoking the discovery endpoint API or by using the {{ product_name }} Console as explained below.
5
+
1.**Discover the issuer (Optional)**:
6
6
7
-
## Prerequisite
7
+
When the issuer URL of the OpenID Provider is not known in advance, your application can dynamically discover it using the **WebFinger** endpoint.
8
+
9
+
2.**Retrieve the OpenID Connect metadata from the issuer**:
10
+
11
+
Once your application discovers the issuer URL (either via WebFinger or because it’s already configured), your application can fetch the OpenID Connect metadata. This includes all the necessary endpoints (authorization, token, introspection, revocation, logout, etc.), supported scopes, response types, claims, and client authentication methods.
12
+
13
+
For clients or SDKs that cannot dynamically fetch these endpoints, you can get them manually from the {{product_name}} Console.
14
+
15
+
This guide explains how to discover the OpenID Connect endpoints of {{ product_name }} using both the API and the Console.
16
+
17
+
## Prerequisites
8
18
9
19
To get started, you need to have an application registered in {{ product_name }}:
10
20
11
21
- Register a [single-page app with OIDC]({{base_path}}/guides/applications/register-single-page-app/).
12
22
- Register a [web app with OIDC]({{base_path}}/guides/applications/register-oidc-web-app/).
13
23
14
-
## Use the discovery endpoint
24
+
## Use the API
15
25
16
-
OpenID Connect Discovery <!-- [OpenID Connect Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html)--> allows you to discover the metadata such as endpoints, scopes, response types, claims, and supported client authentication methods of identity providers such as {{ product_name }}.
26
+
This section explains how your application can dynamically discover the OpenID Connect endpoints.
17
27
18
-
Applications can dynamically discover the OpenID Connect identity provider metadata by calling the OpenID Connect discovery <!-- [OpenID Connect discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationRequest)--> endpoint. The structure of the request URL is as follows: `<issuer>/.well-known/openid-configuration`.
28
+
### Step 1: Discover the issuer
29
+
30
+
OpenID Provider issuer discovery, process allows a client application to automatically find the location (issuer URL) of the OpenID Provider.
31
+
32
+
You can use the following endpoint to retrieve the issuer information.
[OpenID Connect Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) allows you to discover the metadata such as endpoints, scopes, response types, claims, and supported client authentication methods of identity providers such as {{ product_name }}.
136
+
137
+
Applications can dynamically discover the OpenID Connect identity provider metadata by calling the OpenID Connect discovery <!-- [OpenID Connect discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationRequest)--> endpoint. The structure of the request URL is as follows: `<issuer>/.well-known/openid-configuration`.
@@ -83,15 +205,13 @@ Applications can dynamically discover the OpenID Connect identity provider metad
83
205
}
84
206
```
85
207
86
-
## Get endpoints from the console
87
-
88
-
Some applications and SDKs are not capable of dynamically resolving endpoints from OpenID Connect discovery. For such applications, you need to configure endpoints manually.
208
+
## Use the Console
89
209
90
-
You can get the endpointsfrom the console as follows:
210
+
For applications and SDKs that can't dynamically resolve OpenID Connect endpoints, you can manually copy the relevant information from the Console. To do so,
91
211
92
212
1. On the {{ product_name }}, go to **Applications**.
93
213
94
-
2. Select an OIDC application from the list.
214
+
2. Select your OIDC application from the list.
95
215
96
216
3. Go to the **Info** tab of the application and find the server endpoints to your organization.
0 commit comments