client

Documentation

Index

• type ConnectionOption
  • func WithAPIKeyAuth(key string) ConnectionOption
  • func WithAddr(addr string) ConnectionOption
  • func WithCACertPath(path string) ConnectionOption
  • func WithInsecure() ConnectionOption
  • func WithTenantID(tenantID string) ConnectionOption
  • func WithTokenAuth(token string) ConnectionOption
• type ConnectionOptions
  • func NewConnectionOptions(opts ...ConnectionOption) *ConnectionOptions

Types

type ConnectionOption

type ConnectionOption func(*ConnectionOptions)

ConnecionOption functions are used to configure ConnectionOptions instances.

func WithAPIKeyAuth

func WithAPIKeyAuth(key string) ConnectionOption

WithAPIKeyAuth uses an Aserto API key to authenticate with the authorizer service.

func WithAddr

func WithAddr(addr string) ConnectionOption

WithAddr overrides the default authorizer server address.

If not specified, Aserto's hosted authorizer at authorizer.prod.aserto.com is used.

func WithCACertPath

func WithCACertPath(path string) ConnectionOption

WithCACertPath treats the specified certificate file as a trusted root CA.

Include it when calling an authorizer service that uses a self-issued SSL certificate.

func WithInsecure

func WithInsecure() ConnectionOption

WithInsecure disables TLS verification.

func WithTenantID

func WithTenantID(tenantID string) ConnectionOption

WithTenantID sets the asserto tenant ID.

func WithTokenAuth

func WithTokenAuth(token string) ConnectionOption

WithTokenAuth uses an OAuth2.0 token to authenticate with the authorizer service.

type ConnectionOptions

type ConnectionOptions struct {
	// The server's host name and port separated by a colon ("hostname:port").
	Address string

	// Path to a CA certificate file to treat as a root CA for TLS verification.
	CACertPath string

	// The tenant ID of your aserto account.
	TenantID string

	// Credentials used to authenticate with the authorizer service. Either API Key or OAuth Token.
	Creds credentials.PerRPCCredentials

	// If true, skip TLS certificate verification.
	Insecure bool
}

ConnectionOptions holds settings used to establish a connection to the authorizer service.

func NewConnectionOptions

func NewConnectionOptions(opts ...ConnectionOption) *ConnectionOptions

NewConnectionOptions creates a ConnectionOptions object from a collection of ConnectionOption functions.