Summary

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Retries
• Pagination
• Development
  • Maturity
  • Contributions

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/unkeyed/unkey-go

SDK Example Usage

Example

package main

import (
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"log"
)

func main() {
	s := unkeygo.New(
		unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
	)

	ctx := context.Background()
	res, err := s.Liveness.V1Liveness(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

Apis

• GetAPI
• CreateAPI
• ListKeys
• DeleteAPI
• DeleteKeys

Identities

• CreateIdentity
• GetIdentity
• ListIdentities
• UpdateIdentity
• DeleteIdentity

Keys

• GetKey
• Whoami
• DeleteKey
• CreateKey
• VerifyKey
• UpdateKey
• UpdateRemaining
• GetVerifications
• AddPermissions
• RemovePermissions
• SetPermissions
• AddRoles
• RemoveRoles
• SetRoles

Liveness

• V1Liveness

Migrations

• V1MigrationsCreateKeys
• V1MigrationsEnqueueKeys

Permissions

• CreatePermission
• DeletePermission
• GetPermission
• ListPermissions
• CreateRole
• DeleteRole
• GetRole
• ListRoles

Ratelimit

• RatelimitSetOverride
• ListOverrides
• GetOverride

Ratelimits

• Limit
• DeleteOverride

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return sdkerrors.SDKError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the V1Liveness function may return the following errors:

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Example

package main

import (
	"context"
	"errors"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/sdkerrors"
	"log"
)

func main() {
	s := unkeygo.New(
		unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
	)

	ctx := context.Background()
	res, err := s.Liveness.V1Liveness(ctx)
	if err != nil {

		var e *sdkerrors.ErrBadRequest
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.ErrUnauthorized
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.ErrForbidden
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.ErrNotFound
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.ErrConflict
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.ErrTooManyRequests
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.ErrInternalServerError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}

		var e *sdkerrors.SDKError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"log"
)

func main() {
	s := unkeygo.New(
		unkeygo.WithServerURL("https://api.unkey.dev"),
		unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
	)

	ctx := context.Background()
	res, err := s.Liveness.V1Liveness(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
BearerAuth	http	HTTP Bearer

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"log"
)

func main() {
	s := unkeygo.New(
		unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
	)

	ctx := context.Background()
	res, err := s.Liveness.V1Liveness(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/retry"
	"log"
	"models/operations"
)

func main() {
	s := unkeygo.New(
		unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
	)

	ctx := context.Background()
	res, err := s.Liveness.V1Liveness(ctx, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/retry"
	"log"
)

func main() {
	s := unkeygo.New(
		unkeygo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
	)

	ctx := context.Background()
	res, err := s.Liveness.V1Liveness(ctx)
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

package main

import (
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
	s := unkeygo.New(
		unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
	)

	ctx := context.Background()
	res, err := s.Identities.ListIdentities(ctx, operations.ListIdentitiesRequest{
		Limit: unkeygo.Int64(100),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		for {
			// handle items

			res, err = res.Next()

			if err != nil {
				// handle error
			}

			if res == nil {
				break
			}
		}
	}
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!