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.

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

Start using TOC extension to create TOC for README #36

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ node_modules
.coveralls.yml
*.log
.env
.vscode
.vscode/*
!.vscode/settings.json
!.vscode/extensions.json
jsdocs/
jsdoc/

Expand Down
5 changes: 5 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"yzhang.markdown-all-in-one"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does this extension do for us?

]
}
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"markdown.extension.toc.levels": "2..6"
}
61 changes: 38 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]) 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -160,7 +175,7 @@ client.listUsers({
});
```

## Groups
### Groups

#### Create a Group

Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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.

Expand All @@ -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/
[Okta NodeJS Management SDK JSDoc Site]: https://developer.okta.com/okta-sdk-nodejs/jsdocs/