policy

Documentation

Index

• type BearerTokenOptions
• type ClientOptions
  • func (o *ClientOptions) Clone() *ClientOptions
• type RegistrationOptions

Types

type BearerTokenOptions

type BearerTokenOptions struct {
	// AuxiliaryTenants are additional tenant IDs for authenticating cross-tenant requests.
	// The policy will add a token from each of these tenants to every request. The
	// authenticating user or service principal must be a guest in these tenants, and the
	// policy's credential must support multitenant authentication.
	AuxiliaryTenants []string

	// InsecureAllowCredentialWithHTTP enables authenticated requests over HTTP.
	// By default, authenticated requests to an HTTP endpoint are rejected by the client.
	// WARNING: setting this to true will allow sending the authentication key in clear text. Use with caution.
	InsecureAllowCredentialWithHTTP bool

	// Scopes contains the list of permission scopes required for the token.
	Scopes []string
}

BearerTokenOptions configures the bearer token policy's behavior.

type ClientOptions

type ClientOptions struct {
	policy.ClientOptions

	// AuxiliaryTenants are additional tenant IDs for authenticating cross-tenant requests.
	// The client will add a token from each of these tenants to every request. The
	// authenticating user or service principal must be a guest in these tenants, and the
	// client's credential must support multitenant authentication.
	AuxiliaryTenants []string

	// DisableRPRegistration disables the auto-RP registration policy. Defaults to false.
	DisableRPRegistration bool
}

ClientOptions contains configuration settings for a client's pipeline.

func (*ClientOptions) Clone

func (o *ClientOptions) Clone() *ClientOptions

Clone return a deep copy of the current options.

type RegistrationOptions

type RegistrationOptions struct {
	policy.ClientOptions

	// MaxAttempts is the total number of times to attempt automatic registration
	// in the event that an attempt fails.
	// The default value is 3.
	// Set to a value less than zero to disable the policy.
	MaxAttempts int

	// PollingDelay is the amount of time to sleep between polling intervals.
	// The default value is 15 seconds.
	// A value less than zero means no delay between polling intervals (not recommended).
	PollingDelay time.Duration

	// PollingDuration is the amount of time to wait before abandoning polling.
	// The default valule is 5 minutes.
	// NOTE: Setting this to a small value might cause the policy to prematurely fail.
	PollingDuration time.Duration

	// StatusCodes contains the slice of custom HTTP status codes to use instead
	// of the default http.StatusConflict. This should only be set if a service
	// returns a non-standard HTTP status code when unregistered.
	StatusCodes []int
}

RegistrationOptions configures the registration policy's behavior. All zero-value fields will be initialized with their default values.