Skip to content

Commit

Permalink
Okta-566837 Capitalisation corrections for b words (#4033)
Browse files Browse the repository at this point in the history
* Misc spelling and capitalization corrections "b"
* Change base64 > Base64
   * base64 encoded > Base64-encoded
   * base64URL encoded > Base64URL-encoded
* Update Base URL > base URL, Base URI > base URI
* basic authentication > Basic Authentication
  • Loading branch information
danielmaharry-okta authored Mar 22, 2023
1 parent 4775157 commit a70e7da
Show file tree
Hide file tree
Showing 23 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion packages/@okta/vuepress-site/code/android/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This method works with both Okta Identity Engine and Okta Classic Engine.

SDK: [Okta Mobile SDK for Kotlin](https://github.com/okta/okta-mobile-kotlin).

Example: [Browser Sign In](https://github.com/okta/samples-android/tree/master/browser-sign-in).
Example: [Browser sign-in](https://github.com/okta/samples-android/tree/master/browser-sign-in).


### Use the embedded model
Expand Down
2 changes: 1 addition & 1 deletion packages/@okta/vuepress-site/code/ios/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This method works with both Okta Identity Engine and Okta Classic Engine.

SDK: [Okta Mobile SDK for Swift](https://github.com/okta/okta-mobile-swift).

Example: [Browser sign in](https://github.com/okta/samples-ios/tree/master/browser-sign-in).
Example: [Browser sign-in](https://github.com/okta/samples-ios/tree/master/browser-sign-in).


### Use the embedded model
Expand Down
2 changes: 1 addition & 1 deletion packages/@okta/vuepress-site/code/react-native/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ These SDKs help you integrate with Okta by redirecting to the Okta Sign-In Widge

* [okta-react-native on npm](https://www.npmjs.com/package/@okta/okta-react-native)
* [React Native SDK Source](https://github.com/okta/okta-react-native)
* [React Native redirect authentication sample app](https://github.com/okta/samples-js-react-native): See [Browser Sign In](https://github.com/okta/samples-js-react-native/tree/master/browser-sign-in) for a redirect configuration.
* [React Native redirect authentication sample app](https://github.com/okta/samples-js-react-native): See [Browser sign-in](https://github.com/okta/samples-js-react-native/tree/master/browser-sign-in) for a redirect configuration.

## Recommended guides

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ For information on how to set up your application to use this flow, see [Impleme

The SAML 2.0 Assertion flow is intended for a client app that wants to use an existing trust relationship without a direct user approval step at the authorization server. It enables a client application to obtain an authorization from a valid, signed SAML assertion from the SAML Identity Provider. The client app can then exchange it for an OAuth access token from the OAuth authorization server. For example, this flow is useful when you want to fetch data from APIs that only support delegated permissions without prompting the user for credentials.

To use a SAML 2.0 Assertion as an authorization grant, the client makes a SAML request to the Identity Provider and the Identity Provider sends the SAML 2.0 Assertion back in the response. The client then makes a request for an access token with the `urn:ietf:params:oauth:grant-type:saml2-bearer` grant type and includes the `assertion` parameter. The value of the `assertion` parameter is the SAML 2.0 assertion that is Base64 encoded. You can send only one SAML assertion in that request.
To use a SAML 2.0 Assertion as an authorization grant, the client makes a SAML request to the Identity Provider and the Identity Provider sends the SAML 2.0 Assertion back in the response. The client then makes a request for an access token with the `urn:ietf:params:oauth:grant-type:saml2-bearer` grant type and includes the `assertion` parameter. The value of the `assertion` parameter is the SAML 2.0 assertion that is Base64-encoded. You can send only one SAML assertion in that request.

<div class="full">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ When the user selects and submits Google Authenticator, call `OktaAuth.idx.proce

### 4: Display shared secret and QR Code

Next, display the shared secret to the user so they can copy the value to the Google Authenticator app. The response from `OktaAuth.idx.proceed()` allows you to display a string and QR code that contains the shared secret. `IdxTransaction` is returned with `authenticator.contextualData.sharedsecret` set to a string of the secret and `authenticator.contextualData.qrcode.href` stores the secret in a base64-encoded PNG image. See the following `IdxTransaction` example.
Next, display the shared secret to the user so they can copy the value to the Google Authenticator app. The response from `OktaAuth.idx.proceed()` allows you to display a string and QR code that contains the shared secret. `IdxTransaction` is returned with `authenticator.contextualData.sharedsecret` set to a string of the secret and `authenticator.contextualData.qrcode.href` stores the secret in a Base64-encoded PNG image. See the following `IdxTransaction` example.

``` json
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ case AWAITING_AUTHENTICATOR_ENROLLMENT_SELECTION:

#### 3: Display QR code and start polling

When the user selects to enroll the Okta Verify `Authenticator` the form posts back to the `idxAuthenticationWrapper.selectAuthenticator()` method. This will trigger an `AWAITING_POLL_ENROLLMENT` state. The state's `ContextualData` object contains a base64 encoded QR code image for display to the user.
When the user selects to enroll the Okta Verify `Authenticator` the form posts back to the `idxAuthenticationWrapper.selectAuthenticator()` method. This will trigger an `AWAITING_POLL_ENROLLMENT` state. The state's `ContextualData` object contains a Base64-encoded QR code image for display to the user.

```java
case AWAITING_POLL_ENROLLMENT:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The following table describes the most important `IdxTransaction` properties for
|----------------|---------------------------------------------------|---------------------------------------------------|
| `IdxTransaction.status` | `PENDING` | Status of transaction. A value of `PENDING` indicates that Okta is waiting for the user to complete the Okta Verify setup.|
| `IdxTransaction.nextStep.name` | `enroll-poll` | Name of the next step in the sign-in flow. A value of `enroll-poll` indicates that the app should show the QR Code and poll Okta to determine when the user completes the Okta Verify setup. |
| `IdxTransaction.nextStep.authenticator.contextualData.qrcode.href` | "data:image/png;base64,..." | The QR code base64 encoded PNG image.
| `IdxTransaction.nextStep.authenticator.contextualData.qrcode.href` | "data:image/png;base64,..." | The QR code Base64-encoded PNG image.

A `IdxTransaction.status` value of `PENDING` and `IdxTransaction.nextStep.name` value of `enroll-poll` signifies that Okta is waiting for the user to add their account to Okta Verify. At this time, your app should start polling to determine when the user completes the Okta Verify account setup.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Start with a new Node.js project built on the Express framework or a Node.js SQL

The Glitch project templates don't have any body-parsing code. To include this content:

* Add the Body Parser `npm` package to your Glitch project
* Add the body-parser `npm` package to your Glitch project
* Add the code snippet below

If you remix a Glitch inline hook project, the packages and code are already included.
Expand All @@ -63,7 +63,7 @@ To add the `npm` packages:
## Add authentication method

Okta inline hooks can use header authentication as well as OAuth 2.0 authentication to secure the calls from Okta to your external service. The inline hook Glitch projects use basic authentication. See the following sections to implement basic authentication or to use the OAuth 2.0 client secret or the private key method.
Okta inline hooks can use header authentication as well as OAuth 2.0 authentication to secure the calls from Okta to your external service. The inline hook Glitch projects use Basic Authentication. See the following sections to implement Basic Authentication or to use the OAuth 2.0 client secret or the private key method.

### HTTP header: Basic Authentication

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```javascript

// Body Parsing
// Body parsing
const bodyParser = require('body-parser');
app.use(bodyParser.json());
Original file line number Diff line number Diff line change
Expand Up @@ -391,11 +391,11 @@ See the following:
* Android:
* [Sign users in to your Android mobile app using the redirect model](/docs/guides/sign-into-mobile-app-redirect/android/main/)
* [Browser Sign In](https://github.com/okta/samples-android/tree/master/browser-sign-in)
* [Browser sign-in](https://github.com/okta/samples-android/tree/master/browser-sign-in)
* [Okta Mobile SDK for Kotlin](https://github.com/okta/okta-mobile-kotlin)
* iOS:
* [Sign users in to your iOS mobile app using the redirect model](/docs/guides/sign-into-mobile-app-redirect/ios/main/)
* [Browser Sign In](https://github.com/okta/samples-ios/tree/master/browser-sign-in)
* [Browser sign-in](https://github.com/okta/samples-ios/tree/master/browser-sign-in)
* [Okta Mobile SDK for Swift](https://github.com/okta/okta-mobile-swift)
You can also develop your mobile app with frameworks like Ionic and Flutter. We currently don't have native SDKs for either, but they should work with an AppAuth library. We recommend [Ionic AppAuth](https://github.com/wi3land/ionic-appauth) and the [Flutter AppAuth Plugin](https://pub.dev/packages/flutter_appauth).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ The following native and single-page application examples show the Authorization

| | Environment | Example Repository |
| :------------------------------------: | ----------- | -------------------------------------------------- |
| <i class="icon code-android-32"></i> | Android | [Browser Sign In Example](https://github.com/okta/samples-android/tree/master/browser-sign-in) |
| <i class="icon code-ios-32"></i> | iOS | [Okta iOS Browser Sign In Example](https://github.com/okta/samples-ios/tree/master/browser-sign-in) |
| <i class="icon code-react-32"></i> | React Native | [Okta React Native + Browser Sign In Example](https://github.com/okta/samples-js-react-native/tree/master/browser-sign-in) |
| <i class="icon code-android-32"></i> | Android | [Browser Sign-In Example](https://github.com/okta/samples-android/tree/master/browser-sign-in) |
| <i class="icon code-ios-32"></i> | iOS | [Okta iOS Browser Sign-In Example](https://github.com/okta/samples-ios/tree/master/browser-sign-in) |
| <i class="icon code-react-32"></i> | React Native | [Okta React Native + Browser Sign-In Example](https://github.com/okta/samples-js-react-native/tree/master/browser-sign-in) |
| <i class="icon code-angular-32"></i> | Angular | [Okta Angular + Okta Hosted Login Example](https://github.com/okta/samples-js-angular/tree/master/okta-hosted-login) |
| <i class="icon code-dotnet-32"></i> | Blazor WebAssembly | [Blazor WebAssembly & Okta-Hosted Sign-In Page Example](https://github.com/okta/samples-blazor/tree/master/web-assembly/okta-hosted-login) |
| <i class="icon code-react-32"></i> | React | [Okta React + Okta Hosted Login Example](https://github.com/okta/samples-js-react/tree/master/okta-hosted-login) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Similar to the standard [Authorization Code flow](/docs/guides/implement-grant-t
Your first step is to generate a code verifier and challenge:

* Code verifier: Random URL-safe string with a minimum length of 43 characters
* Code challenge: Base64 URL-encoded SHA-256 hash of the code verifier
* Code challenge: Base64URL-encoded SHA-256 hash of the code verifier

You need to add code in your native app to create the code verifier and code challenge.

Expand All @@ -20,7 +20,7 @@ The PKCE generator code creates output like this:
}
```

The `code_challenge` is a Base64 URL-encoded SHA256 hash of the `code_verifier`. Your app saves the `code_verifier` for later, and sends the `code_challenge` along with the authorization request to your authorization server's `/authorize` URL.
The `code_challenge` is a Base64URL-encoded SHA256 hash of the `code_verifier`. Your app saves the `code_verifier` for later, and sends the `code_challenge` along with the authorization request to your authorization server's `/authorize` URL.

### Request an authorization code

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you are not using existing libraries, you can make a direct request to Okta's

The Client Credentials flow is intended for server-side (confidential) client applications with no end user, which normally describes machine-to-machine communication. Your client application needs to have its client ID and secret stored in a secure manner. You can find the client ID and secret on the **General** tab for your app integration.

Base64 encode the client ID and secret (as shown later) and then pass through [Basic Authentication](https://tools.ietf.org/html/rfc7617) in the request to your [custom authorization server's](/docs/concepts/auth-servers/#custom-authorization-server) `/token` endpoint:
Base64-encode the client ID and secret (as shown later) and then pass through [Basic Authentication](https://tools.ietf.org/html/rfc7617) in the request to your [custom authorization server's](/docs/concepts/auth-servers/#custom-authorization-server) `/token` endpoint:

```bash
curl --request POST \
Expand Down Expand Up @@ -38,7 +38,7 @@ If the credentials are valid, the application receives an access token:

### Base64-encode the client ID and client secret

Use this section to Base64 encode the client ID and secret. When you finish encoding, you can then use the encoded client ID and secret in the HTTP Authorization header in the following format: `'authorization: Basic <Base64 encoded client ID and secret>'`
Use this section to Base64-encode the client ID and secret. When you finish encoding, you can then use the encoded client ID and secret in the HTTP Authorization header in the following format: `'authorization: Basic <Base64-encoded client ID and secret>'`

**If you are using macOS or Linux**:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Just like with the regular Authorization Code flow, your app starts by redirecti
Your first step is to generate a code verifier and challenge:

* Code verifier: Random URL-safe string with a minimum length of 43 characters
* Code challenge: Base64 URL-encoded SHA-256 hash of the code verifier
* Code challenge: Base64URL-encoded SHA-256 hash of the code verifier

You need to add code in your SPA app to create the code verifier and code challenge.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ASP.NET-specific resources:
* [Okta Xamarin SDK](https://github.com/okta/okta-oidc-xamarin)
* [Okta .NET Management SDK](https://github.com/okta/okta-sdk-dotnet)
* [Okta ASP.NET OIDC Middleware](https://github.com/okta/okta-aspnet)
* [Blazor SDK resources](/code/dotnet/blazor/)
* [Blazor resources](/code/dotnet/blazor/)
* [ASP.NET Framework SDK resources](/code/dotnet/aspnet/)
* [ASP.NET Core SDK resources](/code/dotnet/aspnetcore/)
* [Create a Web API with ASP.NET Core](https://docs.microsoft.com/en-us/aspnet/core/tutorials/first-web-api?view=aspnetcore-3.1&tabs=visual-studio)
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,17 @@ where the `${appName}` is a unique identifier provided to you after your integra

### Base URL

You can choose any Base URL for your API endpoint. Note that a Base URL can't contain the underscore `_` character.
You can choose any base URL for your API endpoint. Note that a base URL can't contain the underscore `_` character.

If you are implementing a new SCIM API, we suggest using `/scim/v2/` as your Base URL. For example: `https://example.com/scim/v2/`.
If you are implementing a new SCIM API, we suggest using `/scim/v2/` as your base URL. For example: `https://example.com/scim/v2/`.

If you have multiple Okta orgs using your service, you can use the same SCIM server for all of them. To do so, one way is to implement a 1:1 client to tenant subdomain for each org running on the SCIM server. For example, if you have three Okta orgs:

- company-a.okta.com
- company-b.okta.com
- company-c.okta.com

You can pass a Base URL containing the name of the org:
You can pass a base URL containing the name of the org:

- `https://company-a.example.com/scim/v2`
- `https://company-b.example.com/scim/v2`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ To configure and run the SCIM CRUD tests:
* Click **Tokens** and **Create Token**.
* Give the token a name click **Create Token**.
* Copy the resulting token value over to this Runscope variable.
* `SCIMUrl` - the Base URL of the SCIM implementation on your server. For example: `https://example.com/scim/v2`
* `SCIMUrl` - the base URL of the SCIM implementation on your server. For example: `https://example.com/scim/v2`
* `SCIMAuth` - the Basic or OAuth authorization token used to access your SCIM API.

The final Runscope values should look similar to the following:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ In token exchange use cases, an API microservice can act both as a resource serv
1. In the **General Settings** section of the **General** tab, click **Edit** and select **Token Exchange** as the grant type for your application.
1. Click **Save**.
1. Copy the client ID in the **Client Credentials** section, and then copy the client secret in the **CLIENT SECRETS** section.
1. [Base64 encode](/docs/guides/implement-grant-type/clientcreds/main/#base64-encode-the-client-id-and-client-secret) the client ID and client secret for use in the token exchange request from API1 to API2.
1. [Base64-encode](/docs/guides/implement-grant-type/clientcreds/main/#base64-encode-the-client-id-and-client-secret) the client ID and client secret for use in the token exchange request from API1 to API2.

### Update the authorization servers

Expand Down Expand Up @@ -188,7 +188,7 @@ Use the following example to build the request to exchange the authorization cod
curl --location --request POST \
--url 'https://${yourOktaDomain}/oauth2/default/v1/token' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {Base64 encoded service app client ID and client secret}' \
--header 'Authorization: Basic {Base64-encoded service app client ID and client secret}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=urn:ietf:params:oauth:grant-type:token-exchange' \
--data-urlencode 'subject_token_type=urn:ietf:params:oauth:token-type:access_token' \
Expand Down Expand Up @@ -289,7 +289,7 @@ Perform the requests in the previous [Flow specifics](#flow-specifics) section.
curl --location --request POST \
--url 'https://${yourOktaDomain}/oauth2/{trustedAuthServerId}/v1/token' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {Base64 encoded service app client ID and client secret}' \
--header 'Authorization: Basic {Base64-encoded service app client ID and client secret}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=urn:ietf:params:oauth:grant-type:token-exchange' \
--data-urlencode 'subject_token_type=urn:ietf:params:oauth:token-type:access_token' \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Follow the third-party Certificate Authority (CA) process that your company uses
The CA that you choose provides instructions on how to upload the CSR that you generated in the previous step.

Okta generates the CSR in Base64 DER format. If your process requires a different format, convert it using OpenSSL or a third-party decoder. Free third-party decoders are readily available.
Okta generates the CSR in Base64-encoded DER format. If your process requires a different format, convert it using OpenSSL or a third-party decoder. Free third-party decoders are readily available.

## Publish a CSR with a certificate

Expand All @@ -189,7 +189,7 @@ Base64 encoding and PEM, DER, and CER certificate formats are supported.

Collect the returned Key ID (`credentials.signing.kid`) to use in the next step.

The following request publishes a CSR with a certificate in base64 encoded `DER` format.
The following request publishes a CSR with a certificate in Base64-encoded `DER` format.

### Request

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To submit a SCIM integration, click the **SCIM** tab and select **On** from the

After you create the variable, click the pencil icon to make changes to the details, the clipboard icon to copy the **Variable Name** to your local clipboard, or the "X" icon to remove the variable entirely.

* **Construct your dynamic Base URL by copying the variables above and pasting them where applicable**: Provide the Base URL that your integration uses when sending an outbound call to your SCIM server.
* **Construct your dynamic Base URL by copying the variables above and pasting them where applicable**: Provide the base URL that your integration uses when sending an outbound call to your SCIM server.

If you're using a per tenant design, include the variable names that you created. For example:

Expand Down
Loading

0 comments on commit a70e7da

Please sign in to comment.