Go SDK for OpenFGA
This is an autogenerated Go SDK for OpenFGA. It provides a wrapper around the OpenFGA API definition.
Table of Contents
About
OpenFGA is an open source Fine-Grained Authorization solution inspired by Google’s Zanzibar paper. It was created by the FGA team at Auth0 based on Auth0 Fine-Grained Authorization (FGA), available under a permissive license (Apache-2) and welcomes community contributions.
OpenFGA 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. OpenFGA’s design is optimized for reliability and low latency at a high scale.
Resources
Installation
To install:
go get -u github.com/openfga/go-sdk
In your code, import the module and use it:
import "github.com/openfga/go-sdk"
func Main() {
configuration, err := openfga.NewConfiguration(openfga.Configuration{})
}
You can then run
go mod tidy
to update go.mod and go.sum if you are using them.
Getting Started
Initializing the API Client
Learn how to initialize your SDK
We strongly recommend you initialize the OpenFgaClient only once and then re-use it throughout your app, otherwise you will incur the cost of having to re-initialize multiple times or at every request, the cost of reduced connection pooling and re-use, and would be particularly costly in the client credentials flow, as that flow will be preformed on every request.
The openfgaClient will by default retry API requests up to 3 times on 429 and 5xx errors.
No Credentials
import (
. "github.com/openfga/go-sdk/client"
"os"
)
func main() {
fgaClient, err := NewSdkClient(&ClientConfiguration{
ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
StoreId: os.Getenv("FGA_STORE_ID"), // not needed when calling `CreateStore` or `ListStores`
AuthorizationModelId: os.Getenv("FGA_MODEL_ID"), // optional, recommended to be set for production
})
if err != nil {
// .. Handle error
}
}
API Token
import (
. "github.com/openfga/go-sdk/client"
"github.com/openfga/go-sdk/credentials"
"os"
)
func main() {
fgaClient, err := NewSdkClient(&ClientConfiguration{
ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
StoreId: os.Getenv("FGA_STORE_ID"), // not needed when calling `CreateStore` or `ListStores`
AuthorizationModelId: os.Getenv("FGA_MODEL_ID"), // optional, recommended to be set for production
Credentials: &credentials.Credentials{
Method: credentials.CredentialsMethodApiToken,
Config: &credentials.Config{
ApiToken: os.Getenv("FGA_API_TOKEN"), // will be passed as the "Authorization: Bearer ${ApiToken}" request header
},
},
})
if err != nil {
// .. Handle error
}
}
Client Credentials
import (
openfga "github.com/openfga/go-sdk"
. "github.com/openfga/go-sdk/client"
"github.com/openfga/go-sdk/credentials"
"os"
)
func main() {
fgaClient, err := NewSdkClient(&ClientConfiguration{
ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
StoreId: os.Getenv("FGA_STORE_ID"), // not needed when calling `CreateStore` or `ListStores`
AuthorizationModelId: os.Getenv("FGA_MODEL_ID"), // optional, recommended to be set for production
Credentials: &credentials.Credentials{
Method: credentials.CredentialsMethodClientCredentials,
Config: &credentials.Config{
ClientCredentialsClientId: os.Getenv("FGA_CLIENT_ID"),
ClientCredentialsClientSecret: os.Getenv("FGA_CLIENT_SECRET"),
ClientCredentialsApiAudience: os.Getenv("FGA_API_AUDIENCE"),
ClientCredentialsApiTokenIssuer: os.Getenv("FGA_API_TOKEN_ISSUER"),
},
},
})
if err != nil {
// .. Handle error
}
}
OAuth2 Client Credentials
import (
openfga "github.com/openfga/go-sdk"
. "github.com/openfga/go-sdk/client"
"github.com/openfga/go-sdk/credentials"
"os"
)
func main() {
fgaClient, err := NewSdkClient(&ClientConfiguration{
ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
StoreId: os.Getenv("FGA_STORE_ID"), // not needed when calling `CreateStore` or `ListStores`
AuthorizationModelId: os.Getenv("FGA_MODEL_ID"), // optional, recommended to be set for production
Credentials: &credentials.Credentials{
Method: credentials.CredentialsMethodClientCredentials,
Config: &credentials.Config{
ClientCredentialsClientId: os.Getenv("FGA_CLIENT_ID"),
ClientCredentialsClientSecret: os.Getenv("FGA_CLIENT_SECRET"),
ClientCredentialsScopes: os.Getenv("FGA_API_SCOPES"), // optional space separated scopes
ClientCredentialsApiTokenIssuer: os.Getenv("FGA_API_TOKEN_ISSUER"),
},
},
})
if err != nil {
// .. Handle error
}
}
You can set default headers that will be sent with every request during client initialization:
fgaClient, err := client.NewSdkClient(&client.ClientConfiguration{
ApiUrl: os.Getenv("FGA_API_URL"),
StoreId: os.Getenv("FGA_STORE_ID"),
AuthorizationModelId: os.Getenv("FGA_MODEL_ID"),
DefaultHeaders: map[string]string{
"X-Custom-Header": "default-value",
"X-Request-Source": "my-app",
},
})
You can also send custom headers on a per-request basis by using the Options parameter. Custom headers will override any default headers set in the client configuration.
// Add custom headers to a specific request
checkResponse, err := fgaClient.Check(context.Background()).
Body(client.ClientCheckRequest{
User: "user:anne",
Relation: "viewer",
Object: "document:roadmap",
}).
Options(client.ClientCheckOptions{
RequestOptions: client.RequestOptions{
Headers: map[string]string{
"X-Request-ID": "123e4567-e89b-12d3-a456-426614174000",
"X-Custom-Header": "custom-value", // these override any default headers set
},
},
}).
Execute()
Get your Store ID
You need your store id to call the OpenFGA API (unless it is to call the CreateStore or ListStores methods).
If your server is configured with authentication enabled, you also need to have your credentials ready.
Calling the API
Stores
List Stores
Get a paginated list of stores.
API Documentation
options := ClientListStoresOptions{
PageSize: openfga.PtrInt32(10),
ContinuationToken: openfga.PtrString("..."),
Name: openfga.PtrString("FGA Demo Store"), // Optional: filter stores by name
}
stores, err := fgaClient.ListStores(context.Background()).Options(options).Execute()
// stores = [{ "id": "01FQH7V8BEG3GPQW93KTRFR8JB", "name": "FGA Demo Store", "created_at": "2022-01-01T00:00:00.000Z", "updated_at": "2022-01-01T00:00:00.000Z" }]
Create Store
Create and initialize a store.
API Documentation
body := ClientCreateStoreRequest{Name: "FGA Demo"}
store, err := fgaClient.CreateStore(context.Background()).Body(body).Execute()
if err != nil {
// handle error
}
// store.Id = "01FQH7V8BEG3GPQW93KTRFR8JB"
// store store.Id in database
// update the storeId of the current instance
fgaClient.SetStoreId(store.Id)
// continue calling the API normally, scoped to this store
Get Store
Get information about the current store.
API Documentation
options := ClientGetStoreOptions{
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
store, err := fgaClient.GetStore(context.Background()).Options(options)Execute()
if err != nil {
// handle error
}
// store = { "id": "01FQH7V8BEG3GPQW93KTRFR8JB", "name": "FGA Demo Store", "created_at": "2022-01-01T00:00:00.000Z", "updated_at": "2022-01-01T00:00:00.000Z" }
Delete Store
Delete a store.
API Documentation
options := ClientDeleteStoreOptions{
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
_, err := fgaClient.DeleteStore(context.Background()).Options(options).Execute()
if err != nil {
// handle error
}
Authorization Models
Read Authorization Models
Read all authorization models in the store.
API Documentation
options := ClientReadAuthorizationModelsOptions{
PageSize: openfga.PtrInt32(10),
ContinuationToken: openfga.PtrString("..."),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.ReadAuthorizationModels(context.Background()).Options(options).Execute()
// data.AuthorizationModels = [
// { Id: "01GXSA8YR785C4FYS3C0RTG7B1", SchemaVersion: "1.1", TypeDefinitions: [...] },
// { Id: "01GXSBM5PVYHCJNRNKXMB4QZTW", SchemaVersion: "1.1", TypeDefinitions: [...] }];
Write Authorization Model
Create a new authorization model.
API Documentation
Note: To learn how to build your authorization model, check the Docs at https://openfga.dev/docs.
Learn more about the OpenFGA configuration language.
You can use the OpenFGA Syntax Transformer to convert between the friendly DSL and the JSON authorization model.
Instantiating the model inline
You can instantiate the model inline by constructing a WriteAuthorizationModelRequest with TypeDefinition entries:
body := ClientWriteAuthorizationModelRequest{
SchemaVersion: "1.1",
TypeDefinitions: []openfga.TypeDefinition{
{Type: "user", Relations: &map[string]openfga.Userset{}},
{
Type: "document",
Relations: &map[string]openfga.Userset{
"writer": {
This: &map[string]interface{}{},
},
"viewer": {Union: &openfga.Usersets{
Child: &[]openfga.Userset{
{This: &map[string]interface{}{}},
{ComputedUserset: &openfga.ObjectRelation{
Object: openfga.PtrString(""),
Relation: openfga.PtrString("writer"),
}},
},
}},
},
Metadata: &openfga.Metadata{
Relations: &map[string]openfga.RelationMetadata{
"writer": {
DirectlyRelatedUserTypes: &[]openfga.RelationReference{
{Type: "user"},
},
},
"viewer": {
DirectlyRelatedUserTypes: &[]openfga.RelationReference{
{Type: "user"},
},
},
},
},
}},
}
options := ClientWriteAuthorizationModelOptions{
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.WriteAuthorizationModel(context.Background()).Options(options).Body(body).Execute()
fmt.Printf("%s", data.AuthorizationModelId) // 01GXSA8YR785C4FYS3C0RTG7B1
Instantiating the model from a JSON file
You can instantiate the model by loading it from a JSON file:
jsonContent, _ := os.ReadFile("model.json")
var body openfga.WriteAuthorizationModelRequest
json.Unmarshal(jsonContent, &body)
options := ClientWriteAuthorizationModelOptions{
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.WriteAuthorizationModel(context.Background()).Options(options).Body(body).Execute()
fmt.Printf("%s", data.AuthorizationModelId) // 01GXSA8YR785C4FYS3C0RTG7B1
Instantiating the model from a DSL file
You can also load the model from an .fga file. To achieve that, you need to use the github.com/openfga/language/pkg/go/transformer module:
import (
"github.com/openfga/language/pkg/go/transformer"
)
dslContent, _ := os.ReadFile("model.fga")
jsonModel, _ := transformer.TransformDSLToJSON(string(dslContent))
var body openfga.WriteAuthorizationModelRequest
json.Unmarshal([]byte(jsonModel), &body)
options := ClientWriteAuthorizationModelOptions{
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.WriteAuthorizationModel(context.Background()).Options(options).Body(body).Execute()
fmt.Printf("%s", data.AuthorizationModelId) // 01GXSA8YR785C4FYS3C0RTG7B1
Read a Single Authorization Model
Read a particular authorization model.
API Documentation
options := ClientReadAuthorizationModelOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString(modelId),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.ReadAuthorizationModel(context.Background()).Options(options).Execute()
// data = {"authorization_model":{"id":"01GXSA8YR785C4FYS3C0RTG7B1","schema_version":"1.1","type_definitions":[{"type":"document","relations":{"writer":{"this":{}},"viewer":{ ... }}},{"type":"user"}]}} // JSON
fmt.Printf("%s", data.AuthorizationModel.Id) // 01GXSA8YR785C4FYS3C0RTG7B1
Read the Latest Authorization Model
Reads the latest authorization model (note: this ignores the model id in configuration).
API Documentation
options := ClientReadLatestAuthorizationModelOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString(modelId),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.ReadLatestAuthorizationModel(context.Background()).Options(options)Execute()
// data.AuthorizationModel.Id = "01GXSA8YR785C4FYS3C0RTG7B1"
// data.AuthorizationModel.SchemaVersion = "1.1"
// data.AuthorizationModel.TypeDefinitions = [{ "type": "document", "relations": { ... } }, { "type": "user", "relations": { ... }}]
fmt.Printf("%s", (*data.AuthorizationModel).GetId()) // 01GXSA8YR785C4FYS3C0RTG7B1
Relationship Tuples
Read Relationship Tuple Changes (Watch)
Reads the list of historical relationship tuple writes and deletes.
API Documentation
body := ClientReadChangesRequest{
Type: "document",
StartTime: openfga.PtrString("2022-01-01T00:00:00Z"),
}
options := ClientReadChangesOptions{
PageSize: openfga.PtrInt32(10),
ContinuationToken: openfga.PtrString("eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ=="),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.ReadChanges(context.Background()).Body(body).Options(options).Execute()
// data.ContinuationToken = ...
// data.Changes = [
// { TupleKey: { User, Relation, Object }, Operation: TupleOperation.WRITE, Timestamp: ... },
// { TupleKey: { User, Relation, Object }, Operation: TupleOperation.DELETE, Timestamp: ... }
// ]
Read Relationship Tuples
Reads the relationship tuples stored in the database. It does not evaluate nor exclude invalid tuples according to the authorization model.
API Documentation
// Find if a relationship tuple stating that a certain user is a viewer of a certain document
body := ClientReadRequest{
User: openfga.PtrString("user:81684243-9356-4421-8fbf-a4f8d36aa31b"),
Relation: openfga.PtrString("viewer"),
Object: openfga.PtrString("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
}
// Find all relationship tuples where a certain user has a relationship as any relation to a certain document
body := ClientReadRequest{
User: openfga.PtrString("user:81684243-9356-4421-8fbf-a4f8d36aa31b"),
Object: openfga.PtrString("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
}
// Find all relationship tuples where a certain user is a viewer of any document
body := ClientReadRequest{
User: openfga.PtrString("user:81684243-9356-4421-8fbf-a4f8d36aa31b"),
Relation: openfga.PtrString("viewer"),
Object: openfga.PtrString("document:"),
}
// Find all relationship tuples where any user has a relationship as any relation with a particular document
body := ClientReadRequest{
Object: openfga.PtrString("document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"),
}
// Read all stored relationship tuples
body := ClientReadRequest{}
options := ClientReadOptions{
PageSize: openfga.PtrInt32(10),
ContinuationToken: openfga.PtrString("eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ=="),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.Read(context.Background()).Body(requestBody).Options(options).Execute()
// In all the above situations, the response will be of the form:
// data = { Tuples: [{ Key: { User, Relation, Object }, Timestamp }, ...]}
Write (Create and Delete) Relationship Tuples
Create and/or delete relationship tuples to update the system state.
API Documentation
Transaction mode (default)
By default, write runs in a transaction mode where any invalid operation (deleting a non-existing tuple, creating an existing tuple, one of the tuples was invalid) or a server error will fail the entire operation.
body := ClientWriteRequest{
Writes: &[]ClientTupleKey{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "viewer",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
}, {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "viewer",
Object: "document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5",
} },
Deletes: &[]ClientTupleKeyWithoutCondition{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "writer",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} }
}
options := ClientWriteOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.Write(context.Background()).Body(body).Options(options).Execute()
Convenience WriteTuples and DeleteTuples methods are also available.
Non-transaction mode
The SDK will split the writes into separate chunks and send them in separate requests. Each chunk is a transaction. By default, each chunk is set to 1, but you may override that.
body := ClientWriteRequest{
Writes: &[]ClientTupleKey{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "viewer",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
}, {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "viewer",
Object: "document:0192ab2d-d36e-7cb3-a4a8-5d1d67a300c5",
} },
Deletes: &[]ClientTupleKeyWithoutCondition{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "writer",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} }
}
options := ClientWriteOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
Transaction: &TransactionOptions{
Disable: true,
MaxParallelRequests: 5, // Maximum number of requests to issue in parallel
MaxPerChunk: 1, // Maximum number of requests to be sent in a transaction in a particular chunk
},
}
data, err := fgaClient.Write(context.Background()).Body(body).Options(options).Execute()
// data.Writes = [{
// TupleKey: { User, Relation, Object },
// Status: "CLIENT_WRITE_STATUS_SUCCESS
// HttpResponse: ... // http response"
// }, {
// TupleKey: { User, Relation, Object },
// Status: "CLIENT_WRITE_STATUS_FAILURE
// HttpResponse: ... // http response"
// Error: ...
// }]
// data.Deletes = [{
// TupleKey: { User, Relation, Object },
// Status: "CLIENT_WRITE_STATUS_SUCCESS
// HttpResponse: ... // http response"
// }]
Conflict Options for Write Operations
The SDK supports conflict options for write operations, allowing you to control how the API handles duplicate writes and missing deletes.
Note: This requires OpenFGA v1.10.0 or later.
options := ClientWriteOptions{
Conflict: ClientWriteConflictOptions{
// Control what happens when writing a tuple that already exists
OnDuplicateWrites: CLIENT_WRITE_REQUEST_ON_DUPLICATE_WRITES_IGNORE, // or CLIENT_WRITE_REQUEST_ON_DUPLICATE_WRITES_ERROR (the current default behavior)
// Control what happens when deleting a tuple that doesn't exist
OnMissingDeletes: CLIENT_WRITE_REQUEST_ON_MISSING_DELETES_IGNORE, // or CLIENT_WRITE_REQUEST_ON_MISSING_DELETES_ERROR (the current default behavior)
},
}
body := ClientWriteRequest{
Writes: []ClientTupleKey{ {
User: "user:anne",
Relation: "writer",
Object: "document:2021-budget",
} },
Deletes: []ClientTupleKeyWithoutCondition{ {
User: "user:bob",
Relation: "reader",
Object: "document:2021-budget",
} },
}
data, err := fgaClient.Write(context.Background()).
Body(body).
Options(options).
Execute()
Relationship Queries
Check
Check if a user has a particular relation with an object.
API Documentation
Provide a tuple and ask the OpenFGA API to check for a relationship
body := ClientCheckRequest{
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "viewer",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
ContextualTuples: &[]ClientTupleKey{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "editor",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} },
}
options := ClientCheckOptions{
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.Check(context.Background()).Body(body).Options(options).Execute()
// data = {"allowed":true,"resolution":""} // in JSON
fmt.Printf("%t", data.GetAllowed()) // True
Batch Check
Similar to Check, but instead of checking a single user-object relationship, accepts a list of relationships to check. Requires OpenFGA version 1.8.0 or greater.
API Documentation
Note: The order of BatchCheck results is not guaranteed to match the order of the checks provided. Use correlationId to pair responses with requests.
If you are using an OpenFGA version less than 1.8.0, you can use the ClientBatchCheck function,
which calls check in parallel. It will return allowed: false if it encounters an error, and will return the error in the body.
If 429s or 5xxs are encountered, the underlying check will retry up to 3 times before giving up.
options := BatchCheckOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
MaxParallelRequests: openfga.PtrInt32(5), // Max number of requests to issue in parallel, defaults to 10
}
body := ClientBatchCheckRequest{
Checks: []ClientBatchCheckItem{ {
CorrelationId: "f278708f-298c-4f43-a893-11a02bbf251c",
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "viewer",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
ContextualTuples: &[]ClientTupleKey{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "editor",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} },
}, {
CorrelationId: "9f7563d6-2573-4292-9ba2-62d59b97c4d",
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "admin",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
ContextualTuples: &[]ClientTupleKey{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "editor",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} },
}, {
CorrelationId: "dbb8311c-d991-488d-82e6-76b0d6a3d7a2",
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "creator",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
}, {
CorrelationId: "9b17215d-89e0-47b4-aaf4-6476dc49649a",
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "deleter",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} }
}
data, err := fgaClient.BatchCheck(context.Background()).Body(body).Options(options).Execute()
/*
// Results are a map keyed by correlationId
// Example:
data.GetResult() = {
"f278708f-298c-4f43-a893-11a02bbf251c": {
Allowed: false,
Error: <FgaError ...>
},
"9f7563d6-2573-4292-9ba2-62d59b97c4d": {
Allowed: false,
Error: <FgaError ...>
},
"dbb8311c-d991-488d-82e6-76b0d6a3d7a2": {
Allowed: false,
Error: <FgaError ...>
},
"9b17215d-89e0-47b4-aaf4-6476dc49649a": {
Allowed: false,
Error: <FgaError ...>
}
}
*/
Expand
Expands the relationships in userset tree format.
API Documentation
options := ClientExpandOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
body := ClientExpandRequest{
Relation: "viewer",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
}
data, err := fgaClient.Expand(context.Background()).Body(body).Options(options).Execute()
// data.Tree.Root = {"name":"document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b","user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]}}}
You can also expand with contextual tuples:
options := ClientExpandOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
body := ClientExpandRequest{
Relation: "viewer",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
ContextualTuples: []ClientContextualTupleKey{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "editor",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} },
}
data, err := fgaClient.Expand(context.Background()).Body(body).Options(options).Execute()
// data.Tree.Root = {"name":"document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a#viewer","leaf":{"users":{"users":["user:81684243-9356-4421-8fbf-a4f8d36aa31b","user:f52a4f7a-054d-47ff-bb6e-3ac81269988f"]}}}
List Objects
List the objects of a particular type a user has access to.
API Documentation
options := ClientListObjectsOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
body := ClientListObjectsRequest{
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "can_read",
Type: "document",
ContextualTuples: &[]ClientTupleKey{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "editor",
Object: "folder:product",
}, {
User: "folder:product",
Relation: "parent",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} },
}
data, err := fgaClient.ListObjects(context.Background()).
Body(requestBody).
Options(options).
Execute()
// data.Objects = ["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]
Streamed List Objects
List objects of a particular type that the user has access to, using the streaming API.
The Streamed ListObjects API is very similar to the ListObjects API, with two key differences:
- Streaming Results: Instead of collecting all objects before returning a response, it streams them to the client as they are collected.
- No Pagination Limit: Returns all results without the 1000-object limit of the standard ListObjects API.
This is particularly useful when querying computed relations that may return large result sets.
API Documentation
options := ClientStreamedListObjectsOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
}
body := ClientStreamedListObjectsRequest{
User: "user:anne",
Relation: "can_read",
Type: "document",
}
response, err := fgaClient.StreamedListObjects(context.Background()).Body(body).Options(options).Execute()
if err != nil {
// .. Handle error
}
defer response.Close()
// Consume objects from the stream
var objects []string
for obj := range response.Objects {
objects = append(objects, obj.Object)
}
// Check for any errors during streaming
if err := <-response.Errors; err != nil {
// .. Handle streaming error
}
// objects = ["document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a"]
List Relations
List the relations a user has on an object.
options := ClientListRelationsOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
// Max number of requests to issue in parallel, defaults to 10
MaxParallelRequests: openfga.PtrInt32(5),
}
body := ClientListRelationsRequest{
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
Relations: []string{"can_view", "can_edit", "can_delete", "can_rename"},
ContextualTuples: &[]ClientTupleKey{ {
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "editor",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
} },
}
data, err := fgaClient.ListRelations(context.Background()).
Body(requestBody).
Options(options).
Execute()
// data.Relations = ["can_view", "can_edit"]
List Users
List the users who have a certain relation to a particular type.
API Documentation
options := ClientListRelationsOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
// Max number of requests to issue in parallel, defaults to 10
MaxParallelRequests: openfga.PtrInt32(5),
}
// Only a single filter is allowed by the API for the time being
userFilters := []openfga.UserTypeFilter{{ Type: "user" }}
// user filters can also be of the form
// userFilters := []openfga.UserTypeFilter{{ Type: "team", Relation: openfga.PtrString("member") }}
requestBody := ClientListUsersRequest{
Object: openfga.FgaObject{
Type: "document",
Id: "roadmap",
},
Relation: "can_read",
UserFilters: userFilters,
ContextualTuples: []ClientContextualTupleKey{{
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "editor",
Object: "folder:product",
}, {
User: "folder:product",
Relation: "parent",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
}},
Context: &map[string]interface{}{"ViewCount": 100},
}
data, err := fgaClient.ListRelations(context.Background()).
Body(requestBody).
Options(options).
Execute()
// response.users = [{object: {type: "user", id: "81684243-9356-4421-8fbf-a4f8d36aa31b"}}, {userset: { type: "user" }}, ...]
Assertions
Read Assertions
Read assertions for a particular authorization model.
API Documentation
options := ClientReadAssertionsOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId: openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
data, err := fgaClient.ReadAssertions(context.Background()).
Options(options).
Execute()
Write Assertions
Update the assertions for a particular authorization model.
API Documentation
options := ClientWriteAssertionsOptions{
// You can rely on the model id set in the configuration or override it for this specific request
AuthorizationModelId: openfga.PtrString("01GAHCE4YVKPQEKZQHT2R89MQV"),
// You can rely on the store id set in the configuration or override it for this specific request
StoreId:openfga.PtrString("01FQH7V8BEG3GPQW93KTRFR8JB"),
}
requestBody := ClientWriteAssertionsRequest{
ClientAssertion{
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "can_view",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
Expectation: true,
Context: &map[string]interface{}{
"context": "value",
},
ContextualTuples: []ClientContextualTupleKey{
{
User: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
Relation: "can_view",
Object: "document:0192ab2a-d83f-756d-9397-c5ed9f3cb69a",
},
},
},
}
data, err := fgaClient.WriteAssertions(context.Background()).
Body(requestBody).
Options(options).
Execute()
Calling Other Endpoints
In certain cases you may want to call other APIs not yet wrapped by the SDK. You can do so by using the APIExecutor available from the fgaClient.
The APIExecutor allows you to make raw HTTP calls to any OpenFGA endpoint by specifying the operation name, HTTP method, path, parameters, body, and headers, while still honoring the client configuration (authentication, telemetry, retries, and error handling).
This is useful when:
- you want to call a new endpoint that is not yet supported by the SDK
- you are using an earlier version of the SDK that doesn’t yet support a particular endpoint
- you have a custom endpoint deployed that extends the OpenFGA API
In all cases, you initialize the SDK the same way as usual, and then get the APIExecutor from the fgaClient instance.
// Initialize the client, same as above
fgaClient, err := NewSdkClient(&ClientConfiguration{...})
// Get the generic API executor
executor := fgaClient.GetAPIExecutor()
// Custom new endpoint that doesn't exist in the SDK yet
requestBody := map[string]interface{}{
"user": "user:bob",
"action": "custom_action",
"resource": "resource:123",
}
// Build the request
request := openfga.NewAPIExecutorRequestBuilder("CustomEndpoint", http.MethodPost, "/stores/{store_id}/custom-endpoint").
WithPathParameter("store_id", storeID).
WithQueryParameter("page_size", "20").
WithQueryParameter("continuation_token", "eyJwayI6...").
WithBody(requestBody).
WithHeader("X-Experimental-Feature", "enabled").
Build()
Example: Calling a new “Custom Endpoint” endpoint and handling raw response
// Get raw response without automatic decoding
rawResponse, err := executor.Execute(ctx, request)
if err != nil {
log.Fatalf("Custom endpoint failed: %v", err)
}
// Manually decode the response
var result map[string]interface{}
if err := json.Unmarshal(rawResponse.Body, &result); err != nil {
log.Fatalf("Failed to decode: %v", err)
}
fmt.Printf("Response: %+v\n", result)
// You can access fields like headers, status code, etc. from rawResponse:
fmt.Printf("Status Code: %d\n", rawResponse.StatusCode)
fmt.Printf("Headers: %+v\n", rawResponse.Headers)
Example: Calling a new “Custom Endpoint” endpoint and decoding response into a struct
// Define a struct to hold the response
type CustomEndpointResponse struct {
Allowed bool `json:"allowed"`
Reason string `json:"reason"`
}
var customEndpointResponse CustomEndpointResponse
// Get raw response decoded into CustomEndpointResponse struct
rawResponse, err := executor.ExecuteWithDecode(ctx, request, &customEndpointResponse) // Pass pointer to struct for decoding
if err != nil {
log.Fatalf("Custom endpoint failed: %v", err)
}
fmt.Printf("Response: %+v\n", customEndpointResponse)
// You can access fields like headers, status code, etc. from rawResponse:
fmt.Printf("Status Code: %d\n", rawResponse.StatusCode)
fmt.Printf("Headers: %+v\n", rawResponse.Headers)
Example: Calling streaming endpoints (e.g., StreamedListObjects)
For streaming API endpoints, use the ExecuteStreaming method. This is useful for endpoints like StreamedListObjects that stream results as they are computed rather than waiting for all results before responding.
// Get the generic API executor
executor := fgaClient.GetAPIExecutor()
// Build a streaming request for StreamedListObjects
request := openfga.NewAPIExecutorRequestBuilder("StreamedListObjects", http.MethodPost, "/stores/{store_id}/streamed-list-objects").
WithPathParameter("store_id", storeID).
WithBody(openfga.ListObjectsRequest{
AuthorizationModelId: openfga.PtrString(modelID),
Type: "document",
Relation: "viewer",
User: "user:alice",
}).
Build()
// Execute the streaming request
// The bufferSize parameter controls how many results can be buffered in the channel
channel, err := executor.ExecuteStreaming(ctx, request, openfga.DefaultStreamBufferSize)
if err != nil {
log.Fatalf("Streaming request failed: %v", err)
}
defer channel.Close() // Always close the channel when done
// Process results as they stream in
for {
select {
case result, ok := <-channel.Results:
if !ok {
// Results channel closed, stream completed
// Check for any final errors
select {
case err := <-channel.Errors:
if err != nil {
log.Fatalf("Stream error: %v", err)
}
default:
}
fmt.Println("Stream completed successfully")
return
}
// Decode the raw JSON bytes into a typed response
var response openfga.StreamedListObjectsResponse
if err := json.Unmarshal(result, &response); err != nil {
log.Fatalf("Failed to decode stream result: %v", err)
}
fmt.Printf("Received object: %s\n", response.Object)
case err := <-channel.Errors:
if err != nil {
log.Fatalf("Stream error: %v", err)
}
}
}
The ExecuteStreaming method returns an APIExecutorStreamingChannel with:
Results chan []byte: Raw JSON bytes for each streamed resultErrors chan error: Any errors that occur during streamingClose(): Method to cancel streaming and cleanup resources
Retries
If a network request fails with a 429 or 5xx error from the server, the SDK will automatically retry the request up to 3 times with a minimum wait time of 100 milliseconds between each attempt.
To customize this behavior, create an openfga.RetryParams struct and assign values to the MaxRetry and MinWaitInMs fields. MaxRetry determines the maximum number of retries (up to 15), while MinWaitInMs sets the minimum wait time between retries in milliseconds.
Apply your custom retry values by passing this struct to the ClientConfiguration struct’s RetryParams parameter.
import (
"os"
openfga "github.com/openfga/go-sdk"
. "github.com/openfga/go-sdk/client"
)
func main() {
fgaClient, err := NewSdkClient(&ClientConfiguration{
ApiUrl: os.Getenv("FGA_API_URL"), // required, e.g. https://api.fga.example
StoreId: os.Getenv("FGA_STORE_ID"), // not needed when calling `CreateStore` or `ListStores`
AuthorizationModelId: os.Getenv("FGA_MODEL_ID"), // optional, recommended to be set for production
RetryParams: &openfga.RetryParams{
MaxRetry: 3, // retry up to 3 times on API requests
MinWaitInMs: 250, // wait a minimum of 250 milliseconds between requests
},
})
if err != nil {
// .. Handle error
}
}
API Endpoints
| Class |
Method |
HTTP request |
Description |
| OpenFgaApi |
BatchCheck |
Post /stores/{store_id}/batch-check |
Send a list of `check` operations in a single request |
| OpenFgaApi |
Check |
Post /stores/{store_id}/check |
Check whether a user is authorized to access an object |
| OpenFgaApi |
CreateStore |
Post /stores |
Create a store |
| OpenFgaApi |
DeleteStore |
Delete /stores/{store_id} |
Delete a store |
| OpenFgaApi |
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 |
| OpenFgaApi |
GetStore |
Get /stores/{store_id} |
Get a store |
| OpenFgaApi |
ListObjects |
Post /stores/{store_id}/list-objects |
List all objects of the given type that the user has a relation with |
| OpenFgaApi |
ListStores |
Get /stores |
List all stores |
| OpenFgaApi |
ListUsers |
Post /stores/{store_id}/list-users |
List the users matching the provided filter who have a certain relation to a particular type. |
| OpenFgaApi |
Read |
Post /stores/{store_id}/read |
Get tuples from the store that matches a query, without following userset rewrite rules |
| OpenFgaApi |
ReadAssertions |
Get /stores/{store_id}/assertions/{authorization_model_id} |
Read assertions for an authorization model ID |
| OpenFgaApi |
ReadAuthorizationModel |
Get /stores/{store_id}/authorization-models/{id} |
Return a particular version of an authorization model |
| OpenFgaApi |
ReadAuthorizationModels |
Get /stores/{store_id}/authorization-models |
Return all the authorization models for a particular store |
| OpenFgaApi |
ReadChanges |
Get /stores/{store_id}/changes |
Return a list of all the tuple changes |
| OpenFgaApi |
StreamedListObjects |
Post /stores/{store_id}/streamed-list-objects |
Stream all objects of the given type that the user has a relation with |
| OpenFgaApi |
Write |
Post /stores/{store_id}/write |
Add or delete tuples from the store |
| OpenFgaApi |
WriteAssertions |
Put /stores/{store_id}/assertions/{authorization_model_id} |
Upsert assertions for an authorization model ID |
| OpenFgaApi |
WriteAuthorizationModel |
Post /stores/{store_id}/authorization-models |
Create a new authorization model |
Models
OpenTelemetry
This SDK supports producing metrics that can be consumed as part of an OpenTelemetry setup. For more information, please see the documentation
Contributing
See CONTRIBUTING for details.
Author
OpenFGA
License
This project is licensed under the Apache-2.0 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 go template, licensed under the Apache License 2.0.
This repo bundles some code from the golang.org/x/oauth2 package. You can find the code here and corresponding BSD-3 License.
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)
评论