open-index/open-npm huggingface dataset:
npm package: @mybiogen/auth-openid
Description: Authorization for OpenID
Latest version: 1.8.5

# auth-openid

## Quickstart

#### 1. Install (assuming the private npm registry is already set up)

`yarn add @mybiogen/open-authid`

#### 2. Create JanrainJS instance.

```
import JanrainJS from '@mybiogen/open-authid'

const janrain = new JanrainJS(JANRAIN_CLIENT_ID, JANRAIN_CONFIG_URL, JANRAIN_REDIRECT_URI)
```

Note: `JANRAIN_CLIENT_ID`, `JANRAIN_CONFIG_URL` and `JANRAIN_REDIRECT_URI` are required params.

## API Summary

|  |  |  |
| --- | --- | --- |
| `janrain.login()` | `(): void` | User login method. |
| `janrain.logout()` | `async (): Promise<void>` | User logout method. |
| `janrain.watchAuth(callback)` | `async (cb: WatchAuthCallback): Promise<void>` | Method for watching the changes in authentication status. |
| `janrain.getUserInfo()` | `async (): Promise<JanrainUserInfo or undefined>`| Method for retrieving user information. |
| `janrain.refreshToken()` | `async (): Promise<Init or undefined>` | Method for refreshing authentication token. |

## Available types

`import { Token, JanrainUserInfo, WatchAuthCallback, Init, ConfigEndpoint } from '@mybiogen/open-authid';`