provider_client.go

package gophercloud

// ProviderClient stores details that are required to interact with any services within a specific provider's API.
//
// Generally, you acquire a ProviderClient by calling the `NewClient()` method in the appropriate provider's child package,
// providing whatever authentication credentials are required.
type ProviderClient struct {

	// IdentityEndpoint is the front door to an openstack provider.
	// Generally this will be populated when you authenticate.
	// It should be the *root* resource of the identity service, not of a specific identity version.
	IdentityEndpoint string

	// Reauthenticate is a callback that will be invoked to reauthenticate this client, if reauthentication is enabled.
	Reauthenticate func() error

	// TokenID is the most recently valid token issued.
	TokenID string

	// EndpointLocator describes how this provider discovers the endpoints for its constituent services.
	EndpointLocator EndpointLocator
}

// AuthenticatedHeaders returns a map of HTTP headers that are common for all authenticated service requests.
func (client *ProviderClient) AuthenticatedHeaders() map[string]string {
	return map[string]string{"X-Auth-Token": client.TokenID}
}