Skip to content

Commit dfc7101

Browse files
committed
fix: typos
1 parent 6032537 commit dfc7101

File tree

4 files changed

+31
-32
lines changed

4 files changed

+31
-32
lines changed

src/content/docs/authenticate/auth-guides/pass-params-idp.mdx

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ relatedArticles:
1212
You can pass provider-specific parameters to an Identity Provider (IdP) during authentication. These are also known as 'upstream params'. The values your pass can either be static per connection or dynamic per user.
1313

1414
There's a number of reason why you might want to use upstream params:
15+
1516
- to create a smoother sign in experience - by passing the email through
1617
- to offer an account switcher (such as the Google account switcher) during sign in
1718

18-
Upstream params are available for OAuth 2.0 connections, e.g. [social connections](/authenticate/social-sign-in/add-social-sign-in/), [Entra ID OAuth 2.0 enterprise connection](/authenticate/enterprise-connections/azure/), and as part of [advanced configurations](/authenticate/enterprise-connections/advanced-saml-configurations/) in SAML connections.
19+
Upstream params are available for OAuth 2.0 connections, e.g. [social connections](/authenticate/social-sign-in/add-social-sign-in/), [Entra ID OAuth 2.0 enterprise connection](/authenticate/enterprise-connections/azure/), and as part of [advanced configurations](/authenticate/enterprise-connections/advanced-saml-configurations/) in SAML connections.
1920

2021
## Limitations
2122

@@ -31,28 +32,26 @@ The Upstream parameter field accepts JSON and the structure is as follows:
3132

3233
```json
3334
{
34-
"<param_name_to_pass>": {
35+
"<param_name_to_pass>": {
3536
"value": "<your_hardcoded_value>"
3637
}
3738
}
38-
3939
```
4040

4141
Replace `<param_name_to_pass>` with the name of the parameter you wish to pass upstream to the IDP.
4242
Replace `<your_hardcoded_value>` with the value of the parameter you wish to pass upstream.
4343

4444
### Example: Force the google account selector to display on sign in
4545

46-
If you want Google to always show the account selector even if the user is already logged in with a Google account, pass the `prompt=select_account` parameter from Kinde.
46+
If you want Google to always show the account selector even if the user is already logged in with a Google account, pass the `prompt=select_account` parameter from Kinde.
4747
This is how that would look:
4848

4949
```json
5050
{
51-
"prompt": {
51+
"prompt": {
5252
"value": "select_account"
5353
}
5454
}
55-
5655
```
5756

5857
Now, when your user clicks on the Google button and Kinde creates the URL to redirect to Google, it will append`&prompt=select_account`.
@@ -65,34 +64,34 @@ This is the structure.
6564

6665
```json
6766
{
68-
"<param_name_to_pass>": {
67+
"<param_name_to_pass>": {
6968
"alias": "<dynamic_param_name>"
7069
}
7170
}
72-
7371
```
7472

7573
The `alias` keyword tells Kinde which parameter from your auth url to use, and the value to pass upstream to the IDP.
7674

7775
Here is an example where we provide `login_hint` as part of the auth URL, where the email [`&[email protected]`](mailto:&[email protected]) is included on the URL.
7876

7977
```html
80-
https://<your_kinde_sudomain>.kinde.com/oauth2/auth
81-
?response_type=code
82-
&client_id=<your_kinde_client_id>
83-
&redirect_uri=<your_app_redirect_url>
84-
&scope=openid%20profile%20email
85-
&state=abc
86-
78+
https://<your_kinde_subdomain
79+
>.kinde.com/oauth2/auth ?response_type=code &client_id=<your_kinde_client_id>
80+
&redirect_uri=<your_app_redirect_url>
81+
&scope=openid%20profile%20email &state=abc
82+
&[email protected]</your_app_redirect_url
83+
></your_kinde_client_id
84+
></your_kinde_subdomain
85+
>
8786
```
8887

8988
In this case both Kinde and the IDP use the parameter name `login_hint` so the configuration is the same on both sides:
9089
Add this to the connection configuration:
9190

92-
}
91+
}
9392
}
9493

95-
```
94+
````
9695
9796
In this case we are saying pass the `login_hint` parameter upstream to the IDP with the value Kinde received in the `login_hint` auth url param. So `&[email protected]` would be passed on to the provider.
9897
@@ -104,7 +103,7 @@ Where the `alias` becomes especially powerful is when you want to re-map a param
104103
"alias": "login_hint"
105104
}
106105
}
107-
```
106+
````
108107

109108
In this case we are saying pass the `username` parameter upstream to the IDP with the value Kinde received in the `login_hint` auth url param. We remap the email value from `login_hint` to `username` and the parameter `&[email protected]` would be passed on to the IDP.
110109

@@ -118,9 +117,9 @@ If the user enters `[email protected]` in the Kinde email field with the followi
118117

119118
```json
120119
{
121-
"login_hint": {
122-
"alias": "login_hint"
123-
}
120+
"login_hint": {
121+
"alias": "login_hint"
122+
}
124123
}
125124
```
126125

@@ -130,14 +129,13 @@ You can send multple parameters this way and mix-and-match between dynamic and s
130129

131130
```json
132131
{
133-
"prompt": {
134-
"value": "login"
135-
},
136-
"username": {
137-
"alias": "login_hint"
138-
}
132+
"prompt": {
133+
"value": "login"
134+
},
135+
"username": {
136+
"alias": "login_hint"
137+
}
139138
}
140-
141139
```
142140

143141
This would result in `&prompt=login&[email protected]`

src/content/docs/authenticate/custom-configurations/redirect-users.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Because it is just a string, you can leverage it to store additional information
6464
3. When you redirect your user to Kinde to complete the authentication flow, include the random string as the `state` param:
6565

6666
```jsx
67-
https://<your_kinde_sudomain>.kinde.com/oauth2/auth
67+
https://<your_kinde_subdomain>.kinde.com/oauth2/auth
6868
?response_type=code
6969
&client_id=<your_kinde_client_id>
7070
&redirect_uri=<your_app_redirect_url>

src/content/docs/developer-tools/about/using-kinde-without-an-sdk.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ You will need to use this redirect URL in the following step.
4646
Your users must be redirected from your product to Kinde to sign up or sign in securely. The redirect URL on your product side would look like the following:
4747

4848
```markdown
49-
https://<your_kinde_sudomain>.kinde.com/oauth2/auth
49+
https://<your_kinde_subdomain>.kinde.com/oauth2/auth
5050
?response_type=code
5151
&client_id=<your_kinde_client_id>
5252
&redirect_uri=<your_app_redirect_url>
@@ -61,6 +61,7 @@ Kinde supports all the standard OAuth 2 request parameters as well as a few addi
6161
Kinde also supports the PKCE extension, in which case the `code_challenge` and `code_challenge_method` parameters are also required. This is recommended for mobile apps and single page applications (SPAs).
6262

6363
## Handling successful auth for desktop and mobile apps
64+
6465
If you offer mobile and desktop apps, as well as access through a browser, you'll need to handle the post-authentication browser state. Rather than leaving a hanging screen, you can show users a success page. To do this, add the `is_use_auth_success_page` parameter to the authorization URL. See the [Request prameters](/developer-tools/about/using-kinde-without-an-sdk/#request-parameters) section below.
6566

6667
## Handling the callback
@@ -84,7 +85,7 @@ client_id=<your_kinde_client_id>
8485
&client_secret=<your_kinde_client_secret>
8586
&grant_type=authorization_code
8687
&redirect_uri=<your_app_redirect_url>
87-
&code=<CALLBACK_AUTHORIZATION_CODE>
88+
&code=<CALLBACK_AUTHORIZATION_CODE>
8889
```
8990

9091
Make sure you replace the `<values>` with your own credentials.

src/content/docs/workflows/testing/preview-workflows.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The deployment ID is used to identify the workflow deployment you want to test.
3535
This should be passed as part of the authorization URL:
3636

3737
```
38-
https://<your_kinde_sudomain>.kinde.com/oauth2/auth
38+
https://<your_kinde_subdomain>.kinde.com/oauth2/auth
3939
?response_type=code
4040
&client_id=<your_kinde_client_id>
4141
&redirect_uri=<your_app_redirect_url>

0 commit comments

Comments
 (0)