Skip to content

Commit 45a86ce

Browse files
cavazosjoeJoe
andauthored
Update README.md to reference new "Integrator" accounts and remove remove references to Okta CLI tool. (#764)
* Update README.md to reference new "Integrator" accounts and remove references to Okta CLI tool. * Update README.md to use a more recognizable example value for ISSUER. * Fix port number for accessing running application. * Remove stale "configure okta resources" section. --------- Co-authored-by: Joe <schoolyd@teamschoolyd.org>
1 parent 7fbc1a2 commit 45a86ce

File tree

1 file changed

+50
-12
lines changed

1 file changed

+50
-12
lines changed

README.md

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,64 @@ This code sample demonstrates:
1818

1919
## Prerequisites
2020

21-
Before running this sample, you will need the following:
21+
Before you begin, you’ll need an Okta Integrator Free Plan account. To get one, sign up for an [Integrator account](https://developer.okta.com/login). Once you have an account, sign in to your [Integrator account](https://developer.okta.com/login). Next, in the Admin Console:
22+
23+
1. Go to **Applications > Applications**
24+
2. Click **Create App Integration**
25+
3. Select **OIDC - OpenID Connect** as the sign-in method
26+
4. Select **Single-Page Application** as the application type, then click **Next**
27+
5. Enter an app integration name (e.g. "My Vue SPA")
28+
6. In the **Grant type** section, ensure both **Authorization Code** and **Refresh Token** are selected
29+
7. Configure the redirect URIs:
30+
- **Sign-in redirect URIs:** `http://localhost:8080/login/callback`
31+
- **Sign-out redirect URIs:** `http://localhost:8080`
32+
8. In the **Controlled access** section, select the appropriate access level
33+
9. Click **Save**
2234

23-
* [The Okta CLI Tool](https://github.com/okta/okta-cli#installation)
24-
* An Okta Developer Account (create one using `okta register`, or configure an existing one with `okta login`)
35+
## Configure Okta resources
2536

26-
## Get the Code
37+
**Verify Authorization Server**
2738

28-
Grab and configure this project using `okta start vue`.
39+
When using a custom authorization server, you need to set up authorization policies. Complete these additional steps:
40+
41+
1. In the Admin Console, go to **Security > API > Authorization Servers**
42+
2. Select your custom authorization server (`default`)
43+
3. On the **Access Policies** tab, ensure you have at least one policy:
44+
- If no policies exist, click **Add New Access Policy**
45+
- Give it a name like “Default Policy”
46+
- Set **Assign to** to “All clients”
47+
- Click **Create Policy**
48+
4. For your policy, ensure you have at least one rule:
49+
- Click **Add Rule** if no rules exist
50+
- Give it a name like “Default Rule”
51+
- Set **Grant type** is to “Authorization Code”
52+
- Set **User** is to “Any user assigned the app”
53+
- Set **Scopes requested** to “Any scopes”
54+
- Click **Create Rule**
55+
56+
For more details, see the [Custom Authorization Server documentation](https://developer.okta.com/docs/concepts/auth-servers/#custom-authorization-server).
2957

30-
Follow the instructions printed to the console.
58+
## Get the Code
3159

32-
## Configure Okta resources
60+
```bash
61+
git clone https://github.com/okta-samples/okta-vue-sample.git
62+
cd okta-vue-sample
63+
```
64+
65+
Update your `.okta.env` file with the values from your application's configuration:
3366

34-
**Enable Refresh Tokens**
67+
```text
68+
ISSUER=https://integrator-1337.okta.com
69+
CLIENT_ID=0oab8eb55Kb9jdMIr5d6
70+
```
3571

36-
Sign into your [Okta Developer Edition account](https://developer.okta.com/login/) to add a required setting to your Vue Okta app to avoid third-party cookies. Navigate to **Applications** > **Applications** and select "okta-vue-sample" application to edit. Find the **General Settings** and press **Edit**. Enable **Refresh Token** in the **Grant type** section. **Save** your changes.
72+
### Where are my new app's credentials?
3773

38-
**Verify Authorization Server**
74+
Creating an OIDC Single-Page App manually in the Admin Console configures your Okta Org with the application settings. You may also need to configure trusted origins for `http://localhost:8080` in **Security > API > Trusted Origins**.
3975

40-
This repo calls a custom resource server to demonstrate making a protected resource request using an access token. Ensure that your default custom authorization server has an access policy. Add an access policy if it's not there. See [Create access polices](https://help.okta.com/okta_help.htm?type=oie&id=ext-create-access-policies).
76+
After creating the app, you can find the configuration details on the app’s **General** tab:
77+
- **Client ID**: Found in the **Client Credentials** section
78+
- **Issuer**: Found in the **Issuer URI** field for the authorization server that appears by selecting **Security > API** from the navigation pane.
4179

4280
## Run the Example
4381

@@ -53,7 +91,7 @@ With variables set, start your app:
5391
npm run dev
5492
```
5593

56-
Navigate to http://localhost:5173 in your browser.
94+
Navigate to http://localhost:8080 in your browser.
5795

5896
If you see a home page that prompts you to login, then things are working! Clicking the **Log in** button will redirect you to the Okta hosted sign-in page.
5997

0 commit comments

Comments
 (0)