sdk

package
v0.4.22 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 30, 2025 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Index

Constants

View Source 
const ClientIdGolangSDK = "2RCzHlak5q7CY14SdBc8HoZEJRf"

Variables

View Source 
var (
	ErrInvalidClientSecret = errors.New("invalid client secret")
	ErrInvalidClientID     = errors.New("invalid client id")
)
View Source 
var ServerList = []string{

	"https://{tenantDomain}.conductor.one",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool 

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32 

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64 

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int 

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64 

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func NewStaticTokenSource added in v0.4.19 

func NewStaticTokenSource(ctx context.Context, token string) oauth2.TokenSource

func NewTokenSource 

func NewTokenSource(ctx context.Context, clientID string, clientSecret string, tokenHost string) (oauth2.TokenSource, error)

func String 

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type AWSExternalIDSettings 

type AWSExternalIDSettings struct {
	// contains filtered or unexported fields
}

func (*AWSExternalIDSettings) Get 

func (s *AWSExternalIDSettings) Get(ctx context.Context) (*operations.C1APISettingsV1AWSExternalIDSettingsGetResponse, error)

Get Invokes the c1.api.settings.v1.AWSExternalIDSettings.Get method.

type ClientConfig 

type ClientConfig struct {
	// contains filtered or unexported fields
}

func NormalizeTenant 

func NormalizeTenant(input string) (*ClientConfig, error)

func ParseClientID 

func ParseClientID(input string) (*ClientConfig, error)

func (*ClientConfig) GetServerURL 

func (c *ClientConfig) GetServerURL() string

GetServerURL returns the server URL. If serverURL is empty (""), it constructs the server URL using the tenant. However, if the tenant is also empty, then it will return an empty string.

func (*ClientConfig) ServerURL 

func (c *ClientConfig) ServerURL() string

ServerURL returns the server URL.

func (*ClientConfig) SetServerURL 

func (c *ClientConfig) SetServerURL(serverURL string) error

func (*ClientConfig) SetTenant 

func (c *ClientConfig) SetTenant(tenant string) error

func (*ClientConfig) Tenant 

func (c *ClientConfig) Tenant() string

func (*ClientConfig) UseWithServer 

func (c *ClientConfig) UseWithServer() bool

func (*ClientConfig) UseWithTenant 

func (c *ClientConfig) UseWithTenant() bool

type ClientCredentials 

type ClientCredentials struct {
	ClientID     string
	ClientSecret string
}

func LoginFlow 

func LoginFlow(
	ctx context.Context,
	tenantName string,
	clientID string,
	personalClientCredentialDisplayName string,
	cb func(validateUrl string) error,
) (*ClientCredentials, error)

type ConductoroneAPI 

type ConductoroneAPI struct {
	AppEntitlementOwners      *appEntitlementOwners
	AppEntitlementUserBinding *appEntitlementUserBinding
	AppEntitlements           *appEntitlements
	AppEntitlementsProxy      *appEntitlementsProxy
	AppOwners                 *appOwners
	AppReport                 *appReport
	AppReportAction           *appReportAction
	AppResource               *appResource
	AppResourceOwners         *appResourceOwners
	AppResourceSearch         *appResourceSearch
	AppResourceType           *appResourceType
	AppSearch                 *appSearch
	AppEntitlementSearch      *appEntitlementSearch
	AppUsageControls          *appUsageControls
	Apps                      *apps
	Attributes                *attributes
	AttributeSearch           *attributeSearch
	Auth                      *auth
	AWSExternalIDSettings     *AWSExternalIDSettings
	Connector                 *connector
	Directory                 *directory
	PersonalClient            *personalClient
	Policies                  *policies
	PolicySearch              *policySearch
	RequestCatalogManagement  *requestCatalogManagement
	RequestCatalogSearch      *requestCatalogSearch
	Roles                     *roles
	Task                      *task
	TaskActions               *taskActions
	TaskSearch                *taskSearch
	User                      *user
	UserSearch                *userSearch
	Webhooks                  *webhooks
	WebhooksSearch            *webhooksSearch
	// contains filtered or unexported fields
}

ConductoroneAPI - ConductorOne API: The ConductorOne API is a HTTP API for managing ConductorOne resources.

func New 

func New(opts ...SDKOption) *ConductoroneAPI

New creates a new instance of the SDK with the provided options

func NewWithCredentials 

func NewWithCredentials(ctx context.Context, cred *ClientCredentials, opts ...CustomSDKOption) (*ConductoroneAPI, error)

type CustomOptions 

type CustomOptions struct {
	*ClientConfig
	// contains filtered or unexported fields
}

type CustomSDKOption 

type CustomSDKOption func(*CustomOptions)

func WithLog 

func WithLog(logger *zap.Logger) CustomSDKOption

func WithTLSConfig 

func WithTLSConfig(tlsConfig *tls.Config) CustomSDKOption

func WithTenantCustom 

func WithTenantCustom(input string) (CustomSDKOption, error)

func WithUserAgent 

func WithUserAgent(userAgent string) CustomSDKOption

type DeviceCodeResponse 

type DeviceCodeResponse struct {
	DeviceCode      string `json:"device_code"`
	UserCode        string `json:"user_code"`
	VerificationURI string `json:"verification_uri_complete"`
	ExpiresIn       int64  `json:"expires_in"`
	Interval        int64  `json:"interval"`
}

type HTTPClient 

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

HTTPClient provides an interface for suplying the SDK with a custom HTTP client

type SDKOption 

type SDKOption func(*ConductoroneAPI)

func WithClient 

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithServerIndex 

func WithServerIndex(serverIndex int) SDKOption

WithServerIndex allows the overriding of the default server by index

func WithServerURL 

func WithServerURL(serverURL string) SDKOption

WithServerURL allows the overriding of the default server URL

func WithTemplatedServerURL 

func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

func WithTenant 

func WithTenant(input string) (SDKOption, error)

func WithTenantDomain 

func WithTenantDomain(tenantDomain string) SDKOption

WithTenantDomain allows setting the $name variable for url substitution

Source Files

View all Source files

Directories

Path Synopsis
pkg
models/errors
models/operations
models/shared
retry
types
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.