Auth0.Fga 0.5.1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

.NET 6.0

dotnet add package Auth0.Fga --version 0.5.1

NuGet\Install-Package Auth0.Fga -Version 0.5.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Auth0.Fga" Version="0.5.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Auth0.Fga --version 0.5.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Auth0.Fga, 0.5.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Auth0.Fga as a Cake Addin
#addin nuget:?package=Auth0.Fga&version=0.5.1

// Install Auth0.Fga as a Cake Tool
#tool nuget:?package=Auth0.Fga&version=0.5.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

.NET SDK for Auth0 Fine Grained Authorization (FGA)

This is an autogenerated SDK for Auth0 Fine Grained Authorization (FGA). It provides a wrapper around the Auth0 Fine Grained Authorization API.

Warning: This SDK comes with no SLAs and is not production-ready!

About Auth0 Fine Grained Authorization (FGA)
Resources
Installation
Getting Started
Contributing
- Issues
- Pull Requests [Note: We are not accepting Pull Requests at this time!]
License

About

Auth0 Fine Grained Authorization (FGA) is Auth0's Fine-Grained Authorization at scale SaaS based on Google's Zanzibar.

Auth0 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. Auth0 Fine Grained Authorization (FGA)’s design is optimized for reliability and low latency at a high scale.

It allows in-memory data storage for quick development, as well as pluggable database modules - with initial support for PostgreSQL.

It offers an HTTP API and has SDKs for programming languages including Node.js/JavaScript, GoLang and .NET.

More SDKs and integrations such as Rego are planned for the future.

Resources

Installation

The Auth0 Fine Grained Authorization (FGA) .NET SDK is available on NuGet.

You can install it using:

The dotnet CLI

dotnet add package Auth0.Fga

The Package Manager Console inside Visual Studio:

Install-Package Auth0.Fga

Visual Studio, Visual Studio for Mac and IntelliJ Rider

Search for and install Auth0.Fga in each of their respective package manager UIs.

Getting Started

Initializing the API Client

using Auth0.Fga.Api;
using Auth0.Fga.Client;
using Auth0.Fga.Configuration;
using Auth0.Fga.Model;

namespace Example {
    public class Example {
        public static void Main() {
            try {
                // See https://github.com/auth0-lab/fga-dotnet-sdk#getting-your-store-id-client-id-and-client-secret
                var environment = Environment.GetEnvironmentVariable(("AUTH0_FGA_ENVIRONMENT"), // can be = "us"/"staging"/"playground"
                var configuration = new Configuration(environment) {
                    StoreId = Environment.GetEnvironmentVariable(("AUTH0_FGA_STORE_ID"),
                    ClientId = Environment.GetEnvironmentVariable(("AUTH0_FGA_CLIENT_ID"), // Required for all environments except playground
                    ClientSecret = Environment.GetEnvironmentVariable(("AUTH0_FGA_CLIENT_SECRET"), // Required for all environments except playground
                };
                var auth0FgaApi = new Auth0FgaApi(configuration);
                var response = auth0FgaApi.ReadAuthorizationModels();
                Debug.WriteLine(response.AuthorizationModelIds);
            } catch (ApiException e) {
                 Debug.Print("Status Code: "+ e.ErrorCode);
            }
        }
    }
}

Getting your Store ID, Client ID and Client Secret

Production

Make sure you have created your credentials on the Auth0 FGA Dashboard. Learn how ➡

You will need to set the AUTH0_FGA_ENVIRONMENT variable to "us". Provide the store id, client id and client secret you have created on the Dashboard.

Playground

If you are testing this on the public playground, you need to set your AUTH0_FGA_ENVIRONMENT to "playground".

To get your store id, you may copy it from the store you have created on the Playground. Learn how ➡

In the playground environment, you do not need to provide a client id and client secret.

Calling the API

Write Authorization Model

API Documentation

Note: To learn how to build your authorization model, check the Docs at https://docs.fga.dev.

Learn more about the Auth0 Fine Grained Authorization (FGA) configuration language.

var documentRelations = new Dictionary<string, Userset>()
{
    {"writer", new Userset(_this: new object())},
    {
        "viewer",
        new Userset(union: new Usersets(new List<Userset>()
            {new(new object(), new ObjectRelation("", "writer"))}))
    }
};
var userRelations = new Dictionary<string, Userset>()
{
};

var body = new WriteAuthorizationModelRequest(new List<TypeDefinition>() {new("document", documentRelations), new("user", userRelations)});
var response = await auth0FgaApi.WriteAuthorizationModel(body);

// response.AuthorizationModelId = 1uHxCSuTP0VKPYSnkq1pbb1jeZw

Read a Single Authorization Model

API Documentation

string authorizationModelId = "1uHxCSuTP0VKPYSnkq1pbb1jeZw"; // Assuming `1uHxCSuTP0VKPYSnkq1pbb1jeZw` is an id of an existing model
var response = await auth0FgaApi.ReadAuthorizationModel(authorizationModelId);

// response.AuthorizationModel.Id = "1uHxCSuTP0VKPYSnkq1pbb1jeZw"
// response.AuthorizationModel.TypeDefinitions = [{ "type": "document", "relations": { ... } }, { "type": "user", "relations": { ... }}]

Read Authorization Model IDs

API Documentation

var response = await auth0FgaApi.ReadAuthorizationModels();

// response.AuthorizationModelIds = ["1uHxCSuTP0VKPYSnkq1pbb1jeZw", "GtQpMohWezFmIbyXxVEocOCxxgq"];

Check

API Documentation

var body =
    new CheckRequest{tupleKey: new TupleKey("document:roadmap", "viewer", "user:81684243-9356-4421-8fbf-a4f8d36aa31b"), AuthorizationModelId = "1uHxCSuTP0VKPYSnkq1pbb1jeZw"};
var response = await auth0FgaApi.Check(body);
// response.Allowed = true

Write Tuples

API Documentation

var body = new WriteRequest{Writes = new TupleKeys(new List<TupleKey>
    {new("document:roadmap", "viewer", "user:81684243-9356-4421-8fbf-a4f8d36aa31b")}), AuthorizationModelId = "1uHxCSuTP0VKPYSnkq1pbb1jeZw"};
var response = await auth0FgaApi.Write(body);

Delete Tuples

API Documentation

var body = new WriteRequest{Deletes = new TupleKeys(new List<TupleKey>
    {new("document:roadmap", "viewer", "user:81684243-9356-4421-8fbf-a4f8d36aa31b")}), AuthorizationModelId = "1uHxCSuTP0VKPYSnkq1pbb1jeZw"};
var response = await auth0FgaApi.Write(body);

Expand

API Documentation

var body = new ExpandRequest{TupleKey = new TupleKey("document:roadmap", "viewer"), AuthorizationModelId = "1uHxCSuTP0VKPYSnkq1pbb1jeZw"};
var response = await auth0FgaApi.Expand(body);

// response.Tree.Root = {"name":"document:roadmap#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b","user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]}}}

Read Changes

API Documentation

// Find if a relationship tuple stating that a certain user is a viewer of a certain document
var body = new ReadRequest(new TupleKey(
    _object: "document:roadmap",
    relation: "viewer",
    user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b");

// Find all relationship tuples where a certain user has a relationship as any relation to a certain document
var body = new ReadRequest(new TupleKey(
    _object: "document:roadmap",
    user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b"));

// Find all relationship tuples where a certain user is a viewer of any document
var body = new ReadRequest(new TupleKey(
    _object: "document:",
    relation: "viewer",
    user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b"));

// Find all relationship tuples where any user has a relationship as any relation with a particular document
var body = new ReadRequest(new TupleKey(
    _object: "document:roadmap"));

// Read all stored relationship tuples
body := ReadRequest()

var response = await auth0FgaApi.Read(body);

// In all the above situations, the response will be of the form:
// response = {"tuples":[{"key":{"user":"...","relation":"...","object":"..."},"timestamp":"..."}]}

Read Changes (Watch)

API Documentation

var type = 'document';
var pageSize = 25;
var continuationToken = 'eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==';

var response = await auth0FgaApi.ReadChanges(type, pageSize, continuationToken);

// response.continuation_token = ...
// response.changes = [
//   { tuple_key: { user, relation, object }, operation: "writer", timestamp: ... },
//   { tuple_key: { user, relation, object }, operation: "viewer", timestamp: ... }
// ]

List Objects

API Documentation

var body = new ListObjectsRequest{
    AuthorizationModelId = "1uHxCSuTP0VKPYSnkq1pbb1jeZw",
    User = "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
    Relation = "viewer",
    Type = "document",
    ContextualTuples = new ContextualTupleKeys() {
        TupleKeys = new List<TupleKey> {
            new("document:budget", "writer", "user:81684243-9356-4421-8fbf-a4f8d36aa31b")
        }
    }
};
var response = await auth0FgaApi.ListObjects(body);

// response.Objects = ["document:roadmap"]

API Endpoints

Method	HTTP request	Description
Check	POST /stores/{store_id}/check	Check whether a user is authorized to access an object
Expand	POST /stores/{store_id}/expand	Expand all relationships in userset tree format, and following userset rewrite rules. Useful to reason about and debug a certain relationship
ListObjects	POST /stores/{store_id}/list-objects	Get all objects of the given type that the user has a relation with
Read	POST /stores/{store_id}/read	Get tuples from the store that matches a query, without following userset rewrite rules
ReadAssertions	GET /stores/{store_id}/assertions/{authorization_model_id}	Read assertions for an authorization model ID
ReadAuthorizationModel	GET /stores/{store_id}/authorization-models/{id}	Return a particular version of an authorization model
ReadAuthorizationModels	GET /stores/{store_id}/authorization-models	Return all the authorization models for a particular store
ReadChanges	GET /stores/{store_id}/changes	Return a list of all the tuple changes
Write	POST /stores/{store_id}/write	Add or delete tuples from the store
WriteAssertions	PUT /stores/{store_id}/assertions/{authorization_model_id}	Upsert assertions for an authorization model ID
WriteAuthorizationModel	POST /stores/{store_id}/authorization-models	Create a new authorization model

Models

Contributing

Issues

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker.

Pull Requests

Pull Requests are not currently open, please raise an issue or contact a team member on https://discord.gg/8naAwJfWN6 if there is a feature you'd like us to implement.

Author

Auth0 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 csharp-netcore template, licensed under the Apache License 2.0.

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed.

Compatible target framework(s)

Additional computed target framework(s)

Learn more about Target Frameworks and .NET Standard.

net6.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
0.5.1	188	5/1/2023
0.5.0	255	12/20/2022
0.4.0	659	10/13/2022
0.3.1	409	6/10/2022
0.3.0	374	6/7/2022
0.2.4	422	4/10/2022
0.2.3	373	4/9/2022
0.2.2	362	3/17/2022
0.2.1	373	3/11/2022
0.2.0	379	3/11/2022

https://github.com/auth0-lab/fga-dotnet-sdk/blob/main/CHANGELOG.md

Auth0.Fga 0.5.1

.NET SDK for Auth0 Fine Grained Authorization (FGA)

Table of Contents

About

Resources

Installation

Getting Started

Initializing the API Client

Getting your Store ID, Client ID and Client Secret

Production

Playground

Calling the API

Write Authorization Model

Read a Single Authorization Model

Read Authorization Model IDs

Check

Write Tuples

Delete Tuples

Expand

Read Changes

Read Changes (Watch)

List Objects

API Endpoints

Models

Contributing

Issues

Pull Requests

Author

License

net6.0

NuGet packages

GitHub repositories