Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

auth0-lab/fga-js-sdk

Repository files navigation

JavaScript and Node.js SDK for Okta Fine Grained Authorization (FGA)

npm Release License

This is an autogenerated JavaScript SDK for Auth0 Fine Grained Authorization (FGA). It provides a wrapper around the Auth0 Fine Grained Authorization API, and includes TS typings.

This SDK is considered deprecated.

Table of Contents

About

Okta Fine Grained Authorization (FGA) is designed to make it easy for application builders to model their permission layer, and to add and integrate fine-grained authorization into their applications. Okta Fine Grained Authorization (FGA)’s design is optimized for reliability and low latency at a high scale.

DEPRECATION WARNING: This project is no longer maintained. We recommend using the OpenFGA JS SDK with the following configuration instead of this SDK:

const { CredentialsMethod, OpenFgaClient } = require('@openfga/sdk'); // OR import { CredentialsMethod, OpenFgaClient } from '@openfga/sdk';

const fgaClient = new OpenFgaClient({
    apiUrl: "https://api.us1.fga.dev",
    storeId: process.env.FGA_STORE_ID,
    authorizationModelId: process.env.FGA_MODEL_ID,
    credentials: {
      method: CredentialsMethod.ClientCredentials,
      config: {
        apiTokenIssuer: "fga.us.auth0.com",
        apiAudience: "https://api.us1.fga.dev/",
        clientId: process.env.FGA_CLIENT_ID,
        clientSecret: process.env.FGA_CLIENT_SECRET,
      },
    }
});

For US1 (Production US) environment, use the following values:

  • API URL: https://api.us1.fga.dev
  • Credential Method: ClientCredentials
  • API Token Issuer: fga.us.auth0.com
  • API Audience: https://api.us1.fga.dev/

You can get the rest of the necessary variables from the FGA Dashboard. See here.

Resources

Contributing

This repo is deprecated and no longer accepting contributions.

Author

Okta FGA

License

This project is licensed under the MIT license. See the LICENSE file for more info.

The code in this repo was auto generated by OpenAPI Generator from a template based on the typescript-axios template and go template, licensed under the Apache License 2.0.