# studentsso

> Offical client for StudentSSO - Allow your students to sign in without any API keys

Latest version **0.1.0** (published 2022-08-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install studentsso
pnpm add studentsso
yarn add studentsso
bun add studentsso
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2022-08-19 |
| First published | 2022-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | aboutdavid |
| Maintainers | aboutdavid |

## Links

- npm: https://www.npmjs.com/package/studentsso
- Repository: https://github.com/teamblobby/studentsso
- Homepage: https://github.com/teamblobby/studentsso#readme
- Issues: https://github.com/teamblobby/studentsso/issues
- npm.io page: https://npm.io/package/studentsso

## Dependencies (1)

- [sync-request](https://npm.io/package/sync-request.md) ^6.1.0

## Recent versions

- 0.1.0 (latest) — 2022-08-19

## README

# StudentSSO

StudentSSO's offical node.js package

## Install
```bash
npm i studentsso
# or
yarn add studentsso
```

## Docs

### `login: function (instance, provider, data)`

Logs into a service provider using a user's credentals

 * **Returns:** `object` — An object containing a name, email, and school

 * **Example:** 
 ```js
 sso.login("studentsso.blobby.me", "demo", {
     user: "John Doe",
     pass: "doejohn",
     district: "School",
});
```
 * **Exceptions:** — error if all values are not set.

### `getProvider: function (instance, provider)`

Fetches infomation about a service provider

 * **Parameters:**
   * `instance` — `string` — - An instance URL of StudentSSO (required)
   * `provider` — `string` — - Which provider you would like to you (required)

 * **Returns:** `object` — An object about a service provider.


 * **Example:** 
 ```js
sso.getProvider("studentsso.blobby.me", "demo");
```

  
 * **Exceptions:**  — error if all values are not set.

### `getDistricts: function (instance, provider, q)`

Searches instances from a service provider.

 * **Parameters:**
   * `instance` — `string` — - An instance URL of StudentSSO
   * `provider` — `string` — - Which provider you would like to you
   * `query` — `string` — - A query to search for.


 * **Returns:** `object` — An object about a service provider. Normally used for the "district" option when logging in or fetching data


 * **Example:** * 
 ```js
 sso.getDistricts("studentsso.blobby.me", "demo", "School District");
 ```
 * **Exceptions:**  — error if all values are not set.

---
_Source: https://npm.io/package/studentsso · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._