https://github.com/authress/authress-sdk.js

The Authress SDK for Javascript provides authorization as a service with fully compatible REST apis.
https://github.com/authress/authress-sdk.js

authentication authorization authorization-backend authorization-framework authorization-middleware authorization-server authorizationservice authress javascript npm sdk security

Last synced: about 15 hours ago
JSON representation

The Authress SDK for Javascript provides authorization as a service with fully compatible REST apis.

• Host: GitHub
• URL: https://github.com/authress/authress-sdk.js
• Owner: Authress
• License: apache-2.0
• Created: 2020-04-30T12:33:58.000Z (over 4 years ago)
• Default Branch: release/3.0
• Last Pushed: 2024-11-05T13:58:56.000Z (14 days ago)
• Last Synced: 2024-11-05T14:02:18.012Z (14 days ago)
• Topics: authentication, authorization, authorization-backend, authorization-framework, authorization-middleware, authorization-server, authorizationservice, authress, javascript, npm, sdk, security
• Language: JavaScript
• Homepage: https://authress.io/app/#/api
• Size: 687 KB
• Stars: 8
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Authress SDK for Javascript/Typscript



    

    

    



This is the Authress SDK used to integrate with the authorization as a service provider Authress at https://authress.io.

## Usage

```sh

npm install @authress/sdk

```

Then required the package:

```js

const { AuthressClient } = require('@authress/sdk');

```

## Getting Started

### Frequently Asked Questions

* Where do I get a user ID from?

Every JWT contains a user ID, and you can pull it out from there using the `TokenVerifier` import or `verifyToken` method. For more details see [Authress JWT access tokens](https://authress.io/knowledge-base/docs/authentication/validating-jwts#authress-user-ids-and-a-jwt-access-token-example).

### Method Documentation

[SDK examples](./docs/methods.md)

### Framework Examples

See all the available [Authress Starter Kits](https://github.com/search?q=org%3AAuthress+starter-kit&type=repositories)

* [Express](https://github.com/Authress/express-starter-kit)

* [All other frameworks](https://github.com/search?q=org%3AAuthress+starter-kit&type=repositories)

## Contributions

### Adding new DTO and methods

Auto generate the new code using this openapi generator, and merge the files into the appropriate locations:

```bash

curl -XPOST https://generator3.swagger.io/api/generate -H 'content-type: application/json' -d '{"specURL" : "https://api.authress.io/.well-known/openapi.json","lang" : "typescript-fetch","type" : "CLIENT","codegenVersion" : "V3"}'  --output generated_sdk.tar.gz

```