Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ArkAuthMethodSettingsMap = map[ArkAuthMethod]interface{}{ Identity: &IdentityArkAuthMethodSettings{}, IdentityServiceUser: &IdentityServiceUserArkAuthMethodSettings{}, Direct: &DirectArkAuthMethodSettings{}, Default: &DefaultArkAuthMethodSettings{}, }
ArkAuthMethodSettingsMap is a map that associates each ArkAuthMethod with its corresponding settings struct.
var ArkAuthMethodSharableCredentials = []ArkAuthMethod{ Identity, }
ArkAuthMethodSharableCredentials is a slice of ArkAuthMethod that can share credentials.
var ArkAuthMethodsDescriptionMap = map[ArkAuthMethod]string{ Identity: "Identity Personal User", IdentityServiceUser: "Identity Service User", Direct: "Direct Endpoint Access", Default: "Default Authenticator Method", }
ArkAuthMethodsDescriptionMap is a map that provides descriptions for each ArkAuthMethod.
var ArkAuthMethodsRequireCredentials = []ArkAuthMethod{ Identity, IdentityServiceUser, Direct, }
ArkAuthMethodsRequireCredentials is a slice of ArkAuthMethod that require credentials.
Functions ¶
This section is empty.
Types ¶
type ArkAuthMethod ¶
type ArkAuthMethod string
ArkAuthMethod is a string type that represents the authentication method used in the Ark SDK.
const ( Identity ArkAuthMethod = "identity" IdentityServiceUser ArkAuthMethod = "identity_service_user" Direct ArkAuthMethod = "direct" Default ArkAuthMethod = "default" Other ArkAuthMethod = "other" )
Authentication methods supported by the Ark SDK.
type ArkAuthMethodSettings ¶
type ArkAuthMethodSettings interface{}
ArkAuthMethodSettings is an interface that defines the settings for different authentication methods.
type ArkAuthProfile ¶
type ArkAuthProfile struct {
Username string `json:"username" mapstructure:"username" flag:"username" desc:"Username"`
AuthMethod ArkAuthMethod `json:"auth_method" mapstructure:"auth_method" flag:"-"`
AuthMethodSettings ArkAuthMethodSettings `json:"auth_method_settings" mapstructure:"auth_method_settings" flag:"-"`
}
ArkAuthProfile represents the authentication profile for Ark SIA.
func (*ArkAuthProfile) UnmarshalJSON ¶
func (a *ArkAuthProfile) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshals the JSON data into the ArkAuthProfile struct.
type ArkSecret ¶
type ArkSecret struct {
Secret string `json:"secret"`
}
ArkSecret is a struct that represents a secret in the Ark SIA.
type ArkToken ¶
type ArkToken struct {
Token string `json:"token" mapstructure:"token" validate:"required"`
TokenType ArkTokenType `json:"token_type" mapstructure:"token_type" validate:"required"`
Username string `json:"username" mapstructure:"username"`
Endpoint string `json:"endpoint" mapstructure:"endpoint"`
AuthMethod ArkAuthMethod `json:"auth_method" mapstructure:"auth_method"`
ExpiresIn common.ArkRFC3339Time `json:"expires_in" mapstructure:"expires_in"`
RefreshToken string `json:"refresh_token" mapstructure:"refresh_token"`
Metadata map[string]interface{} `json:"metadata" mapstructure:"metadata"`
}
ArkToken is a struct that represents a token in the Ark SIA.
type ArkTokenType ¶
type ArkTokenType string
ArkTokenType is a string type that represents the type of token used in the Ark SIA.
const ( JWT ArkTokenType = "JSON Web Token" Cookies ArkTokenType = "Cookies" Token ArkTokenType = "Token" Password ArkTokenType = "Password" Custom ArkTokenType = "Custom" Internal ArkTokenType = "Internal" )
Toke types supported by Ark
type DefaultArkAuthMethodSettings ¶
type DefaultArkAuthMethodSettings struct{}
DefaultArkAuthMethodSettings is a struct that represents the default settings for the authentication method.
type DirectArkAuthMethodSettings ¶
type DirectArkAuthMethodSettings struct {
Endpoint string `json:"endpoint" mapstructure:"endpoint" flag:"endpoint" desc:"Authentication Endpoint"`
Interactive bool `json:"interactive" mapstructure:"interactive" flag:"interactive" desc:"Allow interactiveness"`
}
DirectArkAuthMethodSettings is a struct that represents the settings for the Direct authentication method.
type IdentityArkAuthMethodSettings ¶
type IdentityArkAuthMethodSettings struct {
IdentityMFAMethod string `` /* 180-byte string literal not displayed */
IdentityMFAInteractive bool `` /* 152-byte string literal not displayed */
IdentityURL string `json:"identity_url" mapstructure:"identity_url" flag:"identity-url" desc:"Identity Url"`
IdentityTenantSubdomain string `` /* 139-byte string literal not displayed */
}
IdentityArkAuthMethodSettings is a struct that represents the settings for the Identity authentication method.
type IdentityServiceUserArkAuthMethodSettings ¶
type IdentityServiceUserArkAuthMethodSettings struct {
IdentityURL string `json:"identity_url" mapstructure:"identity_url" flag:"identity-url" desc:"Identity Url"`
IdentityTenantSubdomain string `` /* 139-byte string literal not displayed */
IdentityAuthorizationApplication string `` /* 231-byte string literal not displayed */
}
IdentityServiceUserArkAuthMethodSettings is a struct that represents the settings for the Identity Service User authentication method.
Source Files