common

package

v1.3.1 Latest Latest Go to latest Published: Aug 14, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cyberark/ark-sdk-golang

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CheckIfIdentityGeneratedSuffix(tenantSuffix string, env AwsEnv) bool
func IsGovCloud() bool
type ArkRFC3339Time
- func (ct *ArkRFC3339Time) MarshalJSON() ([]byte, error)
- func (ct *ArkRFC3339Time) UnmarshalJSON(data []byte) error
type AwsEnv
- func GetDeployEnv() AwsEnv

Constants ¶

View Source

const (
	AppCodeSIA  = "SIA"
	AppCodeDPA  = "DPA"
	AppCodeCSM  = "CSM"
	AppCodePAM  = "PAM"
	AppCodeDAP  = "DAP"
	AppCodeITI  = "ITI"
	AppCodeUBA  = "UBA"
	AppCodeADM  = "ADM"
	AppCodeAUD  = "AUD"
	AppCodeALR  = "ALR"
	AppCodeCEM  = "CEM"
	AppCodeEPM  = "EPM"
	AppCodeSCA  = "SCA"
	AppCodeSHSM = "SHSM"
	AppCodeCLO  = "CLO"
	AppCodeCMS  = "CMS"
	AppCodeSMS  = "SMS"
	AppCodePYC  = "PYC"
	AppCodeARS  = "ARS"
	AppCodeIDP  = "IDP"
	AppCodeITDR = "ITDR"
	AppCodeINTS = "INTS"
	AppCodeMSP  = "MSP"
	AppCodeCCE  = "CCE"
)

Application codes for sessions.

View Source

const (
	CategoryTypeCloudConsole = "Cloud console"
	CategoryTypeVM           = "VM"
	CategoryTypeDB           = "DB"
)

ArkCategoryType represents the type of category in Ark.

View Source

const (
	ConnectionMethodStanding = "standing"
	ConnectionMethodDynamic  = "dynamic"
)

Possible connection methods.

View Source

const (
	DeployEnv          = "DEPLOY_ENV"
	IdentityTenantName = "isp"
)

Constants for environment variables and tenant names.

View Source

const (
	OSTypeWindows = "windows"
	OSTypeDarwin  = "darwin"
	OSTypeLinux   = "linux"
)

Possible operating systems

View Source

const (
	ProtocolTypeSSH     = "SSH"
	ProtocolTypeRDP     = "RDP"
	ProtocolTypeCLI     = "CLI"
	ProtocolTypeCONSOLE = "CONSOLE"
	ProtocolTypeHTTPS   = "HTTPS"
	ProtocolTypeK8S     = "K8S"
	ProtocolTypeDB      = "DB"
)

Protocol types for sessions.

View Source

const (
	WorkspaceTypeAWS    = "AWS"
	WorkspaceTypeAzure  = "AZURE"
	WorkspaceTypeOnPrem = "ON-PREMISE"
	WorkspaceTypeGCP    = "GCP"
	WorkspaceTypeFQDNIP = "FQDN/IP"
	WorkspaceTypeATLAS  = "ATLAS"
	WorkspaceTypeFault  = "FAULT"
)

Possible workspace types

Variables ¶

View Source

var IdentityEnvUrls = map[AwsEnv]string{
	Prod:    "idaptive.app",
	GovProd: "id.cyberarkgov.cloud",
}

IdentityEnvUrls is a map that associates AWS environments with their respective identity environment URLs.

View Source

var IdentityGeneratedSuffixPattern = map[AwsEnv]string{
	Prod:    `cyberark\.cloud\.\d.*`,
	GovProd: `cyberarkgov\.cloud\.\d.*`,
}

IdentityGeneratedSuffixPattern is a map that associates AWS environments with their respective identity generated suffix patterns.

View Source

var IdentityTenantNames = map[AwsEnv]string{
	Prod:    IdentityTenantName,
	GovProd: IdentityTenantName,
}

IdentityTenantNames is a map that associates AWS environments with their respective identity tenant names.

View Source

var RootDomain = map[AwsEnv]string{
	Prod:    "cyberark.cloud",
	GovProd: "cyberarkgov.cloud",
}

RootDomain is a map that associates AWS environments with their respective root domains.

Functions ¶

func CheckIfIdentityGeneratedSuffix ¶

func CheckIfIdentityGeneratedSuffix(tenantSuffix string, env AwsEnv) bool

CheckIfIdentityGeneratedSuffix checks if the given tenant suffix matches the identity generated suffix pattern for the specified AWS environment.

func IsGovCloud ¶

func IsGovCloud() bool

IsGovCloud checks if the current AWS region is a GovCloud region.

Types ¶

type ArkRFC3339Time ¶

type ArkRFC3339Time time.Time

ArkRFC3339Time is a custom time type that represents a time in RFC 3339 format.

func (*ArkRFC3339Time) MarshalJSON ¶

func (ct *ArkRFC3339Time) MarshalJSON() ([]byte, error)

MarshalJSON converts the ArkRFC3339Time type to JSON format.

func (*ArkRFC3339Time) UnmarshalJSON ¶

func (ct *ArkRFC3339Time) UnmarshalJSON(data []byte) error

UnmarshalJSON parses the JSON data into the ArkRFC3339Time type.

type AwsEnv ¶

type AwsEnv string

AwsEnv is a string type that represents the AWS environment.

const (
	Prod    AwsEnv = "prod"
	GovProd AwsEnv = "gov-prod"
)

Constants for AWS environments.

func GetDeployEnv ¶

func GetDeployEnv() AwsEnv

GetDeployEnv returns the AWS environment based on the DEPLOY_ENV environment variable.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
connections
connectiondata
identity

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