https://github.com/warrant-dev/warrant-go
Go SDK for Warrant
https://github.com/warrant-dev/warrant-go
abac access-control acl attribute-based-access-control authorization authz go golang permissions rbac role-based-access-control
Last synced: 3 months ago
JSON representation
Go SDK for Warrant
- Host: GitHub
- URL: https://github.com/warrant-dev/warrant-go
- Owner: warrant-dev
- License: mit
- Created: 2021-06-23T00:11:13.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T08:42:21.000Z (7 months ago)
- Last Synced: 2025-04-13T21:14:08.519Z (3 months ago)
- Topics: abac, access-control, acl, attribute-based-access-control, authorization, authz, go, golang, permissions, rbac, role-based-access-control
- Language: Go
- Homepage:
- Size: 3.25 MB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Warrant Go Library
Use [Warrant](https://warrant.dev/) in server-side Go projects.
## Installation
```shell
go get github.com/warrant-dev/warrant-go/v6
```
## Usage
You can use the Warrant SDK with or without a client. Instantiating a client allows you to create different client instances each with their own config (API key, API endpoint, etc).
### Without a Client
```go
import "github.com/warrant-dev/warrant-go/v6"
// Setup
warrant.ApiKey = "api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E="
// Create warrant
warrant, err := warrant.Create(&warrant.WarrantParams{})
// Create tenant
tenant, err := tenant.Create(&tenant.TenantParams{})
```
### With a Client
Instantiate the Warrant client with your API key to get started:
```go
import "github.com/warrant-dev/warrant-go/v6"
import "github.com/warrant-dev/warrant-go/v6/config"
client := warrant.NewClient(config.ClientConfig{
ApiKey: "api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E=",
ApiEndpoint: "https://api.warrant.dev",
AuthorizeEndpoint: "https://api.warrant.dev",
SelfServiceDashEndpoint: "https://self-serve.warrant.dev",
})
```
## Configuring Endpoints
The API, Authorize, Self-Service endpoints and http client are configurable via the `warrant.ApiEndpoint`, `warrant.AuthorizeEndpoint`, `warrant.SelfServiceDashEndpoint`, and `warrant.HttpClient` attributes:
```go
import "github.com/warrant-dev/warrant-go/v6"
import "github.com/warrant-dev/warrant-go/v6/config"
// Without client initialization
// Set api and authorize endpoints to http://localhost:8000
// Set http client to a http.Client instance returned by yourHttpClient()
warrant.ApiEndpoint = "http://localhost:8000"
warrant.AuthorizeEndpoint = "http://localhost:8000"
warrant.HttpClient = yourHttpClient()
// With client initialization
// Set api and authorize endpoints to http://localhost:8000 and self-service endpoint to http://localhost:8080
// Set http client to a http.Client instance returned by yourHttpClient()
client := warrant.NewClient(config.ClientConfig{
ApiKey: "api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E=",
ApiEndpoint: "http://localhost:8000",
AuthorizeEndpoint: "http://localhost:8000",
SelfServiceDashEndpoint: "http://localhost:8080",
HttpClient: yourHttpClient(),
})
```
## Examples
### Users
```go
// Create
createdUser, err := user.Create(&warrant.UserParams{
UserId: "userId",
})
// Get
user, err := user.Get("userId")
// Delete
err = user.Delete("userId")
```
### Warrants
```go
// Create
createdWarrant, err := warrant.Create(&warrant.WarrantParams{
ObjectType: "tenant",
ObjectId: "1",
Relation: "member",
Subject: warrant.Subject{
ObjectType: "user",
ObjectId: "1",
},
})
// Delete
err = warrant.Delete(&warrant.WarrantParams{
ObjectType: "tenant",
ObjectId: "1",
Relation: "member",
Subject: warrant.Subject{
ObjectType: "user",
ObjectId: "1",
},
})
// Check access
isAuthorized, err := warrant.Check(&warrant.WarrantCheckParams{
Object: warrant.Object{
ObjectType: "tenant",
ObjectId: "1",
},
Relation: "member",
Subject: warrant.Subject{
ObjectType: "user",
ObjectId: "1",
},
})
```
We’ve used a random API key in these code examples. Replace it with your
[actual publishable API keys](https://app.warrant.dev) to
test this code through your own Warrant account.
For more information on how to use the Warrant API, please refer to the
[Warrant API reference](https://docs.warrant.dev).
Note that we may release new [minor and patch](https://semver.org/) versions of this library with small but backwards-incompatible fixes to the type declarations. These changes will not affect Warrant itself.
## Warrant Documentation
- [Warrant Docs](https://docs.warrant.dev/)