securden_sdk

package module
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2025 License: MIT Imports: 22 Imported by: 0

README

Securden Software Development Kit

This guide will take you through the process of installing and integrating Securden Go SDK for secure programmatic access to credentials.

Summary of Steps

  1. Installation
  2. Importing the SDK into your codebase
  3. Configuring access to Securden server

1. Installation

go get github.com/SecurdenDevOps/securden-sdk

2. Importing the SDK into your codebase

import (
	securden "github.com/SecurdenDevOps/securden-sdk"
)

3. Configuring access to Securden server

Required
BaseURL := "<server-url>"
cfg := securden.NewConfiguration(BaseURL)
cfg.SetAuthToken("<authtoken>")
err := cfg.SetSSLConfig()

client := securden.NewAPIClient(cfg)

-> If you have general questions or issues in using Securden CLI, you may raise a support request to devops-support@securden.com. Our support team will get back to you at the earliest and provide a timeline if there are issue fixes involved.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	DefaultAPI          *DefaultAPIService
	WorkAccountType     int
	PersonalAccountType int
	// contains filtered or unexported fields
}

APIClient manages communication with the Password Retrieval API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiGetPasswordGetRequest 

type ApiGetPasswordGetRequest struct {
	ApiService *DefaultAPIService
	// contains filtered or unexported fields
}

func (ApiGetPasswordGetRequest) AccountCategory 

func (r ApiGetPasswordGetRequest) AccountCategory(accountCategory int) ApiGetPasswordGetRequest

func (ApiGetPasswordGetRequest) AccountId 

func (r ApiGetPasswordGetRequest) AccountId(accountId int64) ApiGetPasswordGetRequest

func (ApiGetPasswordGetRequest) AccountName 

func (r ApiGetPasswordGetRequest) AccountName(accountName string) ApiGetPasswordGetRequest

func (ApiGetPasswordGetRequest) AccountTitle 

func (r ApiGetPasswordGetRequest) AccountTitle(accountTitle string) ApiGetPasswordGetRequest

func (ApiGetPasswordGetRequest) AccountType 

func (r ApiGetPasswordGetRequest) AccountType(accountType string) ApiGetPasswordGetRequest

func (ApiGetPasswordGetRequest) Execute 

func (r ApiGetPasswordGetRequest) Execute() (GetPasswordGet200Response, string, error)

func (ApiGetPasswordGetRequest) Reason 

func (r ApiGetPasswordGetRequest) Reason(reason string) ApiGetPasswordGetRequest

func (ApiGetPasswordGetRequest) TicketId 

func (r ApiGetPasswordGetRequest) TicketId(ticketId string) ApiGetPasswordGetRequest

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host               string            `json:"host,omitempty"`
	Scheme             string            `json:"scheme,omitempty"`
	BaseUrl            string            `json:"baseUrl,omitempty"`
	DefaultHeader      map[string]string `json:"defaultHeader,omitempty"`
	UserAgent          string            `json:"userAgent,omitempty"`
	Debug              bool              `json:"debug,omitempty"`
	AuthToken          string            `json:"authtoken,omitempty"`
	SSLCert            string            `json:"sslCert,omitempty"`
	InsecureSkipVerify bool              `json:"insecureSkipVerify,omitempty"`
	Servers            ServerConfigurations
	OperationServers   map[string]ServerConfigurations
	HTTPClient         *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration(baseURL string) *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

func (*Configuration) SetAuthToken 

func (c *Configuration) SetAuthToken(token string)

func (*Configuration) SetSSLConfig 

func (c *Configuration) SetSSLConfig() error

type DefaultAPIService 

type DefaultAPIService service

DefaultAPIService DefaultAPI service

func (*DefaultAPIService) GetPassword 

func (a *DefaultAPIService) GetPassword(ctx context.Context) ApiGetPasswordGetRequest

GetPasswordGet Retrieves password information 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetPasswordGetRequest

func (*DefaultAPIService) GetPasswordGetExecute 

func (a *DefaultAPIService) GetPasswordGetExecute(r ApiGetPasswordGetRequest) (GetPasswordGet200Response, string, error)

Execute executes the request 

@return GetPasswordGet200Response

type GenericOpenAPIError 

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetPasswordGet200Response 

type GetPasswordGet200Response struct {
	Password string `json:"password,omitempty"`
}

GetPasswordGet200Response struct for GetPasswordGet200Response

func NewGetPasswordGet200Response 

func NewGetPasswordGet200Response() *GetPasswordGet200Response

NewGetPasswordGet200Response instantiates a new GetPasswordGet200Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGetPasswordGet200ResponseWithDefaults 

func NewGetPasswordGet200ResponseWithDefaults() *GetPasswordGet200Response

NewGetPasswordGet200ResponseWithDefaults instantiates a new GetPasswordGet200Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GetPasswordGet200Response) GetPassword 

func (o *GetPasswordGet200Response) GetPassword() string

GetPassword returns the Password field value

func (GetPasswordGet200Response) MarshalJSON 

func (o GetPasswordGet200Response) MarshalJSON() ([]byte, error)

func (*GetPasswordGet200Response) SetPassword 

func (o *GetPasswordGet200Response) SetPassword(v string)

SetPassword sets the Password field value

func (GetPasswordGet200Response) ToMap 

func (o GetPasswordGet200Response) ToMap() (map[string]interface{}, error)

type MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableFloat32 

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

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

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

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableGetPasswordGet200Response 

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

func NewNullableGetPasswordGet200Response 

func NewNullableGetPasswordGet200Response(val *GetPasswordGet200Response) *NullableGetPasswordGet200Response

func (NullableGetPasswordGet200Response) Get 

func (v NullableGetPasswordGet200Response) Get() *GetPasswordGet200Response

func (NullableGetPasswordGet200Response) IsSet 

func (v NullableGetPasswordGet200Response) IsSet() bool

func (NullableGetPasswordGet200Response) MarshalJSON 

func (v NullableGetPasswordGet200Response) MarshalJSON() ([]byte, error)

func (*NullableGetPasswordGet200Response) Set 

func (v *NullableGetPasswordGet200Response) Set(val *GetPasswordGet200Response)

func (*NullableGetPasswordGet200Response) UnmarshalJSON 

func (v *NullableGetPasswordGet200Response) UnmarshalJSON(src []byte) error

func (*NullableGetPasswordGet200Response) Unset 

func (v *NullableGetPasswordGet200Response) Unset()

type NullableInt 

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

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

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

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

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

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableString 

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

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

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

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

Source Files

View all Source files

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.