Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README: replace usages of var #1447

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README: replace usages of var #1447

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,8 @@ const authClient = new OktaAuth(/* configOptions */)

```javascript
// CommonJS
var OktaAuth = require('@okta/okta-auth-js').OktaAuth;
var authClient = new OktaAuth(/* configOptions */);
const OktaAuth = require('@okta/okta-auth-js').OktaAuth;
const authClient = new OktaAuth(/* configOptions */);
```

## Usage guide
Expand All @@ -214,21 +214,21 @@ You can also browse the full [API reference documentation](#api-reference).
### Example Client

```javascript
var config = {
const config = {
issuer: 'https://{yourOktaDomain}/oauth2/default',
clientId: 'GHtf9iJdr60A9IYrR0jw',
redirectUri: 'https://acme.com/oauth2/callback/home',
};

var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
```

### Running as a service

By default, creating a new instance of `OktaAuth` will not create any asynchronous side-effects. However, certain features such as [token auto renew](#autorenew), [token auto remove](#autoremove) and [cross-tab synchronization](#syncstorage) require `OktaAuth` to be running as a service. This means timeouts are set in the background which will continue working until the service is stopped. To start the `OktaAuth` service, simply call the `start` method right after creation and before calling other methods like [handleRedirect](#handleredirectoriginaluri). To terminate all background processes, call `stop`. See [Service Configuration](#services) for more info.

```javascript
var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
await authClient.start(); // start the service
await authClient.stop(); // stop the service
```
Expand Down Expand Up @@ -281,7 +281,7 @@ To solve this issue please install package `@types/webappsec-credential-manageme
Web and native clients can obtain tokens using the `authorization_code` flow which uses a client secret stored in a secure location. (SPA applications should use the `PKCE` flow which does not use a client secret) To use the `authorization_code` flow, set `responseType` to `"code"` and `pkce` to `false`:

```javascript
var config = {
const config = {
// Required config
issuer: 'https://{yourOktaDomain}/oauth2/default',
clientId: 'GHtf9iJdr60A9IYrR0jw',
Expand All @@ -292,7 +292,7 @@ var config = {
pkce: false
};

var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
```

#### PKCE OAuth 2.0 flow
Expand All @@ -313,14 +313,14 @@ Implicit flow can be enabled by setting the `pkce` option to `false`

```javascript

var config = {
const config = {
pkce: false,

// other config
issuer: 'https://{yourOktaDomain}/oauth2/default',
};

var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
```

### Redirects and Routing
Expand All @@ -346,7 +346,7 @@ Most applications will handle an OAuth callback using a special route/page, sepa

async function main() {
// create OktaAuth instance
var config = {
const config = {
issuer: 'https://{yourOktaDomain}/oauth2/default',
clientId: 'GHtf9iJdr60A9IYrR0jw',
redirectUri: 'https://acme.com/oauth2/callback/home',
Expand Down Expand Up @@ -402,32 +402,32 @@ Whether you are using this SDK to implement an OIDC flow or for communicating wi
You may use the URL for your Okta organization as the issuer. This will apply a default authorization policy and issue tokens scoped at the organization level.

```javascript
var config = {
const config = {
issuer: 'https://{yourOktaDomain}'
};

var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
```

Okta allows you to create multiple custom OAuth 2.0 authorization servers that you can use to protect your own resource servers. Within each authorization server you can define your own OAuth 2.0 scopes, claims, and access policies. Many organizations have a "default" authorization server.

```javascript
var config = {
const config = {
issuer: 'https://{yourOktaDomain}/oauth2/default'
};

var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
```

You may also create and customize additional authorization servers.

```javascript

var config = {
const config = {
issuer: 'https://{yourOktaDomain}/oauth2/custom-auth-server-id'
};

var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
```

### Configuration options
Expand Down Expand Up @@ -583,7 +583,7 @@ The http request implementation. By default, this is implemented using [cross-fe
2. Must return a Promise that resolves with a raw XMLHttpRequest response

```javascript
var config = {
const config = {
url: 'https://{yourOktaDomain}',
httpRequestClient: function(method, url, args) {
// args is in the form:
Expand All @@ -605,7 +605,7 @@ The `storageManager` provides access to client storage for specific purposes. `s

```javascript

var config = {
const config = {
storageManager: {
token: {
storageTypes: [
Expand Down Expand Up @@ -635,7 +635,7 @@ var config = {
**Important:** If neither [localStorage][] nor [sessionStorage][] are available, the default storage provider may fall back to using [cookie][] storage on some clients, . If your site will always be served over a HTTPS connection, you may want to forcibly enable "secure" cookies. This option will prevent cookies from being stored on an HTTP connection.

```javascript
var config = {
const config = {
cookies: {
secure: true
}
Expand All @@ -654,7 +654,7 @@ The following values for `storageType` are recognized:
**Note:** If the specified `storageType` is not available, but matches an entry in `storageTypes`, then default fallback logic will be applied. To disable this behavior, set `storageTypes` to an empty array:

```javascript
var config = {
const config = {
storageManager: {
token: {
storageType: 'sessionStorage',
Expand All @@ -667,7 +667,7 @@ var config = {
or set the `storageTypes` property with only one entry:

```javascript
var config = {
const config = {
storageManager: {
token: {
storageTypes: ['sessionStorage']
Expand Down Expand Up @@ -714,7 +714,7 @@ const storageProvider = {
}
}

var config = {
const config = {
storageManager: {
token: {
storageProvider: storageProvider
Expand All @@ -728,7 +728,7 @@ var config = {
If `cookie` storage is specified, it is possible to specify whether or not a session cookie is used by the cookie storage. This will automatically be configured if `sessionStorage` is specified and you fall back to `cookie` storage. If sessionCookie is not specified it will create a cookie with an expiry date of `2200-01-01T00:00:00.000Z`

```javascript
var config = {
const config = {
cookies: {
sessionCookie: true
}
Expand Down Expand Up @@ -775,20 +775,20 @@ Specify the [storage type](#storagetype) for tokens. This will override any valu

```javascript

var config = {
const config = {
url: 'https://{yourOktaDomain}',
tokenManager: {
storage: 'sessionStorage'
}
};

var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
```

A custom [storage provider](#storageprovider) instance can also be passed here. (This will override any `storageProvider` value set under the `token` section of the [storageManager](#storagemanager) configuration)

```javascript
var myMemoryStore = {};
let myMemoryStore = {};
const storageProvider = {
getItem: function(key) {
// custom get
Expand Down Expand Up @@ -1018,15 +1018,15 @@ authClient.signOut({

```javascript
// In this case, the ID token is stored under the 'myIdToken' key
var idToken = await authClient.tokenManager.get('myIdToken');
const idToken = await authClient.tokenManager.get('myIdToken');
authClient.signOut({
idToken: idToken
});
```

```javascript
// In this case, the access token is stored under the 'myAccessToken' key
var accessToken = await authClient.tokenManager.get('myAccessToken');
const accessToken = await authClient.tokenManager.get('myAccessToken');
authClient.signOut({
accessToken: accessToken
});
Expand Down Expand Up @@ -1425,7 +1425,7 @@ authClient.token.getWithoutPrompt({
idp: '0oa62b57p7c8PaGpU0h7'
})
.then(function(res) {
var tokens = res.tokens;
const tokens = res.tokens;

// Do something with tokens, such as
authClient.tokenManager.setTokens(tokens);
Expand All @@ -1447,7 +1447,7 @@ Create token with a popup.
```javascript
authClient.token.getWithPopup(options)
.then(function(res) {
var tokens = res.tokens;
const tokens = res.tokens;

// Do something with tokens, such as
authClient.tokenManager.setTokens(tokens);
Expand Down Expand Up @@ -1494,10 +1494,10 @@ The `state` string which was passed to `getWithRedirect` will be also be availab
```javascript
authClient.token.parseFromUrl()
.then(function(res) {
var state = res.state; // passed to getWithRedirect(), can be any string
const state = res.state; // passed to getWithRedirect(), can be any string

// manage token or tokens
var tokens = res.tokens;
const tokens = res.tokens;

// Do something with tokens, such as
authClient.tokenManager.setTokens(tokens);
Expand Down Expand Up @@ -1562,7 +1562,7 @@ Returns a new token if the Okta [session](https://developer.okta.com/docs/api/re

```javascript
// this token is provided by Okta via getWithoutPrompt, getWithPopup, and parseFromUrl
var tokenToRenew = {
const tokenToRenew = {
idToken: 'YOUR_ID_TOKEN_JWT',
claims: { /* token claims */ },
expiresAt: 1449699930,
Expand Down Expand Up @@ -1632,7 +1632,7 @@ Manually verify the validity of an ID token's claims and check the signature on
* `validationOptions` - Optional object to assert ID token claim values. Defaults to the configuration passed in during client instantiation.

```javascript
var validationOptions = {
const validationOptions = {
issuer: 'https://{yourOktaDomain}/oauth2/{authorizationServerId}'
}

Expand Down Expand Up @@ -1878,14 +1878,14 @@ To include this library in your project, you can follow the instructions in the
You only need to set the `issuer` for your Okta Domain:

```javascript
var OktaAuth = require('@okta/okta-auth-js').OktaAuth;
const OktaAuth = require('@okta/okta-auth-js').OktaAuth;

var config = {
const config = {
// The URL for your Okta organization
issuer: 'https://{yourOktaDomain}'
};

var authClient = new OktaAuth(config);
const authClient = new OktaAuth(config);
```

### `http`
Expand Down