Auth0.Fga 0.2.3

.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!

Table of Contents

• About Auth0 Fine Grained Authorization
• Resources
• Installation
• Getting Started
  • Initializing the API Client
  • Getting your Store ID, Client ID and Client Secret
  • Calling the API
    • Write Authorization Model
    • Read a Single Authorization Model
    • Read Authorization Model IDs
    • Check
    • Write Tuples
    • Delete Tuples
    • Expand
    • Read
    • Read Changes (Watch)
  • API Endpoints
  • Models
• Contributing
  • Issues
  • Pull Requests [Note: We are not accepting Pull Requests at this time!]
• License

About Auth0 Fine Grained Authorization

Auth0 Fine Grained Authorization (FGA) is the early-stage product we are building at Auth0 as part of Auth0Lab to solve fine-grained authorization at scale. If you are interested in learning more about our plans, please reach out via our <a target="_blank" href="https://discord.gg/8naAwJfWN6" rel="noreferrer">Discord chat</a>.

Please note:

• At this point in time, Auth0 Fine Grained Authorization does not come with any SLAs; availability and uptime are not guaranteed.
• While this project is in its early stages, the SDK methods are in flux and might change without a major bump

Resources

• The Auth0 FGA Playground
• The Auth0 FGA Documentation
• Zanzibar Academy
• Auth0Lab on Twitter
• Discord Community

Installation

The Auth0 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 {
                var storeId = Environment.GetEnvironmentVariable("AUTH0_FGA_STORE_ID");
                var environment = Environment.GetEnvironmentVariable("AUTH0_FGA_ENVIRONMENT")
                var configuration = new Configuration(storeId, environment) {
                    ClientId = Environment.GetEnvironmentVariable("AUTH0_FGA_CLIENT_ID"),
                    ClientSecret = Environment.GetEnvironmentVariable("AUTH0_FGA_CLIENT_SECRET"),
                };
                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](https://docs.fga.dev/api/service#/Store Models/auth0_fga_WriteAuthorizationModel)

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

Note: The Auth0 FGA Playground, Dashboard and Documentation use a friendly syntax which gets translated to the API syntax seen below. Learn more about the Auth0 FGA configuration language.

var relations = new Dictionary<string, Userset>()
{
    {"writer", new Userset(_this: new object())},
    {
        "reader",
        new Userset(union: new Usersets(new List<Userset>()
            {new(new object(), new ObjectRelation("", "writer"))}))
    }
};
var body = new TypeDefinitions(new List<TypeDefinition>() {new("repo", relations)});
var response = await auth0FgaApi.WriteAuthorizationModel(body);

// response.AuthorizationModelId = 1uHxCSuTP0VKPYSnkq1pbb1jeZw

Read a Single Authorization Model

[API Documentation](https://docs.fga.dev/api/service#/Store Models/auth0_fga_ReadAuthorizationModel)

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": "repo", "relations": { ... } }]

Read Authorization Model IDs

[API Documentation](https://docs.fga.dev/api/service#/Store Models/auth0_fga_ReadAuthorizationModels)

var response = await auth0FgaApi.ReadAuthorizationModels();

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

Check

API Documentation

var body =
    new CheckRequestParams(tupleKey: new TupleKey("repo:auth0/express-jwt", "reader", "anne"));
var response = await auth0FgaApi.Check(body);
// response.Allowed = true

Write Tuples

API Documentation

var body = new WriteRequestParams(new TupleKeys(new List<TupleKey>
    {new("repo:auth0/express-jwt", "reader", "anne")}));
var response = await auth0FgaApi.Write(body);

Delete Tuples

API Documentation

var body = new WriteRequestParams(new TupleKeys(new List<TupleKey> { }),
    new TupleKeys(new List<TupleKey> {new("repo:auth0/express-jwt", "reader", "anne")}));
var response = await auth0FgaApi.Write(body);

Expand

API Documentation

var body = new ExpandRequestParams(new TupleKey("repo:auth0/express-jwt", "reader"));
var response = await auth0FgaApi.Expand(body);

// response.Tree.Root = {"name":"workspace:675bcac4-ad38-4fb1-a19a-94a5648c91d6#admin","leaf":{"users":{"users":["anne","beth"]}}}

Read

API Documentation

// Find if a relationship tuple stating that a certain user is an admin on a certain workspace
var body = new ReadRequestParams(new TupleKey(
    _object: "workspace:675bcac4-ad38-4fb1-a19a-94a5648c91d6",
    relation: "admin",
    user: "81684243-9356-4421-8fbf-a4f8d36aa31b"));

// Find all relationship tuples where a certain user has a relationship as any relation to a certain workspace
var body = new ReadRequestParams(new TupleKey(
    _object: "workspace:675bcac4-ad38-4fb1-a19a-94a5648c91d6",
    user: "81684243-9356-4421-8fbf-a4f8d36aa31b"));

// Find all relationship tuples where a certain user is an admin on any workspace
var body = new ReadRequestParams(new TupleKey(
    _object: "workspace:",
    relation: "admin",
    user: "81684243-9356-4421-8fbf-a4f8d36aa31b"));

// Find all relationship tuples where any user has a relationship as any relation with a particular workspace
var body = new ReadRequestParams(new TupleKey(
    _object: "workspace:675bcac4-ad38-4fb1-a19a-94a5648c91d6"));

var body = new ReadRequestParams(new TupleKey("repo:auth0/express-jwt", "reader", "anne"));
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 = 'workspace';
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: "write", timestamp: ... },
//   { tuple_key: { user, relation, object }, operation: "delete", timestamp: ... }
// ]

API Endpoints

Models

• Model.Any
• Model.Assertion
• Model.AuthErrorCode
• Model.AuthenticationErrorMessageResponse
• Model.AuthorizationModel
• Model.AuthorizationmodelDifference
• Model.AuthorizationmodelTupleToUserset
• Model.CheckRequestParams
• Model.CheckResponse
• Model.Computed
• Model.Environment
• Model.ErrorCode
• Model.ExpandRequestParams
• Model.ExpandResponse
• Model.InternalErrorCode
• Model.InternalErrorMessageResponse
• Model.Leaf
• Model.Node
• Model.Nodes
• Model.NotFoundErrorCode
• Model.ObjectRelation
• Model.PathUnknownErrorMessageResponse
• Model.ReadAssertionsResponse
• Model.ReadAuthorizationModelResponse
• Model.ReadAuthorizationModelsResponse
• Model.ReadChangesResponse
• Model.ReadRequestParams
• Model.ReadResponse
• Model.ReadSettingsResponse
• Model.ResourceExhaustedErrorCode
• Model.ResourceExhaustedErrorMessageResponse
• Model.Status
• Model.TokenIssuer
• Model.Tuple
• Model.TupleChange
• Model.TupleKey
• Model.TupleKeys
• Model.TupleOperation
• Model.TypeDefinition
• Model.TypeDefinitions
• Model.Users
• Model.Userset
• Model.UsersetTree
• Model.UsersetTreeDifference
• Model.UsersetTreeTupleToUserset
• Model.Usersets
• Model.ValidationErrorMessageResponse
• Model.WriteAssertionsRequestParams
• Model.WriteAuthorizationModelResponse
• Model.WriteRequestParams
• Model.WriteSettingsRequestParams
• Model.WriteSettingsResponse
• Model.WriteTokenIssuersRequestParams
• Model.WriteTokenIssuersResponse

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. The Responsible Disclosure Program details the procedure for disclosing security issues.

For auth0 related questions/support please use the Support Center.

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

Auth0Lab

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.