From 1ded13040eeb0f8ae794a66289fbc066ece462cc Mon Sep 17 00:00:00 2001 From: Robert Damphousse Date: Wed, 24 Jan 2018 16:44:25 -0800 Subject: [PATCH 1/2] Start using TOC extension to create TOC for README I'd like to start using this extension to auto-generate the TOC for this library so that the TOC is always up to date as we add new examples: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one --- .gitignore | 3 ++- .vscode/settings.json | 3 +++ README.md | 61 +++++++++++++++++++++++++++---------------- 3 files changed, 43 insertions(+), 24 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.gitignore b/.gitignore index d01c4517d..8be932f12 100644 --- a/.gitignore +++ b/.gitignore @@ -5,7 +5,8 @@ node_modules .coveralls.yml *.log .env -.vscode +.vscode/* +!.vscode/settings.json jsdocs/ jsdoc/ diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 000000000..ae982e010 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "markdown.extension.toc.levels": "2..6" +} diff --git a/README.md b/README.md index d61671473..650793952 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,45 @@ Node.js API Client for the [Okta Platform API]. Requires Node.js version 4.8.3 or higher. -## :warning: :construction: Alpha Preview :construction: :warning: +# :warning: :construction: Alpha Preview :construction: :warning: This library is under development and is currently a 0.x version series. Breaking changes will be introduced as minor version bumps in the 0.x range. Some of the API is not yet expressed in this library, please refer to the JsDoc for a complete list of classes and methods: [Okta NodeJS Management SDK JSDoc Site]. Need help? Contact [developers@okta.com](mailto:developers@okta.com) or use the [Okta Developer Forum]. +# Table of Contents + +- [Installation](#installation) +- [Usage](#usage) +- [Examples](#examples) + - [Users](#users) + - [Create a User](#create-a-user) + - [Get a User](#get-a-user) + - [Update a User](#update-a-user) + - [Delete a User](#delete-a-user) + - [List All Org Users](#list-all-org-users) + - [Search for Users](#search-for-users) + - [Groups](#groups) + - [Create a Group](#create-a-group) + - [Assign a User to a Group](#assign-a-user-to-a-group) + - [Applications](#applications) + - [Create An Application](#create-an-application) + - [Assign a User to an Application](#assign-a-user-to-an-application) + - [Assign a Group to an Application](#assign-a-group-to-an-application) + - [Sessions](#sessions) + - [Create a Session](#create-a-session) + - [Get a Session](#get-a-session) + - [Refresh a Session](#refresh-a-session) + - [End a Session](#end-a-session) + - [End all Sessions for a User](#end-all-sessions-for-a-user) +- [Collections](#collections) + - [`each()`](#each) + - [Serial or Parallel Synchronous Work](#serial-or-parallel-synchronous-work) + - [Serial Asynchronous Work](#serial-asynchronous-work) + - [Ending Iteration](#ending-iteration) +- [Configuration](#configuration) +- [Contributing](#contributing) + ## Installation ```sh @@ -39,24 +72,6 @@ https://developer.okta.com/okta-sdk-nodejs/jsdocs/Client.html This library is a wrapper for the [Okta Platform API], which should be referred to as the source-of-truth for what is and isn't possible with the API. In the following sections we show you how to use your client to perform some common operations with the [Okta Platform API]. -* [Users](#users) - * [Create a User](#create-a-user) - * [Get a User](#get-a-user) - * [Update a User](#update-a-user) - * [Delete a User](#delete-a-user) - * [List All Org Users](#list-all-org-users) - * [Search for Users](#search-for-users) -* [Groups](#groups) - * [Create a Group](#create-a-group) - * [Assign a User to a Group](#assign-a-user-to-a-group) -* [Applications](#applications) - * [Create an Application](#create-an-application) - * [Assign a User to an Application](#assign-a-user-to-an-application) - * [Assign a Group to an Application](#assign-a-group-to-an-application) -* [Collections](#collections) - * [each](#each) -* [Configuration](#configuration) - ### Users #### Create a User @@ -160,7 +175,7 @@ client.listUsers({ }); ``` -## Groups +### Groups #### Create a Group @@ -246,7 +261,7 @@ This is a rarely used method. See [Sessions: Create Session with Session Token] ```javascript client.createSession({ - sessionToken: 'your session token' + sessionToken: 'your session token' }) .then(session => { console.log('Session details:' session); @@ -397,7 +412,7 @@ OKTA_CLIENT_ORGURL=https://dev-1234.oktapreview.com/ OKTA_CLIENT_TOKEN=xYzabc ``` -### Contributing +## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) if you would like to propose changes to this library. @@ -419,4 +434,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) if you would like to propose changes to t [Users: Lifecycle Operations]: https://developer.okta.com/docs/api/resources/users.html#lifecycle-operations [Users: List Users]: https://developer.okta.com/docs/api/resources/users.html#list-users [Users: Update User]: https://developer.okta.com/docs/api/resources/users.html#update-user -[Okta NodeJS Management SDK JSDoc Site]: https://developer.okta.com/okta-sdk-nodejs/jsdocs/ \ No newline at end of file +[Okta NodeJS Management SDK JSDoc Site]: https://developer.okta.com/okta-sdk-nodejs/jsdocs/ From d3d80cbba74e41451524cfe0851a04f9921e9e46 Mon Sep 17 00:00:00 2001 From: Robert Damphousse Date: Wed, 24 Jan 2018 16:53:15 -0800 Subject: [PATCH 2/2] Add extension to recommended extensions --- .gitignore | 1 + .vscode/extensions.json | 5 +++++ 2 files changed, 6 insertions(+) create mode 100644 .vscode/extensions.json diff --git a/.gitignore b/.gitignore index 8be932f12..316a5e018 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ node_modules .env .vscode/* !.vscode/settings.json +!.vscode/extensions.json jsdocs/ jsdoc/ diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000..d68226711 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "yzhang.markdown-all-in-one" + ] +}