Documentation
¶
Index ¶
Constants ¶
View Source
const ( // AuthorizationRoleBindingTypeUserBinding captures enum value "UserBinding" AuthorizationRoleBindingTypeUserBinding string = "UserBinding" // AuthorizationRoleBindingTypeTeamBinding captures enum value "TeamBinding" AuthorizationRoleBindingTypeTeamBinding string = "TeamBinding" )
View Source
const ( // AuthorizationRuleTypeHKS captures enum value "hks" AuthorizationRuleTypeHKS string = "hks" // AuthorizationRuleTypeKubernetes captures enum value "kubernetes" AuthorizationRuleTypeKubernetes string = "kubernetes" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountToken ¶
type AccountToken struct {
// User authorization token
// Required: true
Token *string `json:"token"`
}
AccountToken A HKS Account Authorization Token swagger:model AccountToken
func (*AccountToken) MarshalBinary ¶
func (m *AccountToken) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AccountToken) UnmarshalBinary ¶
func (m *AccountToken) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthorizationRole ¶
type AuthorizationRole struct {
// Timestamp at which the role was created
// Required: true
CreatedAt *string `json:"created_at"`
// Description of the role
Description string `json:"description,omitempty"`
// Role ID
// Required: true
ID UUID `json:"id"`
// Name of the role
// Required: true
Name *string `json:"name"`
// Organization ID of the organization the role belongs to
// Required: true
OrganizationID UUID `json:"organization_id"`
// Account ID of the role owner
// Required: true
OwnerID UUID `json:"owner_id"`
// List of authorization rules if rules are sideloaded
Rules []*AuthorizationRule `json:"rules"`
// Timestamp at which the role was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
}
AuthorizationRole authorization role swagger:model AuthorizationRole
func (*AuthorizationRole) MarshalBinary ¶
func (m *AuthorizationRole) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthorizationRole) UnmarshalBinary ¶
func (m *AuthorizationRole) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthorizationRoleBinding ¶
type AuthorizationRoleBinding struct {
// Authorization role ID this role binding applies to
// Required: true
AuthorizationRoleID UUID `json:"authorization_role_id"`
// Cluster ID this role binding applies to
ClusterID UUID `json:"cluster_id,omitempty"`
// Timestamp at which the role was created
// Required: true
CreatedAt *string `json:"created_at"`
// Role ID
// Required: true
ID UUID `json:"id"`
// Namespace this role binding applies to
Namespace string `json:"namespace,omitempty"`
// Organization ID of the organization the role belongs to
// Required: true
OrganizationID UUID `json:"organization_id"`
// Account ID of the role binding owner
// Required: true
OwnerID UUID `json:"owner_id"`
// Team ID this role binding applies to (required when kind is TeamBinding, else forbidden)
TeamID UUID `json:"team_id,omitempty"`
// Type of role binding
// Required: true
// Enum: [UserBinding TeamBinding]
Type *string `json:"type"`
// Timestamp at which the role was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
// User ID this role binding applies to (required when kind is UserBinding, else forbidden)
UserID UUID `json:"user_id,omitempty"`
}
AuthorizationRoleBinding authorization role binding swagger:model AuthorizationRoleBinding
func (*AuthorizationRoleBinding) MarshalBinary ¶
func (m *AuthorizationRoleBinding) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthorizationRoleBinding) UnmarshalBinary ¶
func (m *AuthorizationRoleBinding) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthorizationRule ¶
type AuthorizationRule struct {
// API groups this rule applies to
APIGroups []string `json:"api_groups"`
// Timestamp at which the rule was created
// Required: true
CreatedAt *string `json:"created_at"`
// Description of the rule
Description string `json:"description,omitempty"`
// Role ID
// Required: true
ID UUID `json:"id"`
// Name of the rule
// Required: true
Name *string `json:"name"`
// Set of partial URLs a user should have access to
NonResourceUrls []string `json:"non_resource_urls"`
// Organization ID of the organization the rule belongs to
// Required: true
OrganizationID UUID `json:"organization_id"`
// Account ID of the rule owner
// Required: true
OwnerID UUID `json:"owner_id"`
// Resource names this rule applies to
// Required: true
ResourceNames []string `json:"resource_names"`
// Resources this rule applies to
// Required: true
Resources []string `json:"resources"`
// Type of this rule
// Required: true
// Enum: [hks kubernetes]
Type *string `json:"type"`
// Timestamp at which the rule was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
// Verbs this rule applies to
// Required: true
Verbs []string `json:"verbs"`
}
AuthorizationRule authorization rule swagger:model AuthorizationRule
func (*AuthorizationRule) MarshalBinary ¶
func (m *AuthorizationRule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthorizationRule) UnmarshalBinary ¶
func (m *AuthorizationRule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// code
// Required: true
Code *int32 `json:"code"`
// message
// Required: true
Message *string `json:"message"`
}
Error error swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LoginRequest ¶
type LoginRequest struct {
// Email to use for login
Email string `json:"email,omitempty"`
// Password to use for login
Password string `json:"password,omitempty"`
}
LoginRequest login request swagger:model LoginRequest
func (*LoginRequest) MarshalBinary ¶
func (m *LoginRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LoginRequest) UnmarshalBinary ¶
func (m *LoginRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
Click to show internal directories.
Click to hide internal directories.