From f5cd27c5818cb2d8283ac790383f3d0f1560c664 Mon Sep 17 00:00:00 2001 From: Gabriel Sroka Date: Tue, 25 Apr 2023 08:37:34 -0700 Subject: [PATCH] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 21a81e22..67d95273 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ const client = new okta.Client({ It is also possible to provide configuration through environment variables or YAML files. Please see [Configuration](#configuration) for examples. -All interactions with the [Okta Platform API] is done through client methods. Some examples are below, but for a full +All interaction with the [Okta Platform API] is done through client methods. Some examples are below, but for a full list of methods please refer to the JsDoc page for the [Client]. ### OAuth 2.0 Authentication @@ -108,7 +108,7 @@ The `privateKey` can be passed in the following ways: - A string in PEM format - As a JSON object, in JWK format -> Note: in case OAuth client app uses multiple JWKs, `privateKey` should specify `kid` attribute. When `privateKey` is passed in PEM format, `keyId` value should be provided in SDK configuation. +> Note: in case OAuth client app uses multiple JWKs, `privateKey` should specify `kid` attribute. When `privateKey` is passed in PEM format, `keyId` value should be provided in SDK configuration. ## Examples @@ -312,7 +312,7 @@ const appUser = await client.applicationApi.assignUserToApplication({ console.log('Assigned user to app, app user instance:', appUser); ``` -An App User is created, which is a new user instance that is specific to this application. An App User allows you define an application-specific profile for that user. For more information please see [Applications: User Operations] and [Applications: Application User Profile]. +An App User is created, which is a new user instance that is specific to this application. An App User allows you to define an application-specific profile for that user. For more information please see [Applications: User Operations] and [Applications: Application User Profile]. #### Assign a Group to an Application @@ -930,7 +930,7 @@ const application: BookmarkApplication = client.createApplication(applicationOpt ### 7.x.x -API methods should be called from corresponding API object of `client`. +API methods should be called from the corresponding API object of `client`. Params should be passed as a single object. See [migration guide](#from-6x-to-70) @@ -998,13 +998,13 @@ const client: Client = new Client({ #### Breaking changes -Enum types from the spec are accounted for: repspective JS models are converted to enum-like modules. +Enum types from the spec are accounted for: respective JS models are converted to enum-like modules. Following Client methods signatures have changed: - `listPolicies` returns `Promise` - `activateNetworkZone` returns `Promise` - `deactivateNetworkZone` returns `Promise` - - `listGroups` no longer accepts `filter` parameter trhough `queryParameters` + - `listGroups` no longer accepts `filter` parameter through `queryParameters` ### From 4.x to 5.0