cfclient

package

Go to main page

Versions in this module

v0

v0.12.0

Jan 12, 2025

Changes in this version

type Client

+ func (client *Client) CreateApiKeyServiceUser(serviceUserId string, apiKey *ApiKey) (string, error)

+ func (client *Client) CreateServiceUser(serviceUserCreateUpdate *ServiceUserCreateUpdate) (*ServiceUser, error)

+ func (client *Client) DeleteAPIKeyServiceUser(keyID string, serviceUserId string) error

+ func (client *Client) DeleteServiceUser(id string) error

+ func (client *Client) GetAPIKeyServiceUser(keyID string, serviceUserId string) (*ApiKey, error)

+ func (client *Client) GetServiceUserByID(id string) (*ServiceUser, error)

+ func (client *Client) GetServiceUserByName(name string) (*ServiceUser, error)

+ func (client *Client) GetServiceUserList() ([]ServiceUser, error)

+ func (client *Client) UpdateAPIKeyServiceUser(key *ApiKey, serviceUserId string) error

+ func (client *Client) UpdateServiceUser(serviceUserCreateUpdate *ServiceUserCreateUpdate) (*ServiceUser, error)

+ type ServiceUser struct

+ ID string

+ Name string

+ Roles []string

+ Teams []ServiceUserTeam

+ func (serviceuser *ServiceUser) GetID() string

+ func (serviceuser *ServiceUser) HasAdminRole() bool

+ type ServiceUserCreateUpdate struct

+ AssignAdminRole bool

+ ID string

+ Name string

+ TeamIDs []string

+ type ServiceUserTeam struct

+ ID string

v0.11.1

Dec 17, 2024

Changes in this version

type Context

+ IsEncrypred bool

type CurrentAccount

+ FeatureFlags map[string]bool

v0.11.0

Sep 17, 2024

v0.10.1

Jul 15, 2024

Changes in this version

type Client

+ func (client *Client) UpdatePermissionTags(permission *Permission) error

v0.10.0

Jun 3, 2024

Changes in this version

type Client

+ func (client *Client) DeleteLocalUserPassword(userName string) error

+ func (client *Client) GetActiveGitopsAccountInfo() (*GitopsActiveAccountInfo, error)

+ func (client *Client) UpdateActiveGitopsAccountSettings(gitProvider string, gitProviderApiUrl string, sharedConfigRepo string) error

+ func (client *Client) UpdateLocalUserPassword(userName, password string) error

+ type GitopsActiveAccountInfo struct

+ AccountName string

+ Admins []string

+ GitApiUrl string

+ GitProvider string

+ ID string

+ SharedConfigRepo string

+ type GitopsActiveAccountResponse struct

+ Data struct{ ... }

+ type PublicProfile struct

+ HasPassword bool

type User

+ PublicProfile PublicProfile

v0.9.0

Mar 26, 2024

Changes in this version

+ type ExternalResource struct

+ Context string

+ Destination string

+ ID string

+ IsFolder bool

+ Repo string

+ Revision string

+ Source string

+ Type string

type Spec

+ ExternalResources []ExternalResource

type Variable

+ Encrypted bool

v0.8.0

Feb 28, 2024

Changes in this version

type Client

+ func (client *Client) CreateIDP(idp *IDP, isGlobal bool) (id string, err error)

+ func (client *Client) DeleteIDP(id string) error

+ func (client *Client) DeleteIDPAccount(id string) error

+ func (client *Client) GetAccountIdpByID(idpID string) (*IDP, error)

+ func (client *Client) UpdateIDP(idp *IDP, isGlobal bool) error

type IDP

+ ActivateUserAfterSync bool

+ AllowedGroupsForSync string

+ ApiClientId string

+ ApiClientSecret string

+ ApplicationCert string

+ AutoGroupSync bool

+ Certificate string

+ DistinguishedName string

+ EntryPoint string

+ Host string

+ KeyFile string

+ Password string

+ Realm string

+ SamlProvider string

+ SearchBase string

+ SearchBaseForSync string

+ SearchFilter string

+ Subject string

+ SyncField string

+ SyncInterval string

+ SyncMirrorAccounts []string

+ Url string

type Spec

+ PermitRestartFromFailedSteps bool

v0.7.0

Jan 29, 2024

Changes in this version

+ func DecodeGraphQLResponseInto(body []byte, target interface{}) error

+ func DecodeResponseInto(body []byte, target interface{}) error

+ func EncodeToJSON(object interface{}) ([]byte, error)

+ func FindInSlice(slice []string, val string) bool

+ func GetAccountAdminsDiff(desiredAdmins []string, existingAdmins []string) (adminsToAdd []string, adminsToDelete []string)

+ func GetUsersDiff(desiredUsers []string, existingUsers []TeamUser) (usersToAdd []string, usersToDelete []string)

+ func ToQS(qs map[string]string) string

+ func UriEncodeEvent(event string) string

+ type Account struct

+ Admins []string

+ AllowedDomains []interface{}

+ BadgeToken string

+ Build *Build

+ BuildStepConfig *BuildStepConfig

+ CFCRState *CFCRState

+ CanUsePrivateRepos bool

+ CfcrRepositoryPath string

+ CodefreshEnv string

+ CreatedAt string

+ DedicatedInfrastructure bool

+ Environment int

+ Features map[string]bool

+ ID string

+ ImageViewConfig *ImageViewConfig

+ IncreasedAttention bool

+ Integrations *Integration

+ Limits *Limits

+ LocalUserPasswordIDPEnabled bool

+ Name string

+ Notifications []NotificationEvent

+ PaymentPlan *PaymentPlan

+ RepoPermission string

+ RuntimeEnvironment string

+ SupportPlan string

+ Suspension *Suspension

+ UpdatedAt string

+ func ToSlimAccount(account Account) Account

+ func ToSlimAccounts(accounts []Account) []Account

+ func (account *Account) GetID() string

+ func (account *Account) SetFeatures(m map[string]interface{})

+ type AccountDetails struct

+ AccountDetails Account

+ type Active struct

+ Active bool

+ type ApiKey struct

+ Created string

+ ID string

+ Name string

+ ScopeSnapshot ApiKeyScopeSnapshot

+ Scopes []string

+ Subject ApiKeySubject

+ TokenPrefix string

+ type ApiKeyScopeSnapshot struct

+ Date string

+ ID string

+ Scopes []string

+ V int

+ type ApiKeySubject struct

+ Ref string

+ Type string

+ type Build struct

+ Nodes int

+ Packs []interface{}

+ Parallel int

+ Strategy string

+ type BuildStepConfig struct

+ AutoPush bool

+ DisablePush bool

+ Version string

+ type CFCRState struct

+ AccountChoice string

+ DisplayGlobalNotice bool

+ Enabled bool

+ System string

+ type Client struct

+ Client *http.Client

+ Host string

+ HostV2 string

+ Token string

+ TokenHeader string

+ func NewClient(hostname string, hostnameV2 string, token string, tokenHeader string) *Client

+ func (client *Client) ActivateUser(userId string) (*User, error)

+ func (client *Client) AddAccountToIDP(accountId, idpId string) error

+ func (client *Client) AddNewUserToAccount(accountId, userName, userEmail string) (*User, error)

+ func (client *Client) AddPendingUser(user *NewUser) (*User, error)

+ func (client *Client) AddUserToTeam(teamID, userID string) error

+ func (client *Client) AddUserToTeamByAdmin(userID string, accountID string, team string) error

+ func (client *Client) CreateAbacRule(gitopsAbacRule *GitopsAbacRule) (*GitopsAbacRule, error)

+ func (client *Client) CreateAccount(account *Account) (*Account, error)

+ func (client *Client) CreateApiKey(userID string, accountId string, apiKey *ApiKey) (string, error)

+ func (client *Client) CreateContext(context *Context) (*Context, error)

+ func (client *Client) CreateHermesTriggerByEventAndPipeline(event string, pipeline string) error

+ func (client *Client) CreateHermesTriggerEvent(event *HermesTriggerEvent) (string, error)

+ func (client *Client) CreatePermission(permission *Permission) (*Permission, error)

+ func (client *Client) CreatePipeline(pipeline *Pipeline) (*Pipeline, error)

+ func (client *Client) CreateProject(project *Project) (*Project, error)

+ func (client *Client) CreateRegistry(registry *Registry) (*Registry, error)

+ func (client *Client) CreateStepTypes(stepTypes *StepTypes) (*StepTypes, error)

+ func (client *Client) CreateTeam(team *Team) (*NewTeam, error)

+ func (client *Client) DeleteAPIKey(keyID string) error

+ func (client *Client) DeleteAbacRule(id string) (*GitopsAbacRule, error)

+ func (client *Client) DeleteAccount(id string) error

+ func (client *Client) DeleteContext(name string) error

+ func (client *Client) DeleteHermesTriggerByEventAndPipeline(event string, pipeline string) error

+ func (client *Client) DeletePermission(id string) error

+ func (client *Client) DeletePipeline(name string) error

+ func (client *Client) DeleteProject(id string) error

+ func (client *Client) DeleteRegistry(name string) error

+ func (client *Client) DeleteStepTypes(name string) error

+ func (client *Client) DeleteTeam(id string) error

+ func (client *Client) DeleteUser(userName string) error

+ func (client *Client) DeleteUserAsAccountAdmin(accountId, userId string) error

+ func (client *Client) DeleteUserFromAccount(accountId, userId string) error

+ func (client *Client) DeleteUserFromTeam(teamID, userID string) error

+ func (client *Client) GenerateToken(xToken string, apiKey *ApiKey) (string, error)

+ func (client *Client) GetAPIKey(keyID string) (*ApiKey, error)

+ func (client *Client) GetAbacRuleByID(id string) (*GitopsAbacRule, error)

+ func (client *Client) GetAbacRulesList(entityType string) ([]GitopsAbacRule, error)

+ func (client *Client) GetAccountByID(id string) (*Account, error)

+ func (client *Client) GetAccountByName(name string) (*Account, error)

+ func (client *Client) GetAccountIDPs() (*[]IDP, error)

+ func (client *Client) GetAccountsList(accountsId []string) (*[]Account, error)

+ func (client *Client) GetAllAccounts() (*[]Account, error)

+ func (client *Client) GetAllUsers() (*[]User, error)

+ func (client *Client) GetApiKeysList() ([]ApiKey, error)

+ func (client *Client) GetContext(name string) (*Context, error)

+ func (client *Client) GetCurrentAccount() (*CurrentAccount, error)

+ func (client *Client) GetHermesTriggerByEventAndPipeline(event string, pipeline string) (*HermesTrigger, error)

+ func (client *Client) GetHermesTriggerEvent(event string) (*HermesTriggerEvent, error)

+ func (client *Client) GetIDPs() (*[]IDP, error)

+ func (client *Client) GetIdpByID(idpID string) (*IDP, error)

+ func (client *Client) GetIdpByName(idpName string) (*IDP, error)

+ func (client *Client) GetPermissionByID(id string) (*Permission, error)

+ func (client *Client) GetPermissionList(teamID, action, resource string) ([]Permission, error)

+ func (client *Client) GetPipeline(name string) (*Pipeline, error)

+ func (client *Client) GetPipelines() (*[]Pipeline, error)

+ func (client *Client) GetProjectByID(id string) (*Project, error)

+ func (client *Client) GetProjectByName(name string) (*Project, error)

+ func (client *Client) GetRegistry(identifier string) (*Registry, error)

+ func (client *Client) GetStepTypes(identifier string) (*StepTypes, error)

+ func (client *Client) GetStepTypesVersions(name string) ([]string, error)

+ func (client *Client) GetTeamByID(id string) (*Team, error)

+ func (client *Client) GetTeamByName(name string) (*Team, error)

+ func (client *Client) GetTeamList() ([]Team, error)

+ func (client *Client) GetUserByID(userId string) (*User, error)

+ func (client *Client) GetXAccessToken(userID string, accountId string) (string, error)

+ func (client *Client) RenameTeam(teamID, name string) error

+ func (client *Client) RequestAPI(opt *RequestOptions) ([]byte, error)

+ func (client *Client) RequestApiXAccessToken(opt *RequestOptions) ([]byte, error)

+ func (client *Client) SendGqlRequest(request GraphQLRequest) ([]byte, error)

+ func (client *Client) SetUserAsAccountAdmin(accountId, userId string) error

+ func (client *Client) SynchronizeClientWithGroup(name, ssoType string, notifications bool) error

+ func (client *Client) UpdateAPIKey(key *ApiKey) error

+ func (client *Client) UpdateAccount(account *Account) (*Account, error)

+ func (client *Client) UpdateContext(context *Context) (*Context, error)

+ func (client *Client) UpdatePipeline(pipeline *Pipeline) (*Pipeline, error)

+ func (client *Client) UpdateProject(project *Project) error

+ func (client *Client) UpdateRegistry(registry *Registry) (*Registry, error)

+ func (client *Client) UpdateStepTypes(stepTypes *StepTypes) (*StepTypes, error)

+ func (client *Client) UpdateUserAccounts(userId string, accounts []Account) error

+ func (client *Client) UpdateUserDetails(accountId, userId, userName, userEmail string) (*User, error)

+ type CodefreshObject interface

+ GetID func() string

+ type Collaborators struct

+ Limit int

+ Used int

+ type Context struct

+ Metadata ContextMetadata

+ Spec ContextSpec

+ Version string

+ func (context *Context) GetID() string

+ type ContextErrorResponse struct

+ Error string

+ Message string

+ Status int

+ type ContextMetadata struct

+ Name string

+ type ContextSpec struct

+ Data map[string]interface{}

+ Type string

+ type Credentials struct

+ Permissions []string

+ type CronTrigger struct

+ Branch string

+ Disabled bool

+ Expression string

+ GitTriggerId string

+ Message string

+ Name string

+ Options *TriggerOptions

+ RuntimeEnvironment *RuntimeEnvironment

+ Type string

+ Variables []Variable

+ func (t *CronTrigger) SetVariables(variables map[string]interface{})

+ type CurrentAccount struct

+ Admins []CurrentAccountUser

+ ID string

+ Name string

+ Users []CurrentAccountUser

+ type CurrentAccountUser struct

+ Email string

+ ID string

+ Status string

+ UserName string

+ type DataRetention struct

+ Weeks int

+ type DockerRegistry struct

+ BehindFirewall bool

+ Default bool

+ DenyCompositeDomain bool

+ Domain string

+ ID string

+ Internal bool

+ Kind string

+ Name string

+ Password string

+ Primary bool

+ Provider string

+ RepositoryPrefix string

+ Username string

+ type EntityAbacAttribute struct

+ Key string

+ Name string

+ Value string

+ type ErrorResponse struct

+ Error string

+ Message string

+ Status int

+ type EventData struct

+ Account string

+ Kind string

+ Secret string

+ Type string

+ Uri string

+ type Exist struct

+ Exist bool

+ type GitopsAbacRule struct

+ AccountId string

+ Actions []string

+ Attributes []EntityAbacAttribute

+ EntityType string

+ ID string

+ Tags []string

+ Teams []string

+ type GitopsAbacRuleResponse struct

+ Data struct{ ... }

+ type GitopsAbacRulesListResponse struct

+ Data struct{ ... }

+ type GraphQLRequest struct

+ Query string

+ Variables map[string]interface{}

+ type HermesTrigger struct

+ Event string

+ EventData EventData

+ PipelineID string

+ type HermesTriggerEvent struct

+ Filter string

+ Kind string

+ Secret string

+ Type string

+ Values map[string]string

+ type Hooks struct

+ Hooks string

+ func (d *Hooks) UnmarshalJSON(data []byte) error

+ func (d Hooks) MarshalJSON() ([]byte, error)

+ type IDP struct

+ Access_token string

+ Accounts []string

+ ApiHost string

+ ApiPathPrefix string

+ ApiURL string

+ AppId string

+ AuthURL string

+ ClientHost string

+ ClientId string

+ ClientName string

+ ClientSecret string

+ ClientType string

+ CookieIv string

+ CookieKey string

+ DisplayName string

+ ID string

+ IDPLoginUrl string

+ LoginUrl string

+ RedirectUiUrl string

+ RedirectUrl string

+ RefreshTokenURL string

+ Scopes []string

+ Tenant string

+ TokenSecret string

+ TokenURL string

+ UserProfileURL string

+ type ImageViewConfig struct

+ Version string

+ type Integration struct

+ Aks Exist

+ DigitalOcean Exist

+ Gcloud Exist

+ Github Active

+ Gitlab Active

+ Registries []DockerRegistry

+ Stash Active

+ type Labels struct

+ Tags []string

+ type Limits struct

+ Collaborators Collaborators

+ DataRetention DataRetention

+ type Login struct

+ Credentials Credentials

+ IDP IDP

+ Idp_ID string

+ Permissions []string

+ PersonalGit bool

+ Sso bool

+ type Metadata struct

+ ID string

+ IsPublic bool

+ Labels Labels

+ Name string

+ OriginalYamlString string

+ Project string

+ ProjectId string

+ Revision int

+ type NewPermission struct

+ Account string

+ Action string

+ ID string

+ RelatedResource string

+ Resource string

+ Tags []string

+ Team string

+ type NewTeam struct

+ Account string

+ ID string

+ Name string

+ Tags []string

+ Type string

+ Users []string

+ func ConvertToNewTeam(team *Team) *NewTeam

+ type NewUser struct

+ Account []string

+ Email string

+ ID string

+ Logins []Login

+ Personal *Personal

+ Roles []string

+ UserName string

+ type NotificationEvent struct

+ Events []string

+ Type string

+ type PaymentPlan struct

+ ID string

+ Provider string

+ Trial struct{ ... }

+ type Permission struct

+ Account string

+ Action string

+ ID string

+ RelatedResource string

+ Resource string

+ Tags []string

+ Team string

+ type Personal struct

+ CompanyName string

+ Country string

+ FirstName string

+ LastName string

+ PhoneNumber string

+ type Pipeline struct

+ Metadata Metadata

+ Spec Spec

+ Version string

+ func (p *Pipeline) SetVariables(variables map[string]interface{})

+ func (pipeline *Pipeline) GetID() string

+ type Pipelines struct

+ Count int

+ Docs []Pipeline

+ type Project struct

+ ID string

+ ProjectName string

+ Tags []string

+ Variables []Variable

+ func (project *Project) GetID() string

+ func (project *Project) SetVariables(variables map[string]interface{})

+ type Registry struct

+ AccessKeyId string

+ BehindFirewall bool

+ ClientId string

+ ClientSecret string

+ Default bool

+ Domain string

+ FallbackRegistry string

+ Id string

+ Keyfile string

+ Kind string

+ Name string

+ Password string

+ Primary bool

+ Provider string

+ Region string

+ RepositoryPrefix string

+ SecretAccessKey string

+ Token string

+ Username string

+ func (registry *Registry) GetID() string

+ type RequestOptions struct

+ Body []byte

+ Method string

+ Path string

+ QS map[string]string

+ XAccessToken string

+ type RuntimeEnvironment struct

+ CPU string

+ DindStorage string

+ Memory string

+ Name string

+ RequiredAvailableStorage string

+ type ShortProfile struct

+ UserName string

+ type Spec struct

+ BranchConcurrency int

+ Concurrency int

+ Contexts []interface{}

+ CronTriggers []CronTrigger

+ FailFast *bool

+ Hooks *Hooks

+ Mode string

+ Options map[string]bool

+ PackId string

+ Priority int

+ RequiredAvailableStorage string

+ RuntimeEnvironment RuntimeEnvironment

+ SpecTemplate *SpecTemplate

+ Stages *Stages

+ Steps *Steps

+ TerminationPolicy []map[string]interface{}

+ TriggerConcurrency int

+ Triggers []Trigger

+ Variables []Variable

+ type SpecStepTypes struct

+ Arguments string

+ Delimiters map[string]interface{}

+ Returns string

+ Steps *orderedmap.OrderedMap

+ StepsTemplate string

+ type SpecTemplate struct

+ Context string

+ Location string

+ Path string

+ Repo string

+ Revision string

+ type Stages struct

+ Stages string

+ func (d *Stages) UnmarshalJSON(data []byte) error

+ func (d Stages) MarshalJSON() ([]byte, error)

+ type StepTypes struct

+ Kind string

+ Metadata map[string]interface{}

+ Spec SpecStepTypes

+ Version string

+ func (stepTypes *StepTypes) GetID() string

+ type StepTypesVersion struct

+ StepTypes StepTypes

+ VersionNumber string

+ type StepTypesVersions struct

+ Name string

+ Versions []StepTypesVersion

+ type Steps struct

+ Steps string

+ func (d *Steps) UnmarshalJSON(data []byte) error

+ func (d Steps) MarshalJSON() ([]byte, error)

+ type Suspension struct

+ IsSuspended bool

+ type Team struct

+ Account string

+ ID string

+ Name string

+ Tags []string

+ Type string

+ Users []TeamUser

+ func (team *Team) GetID() string

+ type TeamUser struct

+ Email string

+ ID string

+ UserName string

+ type TokenResponse struct

+ AccessToken string

+ User struct{ ... }

+ type Trigger struct

+ BranchRegex string

+ BranchRegexInput string

+ CommentRegex string

+ CommitStatusTitle string

+ Context string

+ Contexts []string

+ Description string

+ Disabled bool

+ Events []string

+ ModifiedFilesGlob string

+ Name string

+ Options *TriggerOptions

+ Provider string

+ PullRequestAllowForkEvents bool

+ PullRequestTargetBranchRegex string

+ Repo string

+ RuntimeEnvironment *RuntimeEnvironment

+ Type string

+ Variables []Variable

+ func (t *Trigger) SetVariables(variables map[string]interface{})

+ type TriggerOptions struct

+ EnableNotifications bool

+ NoCache bool

+ NoCfCache bool

+ ResetVolume bool

+ type User struct

+ Account []Account

+ DefaultAccount int

+ Email string

+ HasPassword bool

+ ID string

+ InviteURL string

+ Logins []Login

+ Notifications []NotificationEvent

+ Personal *Personal

+ RegisterDate string

+ Roles []string

+ ShortProfile ShortProfile

+ Status string

+ UserName string

+ type UserAccounts struct

+ Account []Account

+ UserName string

+ type Variable struct

+ Key string

+ Value string

v0.7.0-beta-1

Oct 17, 2023

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL