Documentation
¶
Index ¶
- type APIController
- func (c *APIController) AddTagsToKeyConfiguration(ctx context.Context, request cmkapi.AddTagsToKeyConfigurationRequestObject) (cmkapi.AddTagsToKeyConfigurationResponseObject, error)
- func (c *APIController) CheckGroupsIAM(ctx context.Context, request cmkapi.CheckGroupsIAMRequestObject) (cmkapi.CheckGroupsIAMResponseObject, error)
- func (c *APIController) CheckWorkflow(ctx context.Context, request cmkapi.CheckWorkflowRequestObject) (cmkapi.CheckWorkflowResponseObject, error)
- func (c *APIController) CreateGroup(ctx context.Context, request cmkapi.CreateGroupRequestObject) (cmkapi.CreateGroupResponseObject, error)
- func (c *APIController) CreateKeyVersion(ctx context.Context, request cmkapi.CreateKeyVersionRequestObject) (cmkapi.CreateKeyVersionResponseObject, error)
- func (c *APIController) CreateOrUpdateLabels(ctx context.Context, request cmkapi.CreateOrUpdateLabelsRequestObject) (cmkapi.CreateOrUpdateLabelsResponseObject, error)
- func (c *APIController) CreateWorkflow(ctx context.Context, request cmkapi.CreateWorkflowRequestObject) (cmkapi.CreateWorkflowResponseObject, error)
- func (c *APIController) DeleteGroupByID(ctx context.Context, request cmkapi.DeleteGroupByIDRequestObject) (cmkapi.DeleteGroupByIDResponseObject, error)
- func (c *APIController) DeleteKeyConfigurationByID(ctx context.Context, request cmkapi.DeleteKeyConfigurationByIDRequestObject) (cmkapi.DeleteKeyConfigurationByIDResponseObject, error)
- func (c *APIController) DeleteKeysKeyID(ctx context.Context, request cmkapi.DeleteKeysKeyIDRequestObject) (cmkapi.DeleteKeysKeyIDResponseObject, error)
- func (c *APIController) DeleteLabel(ctx context.Context, request cmkapi.DeleteLabelRequestObject) (cmkapi.DeleteLabelResponseObject, error)
- func (c *APIController) GetAllSystems(ctx context.Context, request cmkapi.GetAllSystemsRequestObject) (cmkapi.GetAllSystemsResponseObject, error)
- func (c *APIController) GetGroupByID(ctx context.Context, request cmkapi.GetGroupByIDRequestObject) (cmkapi.GetGroupByIDResponseObject, error)
- func (c *APIController) GetGroups(ctx context.Context, request cmkapi.GetGroupsRequestObject) (cmkapi.GetGroupsResponseObject, error)
- func (c *APIController) GetKeyConfigurationByID(ctx context.Context, request cmkapi.GetKeyConfigurationByIDRequestObject) (cmkapi.GetKeyConfigurationByIDResponseObject, error)
- func (c *APIController) GetKeyConfigurations(ctx context.Context, r cmkapi.GetKeyConfigurationsRequestObject) (cmkapi.GetKeyConfigurationsResponseObject, error)
- func (c *APIController) GetKeyConfigurationsCertificates(ctx context.Context, _ cmkapi.GetKeyConfigurationsCertificatesRequestObject) (cmkapi.GetKeyConfigurationsCertificatesResponseObject, error)
- func (c *APIController) GetKeyImportParams(ctx context.Context, request cmkapi.GetKeyImportParamsRequestObject) (cmkapi.GetKeyImportParamsResponseObject, error)
- func (c *APIController) GetKeyLabels(ctx context.Context, r cmkapi.GetKeyLabelsRequestObject) (cmkapi.GetKeyLabelsResponseObject, error)
- func (c *APIController) GetKeyVersionByNumber(ctx context.Context, request cmkapi.GetKeyVersionByNumberRequestObject) (cmkapi.GetKeyVersionByNumberResponseObject, error)
- func (c *APIController) GetKeyVersions(ctx context.Context, request cmkapi.GetKeyVersionsRequestObject) (cmkapi.GetKeyVersionsResponseObject, error)
- func (c *APIController) GetKeys(ctx context.Context, request cmkapi.GetKeysRequestObject) (cmkapi.GetKeysResponseObject, error)
- func (c *APIController) GetKeysKeyID(ctx context.Context, request cmkapi.GetKeysKeyIDRequestObject) (cmkapi.GetKeysKeyIDResponseObject, error)
- func (c *APIController) GetRecoveryActions(ctx context.Context, request cmkapi.GetRecoveryActionsRequestObject) (cmkapi.GetRecoveryActionsResponseObject, error)
- func (c *APIController) GetSystemByID(ctx context.Context, request cmkapi.GetSystemByIDRequestObject) (cmkapi.GetSystemByIDResponseObject, error)
- func (c *APIController) GetTagsForKeyConfiguration(ctx context.Context, request cmkapi.GetTagsForKeyConfigurationRequestObject) (cmkapi.GetTagsForKeyConfigurationResponseObject, error)
- func (c *APIController) GetTenantInfo(ctx context.Context, _ cmkapi.GetTenantInfoRequestObject) (cmkapi.GetTenantInfoResponseObject, error)
- func (c *APIController) GetTenantKeystores(_ context.Context, _ cmkapi.GetTenantKeystoresRequestObject) (cmkapi.GetTenantKeystoresResponseObject, error)
- func (c *APIController) GetTenantWorkflowConfiguration(ctx context.Context, _ cmkapi.GetTenantWorkflowConfigurationRequestObject) (cmkapi.GetTenantWorkflowConfigurationResponseObject, error)
- func (c *APIController) GetTenants(ctx context.Context, request cmkapi.GetTenantsRequestObject) (cmkapi.GetTenantsResponseObject, error)
- func (c *APIController) GetUserInfo(ctx context.Context, _ cmkapi.GetUserInfoRequestObject) (cmkapi.GetUserInfoResponseObject, error)
- func (c *APIController) GetWorkflowByID(ctx context.Context, request cmkapi.GetWorkflowByIDRequestObject) (cmkapi.GetWorkflowByIDResponseObject, error)
- func (c *APIController) GetWorkflows(ctx context.Context, request cmkapi.GetWorkflowsRequestObject) (cmkapi.GetWorkflowsResponseObject, error)
- func (c *APIController) ImportKeyMaterial(ctx context.Context, request cmkapi.ImportKeyMaterialRequestObject) (cmkapi.ImportKeyMaterialResponseObject, error)
- func (c *APIController) LinkSystemAction(ctx context.Context, request cmkapi.LinkSystemActionRequestObject) (cmkapi.LinkSystemActionResponseObject, error)
- func (c *APIController) PostKeyConfigurations(ctx context.Context, request cmkapi.PostKeyConfigurationsRequestObject) (cmkapi.PostKeyConfigurationsResponseObject, error)
- func (c *APIController) PostKeys(ctx context.Context, request cmkapi.PostKeysRequestObject) (cmkapi.PostKeysResponseObject, error)
- func (c *APIController) SendRecoveryActions(ctx context.Context, request cmkapi.SendRecoveryActionsRequestObject) (cmkapi.SendRecoveryActionsResponseObject, error)
- func (c *APIController) TransitionWorkflow(ctx context.Context, request cmkapi.TransitionWorkflowRequestObject) (cmkapi.TransitionWorkflowResponseObject, error)
- func (c *APIController) UnlinkSystemAction(ctx context.Context, request cmkapi.UnlinkSystemActionRequestObject) (cmkapi.UnlinkSystemActionResponseObject, error)
- func (c *APIController) UpdateGroup(ctx context.Context, request cmkapi.UpdateGroupRequestObject) (cmkapi.UpdateGroupResponseObject, error)
- func (c *APIController) UpdateKey(ctx context.Context, request cmkapi.UpdateKeyRequestObject) (cmkapi.UpdateKeyResponseObject, error)
- func (c *APIController) UpdateKeyConfigurationByID(ctx context.Context, request cmkapi.UpdateKeyConfigurationByIDRequestObject) (cmkapi.UpdateKeyConfigurationByIDResponseObject, error)
- func (c *APIController) UpdateTenantWorkflowConfiguration(ctx context.Context, ...) (cmkapi.UpdateTenantWorkflowConfigurationResponseObject, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIController ¶
type APIController struct {
Repository repo.Repo
Manager *manager.Manager
AuthzEngine *authzmodel.Engine
// contains filtered or unexported fields
}
APIController handles API requests related to CMK (Customer Managed Keys).
func NewAPIController ¶
func NewAPIController( ctx context.Context, r repo.Repo, config *config.Config, clientsFactory clients.Factory, migrator db.Migrator, ) *APIController
NewAPIController creates a new instance of APIController with the provided Repository. It initializes a logger for the controller.
func (*APIController) AddTagsToKeyConfiguration ¶
func (c *APIController) AddTagsToKeyConfiguration( ctx context.Context, request cmkapi.AddTagsToKeyConfigurationRequestObject, ) (cmkapi.AddTagsToKeyConfigurationResponseObject, error)
AddTagsToKeyConfiguration adds tags to a key configuration
func (*APIController) CheckGroupsIAM ¶
func (c *APIController) CheckGroupsIAM( ctx context.Context, request cmkapi.CheckGroupsIAMRequestObject, ) (cmkapi.CheckGroupsIAMResponseObject, error)
func (*APIController) CheckWorkflow ¶
func (c *APIController) CheckWorkflow( ctx context.Context, request cmkapi.CheckWorkflowRequestObject, ) (cmkapi.CheckWorkflowResponseObject, error)
func (*APIController) CreateGroup ¶
func (c *APIController) CreateGroup( ctx context.Context, request cmkapi.CreateGroupRequestObject, ) (cmkapi.CreateGroupResponseObject, error)
func (*APIController) CreateKeyVersion ¶
func (c *APIController) CreateKeyVersion(ctx context.Context, request cmkapi.CreateKeyVersionRequestObject, ) (cmkapi.CreateKeyVersionResponseObject, error)
CreateKeyVersion creates a new key version for L1 Key ID
func (*APIController) CreateOrUpdateLabels ¶
func (c *APIController) CreateOrUpdateLabels( ctx context.Context, request cmkapi.CreateOrUpdateLabelsRequestObject, ) (cmkapi.CreateOrUpdateLabelsResponseObject, error)
CreateOrUpdateLabels handle adding a new label to the key if does not already exist otherwise update them.
func (*APIController) CreateWorkflow ¶
func (c *APIController) CreateWorkflow(ctx context.Context, request cmkapi.CreateWorkflowRequestObject, ) (cmkapi.CreateWorkflowResponseObject, error)
CreateWorkflow creates a new workflow
func (*APIController) DeleteGroupByID ¶
func (c *APIController) DeleteGroupByID( ctx context.Context, request cmkapi.DeleteGroupByIDRequestObject, ) (cmkapi.DeleteGroupByIDResponseObject, error)
func (*APIController) DeleteKeyConfigurationByID ¶
func (c *APIController) DeleteKeyConfigurationByID( ctx context.Context, request cmkapi.DeleteKeyConfigurationByIDRequestObject, ) (cmkapi.DeleteKeyConfigurationByIDResponseObject, error)
DeleteKeyConfigurationByID deletes a key configuration by ID
func (*APIController) DeleteKeysKeyID ¶
func (c *APIController) DeleteKeysKeyID(ctx context.Context, request cmkapi.DeleteKeysKeyIDRequestObject, ) (cmkapi.DeleteKeysKeyIDResponseObject, error)
DeleteKeysKeyID handles deleting a key by its ID
func (*APIController) DeleteLabel ¶
func (c *APIController) DeleteLabel(ctx context.Context, request cmkapi.DeleteLabelRequestObject, ) (cmkapi.DeleteLabelResponseObject, error)
DeleteLabel handles deleting the label attached to the key specified by its ID and a label is specified by its name.
func (*APIController) GetAllSystems ¶
func (c *APIController) GetAllSystems(ctx context.Context, request cmkapi.GetAllSystemsRequestObject, ) (cmkapi.GetAllSystemsResponseObject, error)
func (*APIController) GetGroupByID ¶
func (c *APIController) GetGroupByID( ctx context.Context, request cmkapi.GetGroupByIDRequestObject, ) (cmkapi.GetGroupByIDResponseObject, error)
func (*APIController) GetGroups ¶
func (c *APIController) GetGroups( ctx context.Context, request cmkapi.GetGroupsRequestObject, ) (cmkapi.GetGroupsResponseObject, error)
func (*APIController) GetKeyConfigurationByID ¶
func (c *APIController) GetKeyConfigurationByID( ctx context.Context, request cmkapi.GetKeyConfigurationByIDRequestObject, ) (cmkapi.GetKeyConfigurationByIDResponseObject, error)
GetKeyConfigurationByID returns a key configuration by ID
func (*APIController) GetKeyConfigurations ¶
func (c *APIController) GetKeyConfigurations( ctx context.Context, r cmkapi.GetKeyConfigurationsRequestObject, ) (cmkapi.GetKeyConfigurationsResponseObject, error)
GetKeyConfigurations returns the key configurations
func (*APIController) GetKeyConfigurationsCertificates ¶
func (c *APIController) GetKeyConfigurationsCertificates( ctx context.Context, _ cmkapi.GetKeyConfigurationsCertificatesRequestObject, ) (cmkapi.GetKeyConfigurationsCertificatesResponseObject, error)
func (*APIController) GetKeyImportParams ¶
func (c *APIController) GetKeyImportParams(ctx context.Context, request cmkapi.GetKeyImportParamsRequestObject, ) (cmkapi.GetKeyImportParamsResponseObject, error)
func (*APIController) GetKeyLabels ¶
func (c *APIController) GetKeyLabels(ctx context.Context, r cmkapi.GetKeyLabelsRequestObject, ) (cmkapi.GetKeyLabelsResponseObject, error)
GetKeyLabels handles fetching a list of all the labels attached to the key.
func (*APIController) GetKeyVersionByNumber ¶
func (c *APIController) GetKeyVersionByNumber( ctx context.Context, request cmkapi.GetKeyVersionByNumberRequestObject, ) (cmkapi.GetKeyVersionByNumberResponseObject, error)
GetKeyVersionByNumber returns a key version by key version number and L1 key ID
func (*APIController) GetKeyVersions ¶
func (c *APIController) GetKeyVersions(ctx context.Context, request cmkapi.GetKeyVersionsRequestObject, ) (cmkapi.GetKeyVersionsResponseObject, error)
GetKeyVersions returns a list of key version by L1 Key ID
func (*APIController) GetKeys ¶
func (c *APIController) GetKeys(ctx context.Context, request cmkapi.GetKeysRequestObject, ) (cmkapi.GetKeysResponseObject, error)
GetKeys handles retrieving all keys
func (*APIController) GetKeysKeyID ¶
func (c *APIController) GetKeysKeyID(ctx context.Context, request cmkapi.GetKeysKeyIDRequestObject, ) (cmkapi.GetKeysKeyIDResponseObject, error)
GetKeysKeyID handles retrieving a key by its ID
func (*APIController) GetRecoveryActions ¶
func (c *APIController) GetRecoveryActions( ctx context.Context, request cmkapi.GetRecoveryActionsRequestObject, ) (cmkapi.GetRecoveryActionsResponseObject, error)
func (*APIController) GetSystemByID ¶
func (c *APIController) GetSystemByID(ctx context.Context, request cmkapi.GetSystemByIDRequestObject, ) (cmkapi.GetSystemByIDResponseObject, error)
func (*APIController) GetTagsForKeyConfiguration ¶
func (c *APIController) GetTagsForKeyConfiguration( ctx context.Context, request cmkapi.GetTagsForKeyConfigurationRequestObject, ) (cmkapi.GetTagsForKeyConfigurationResponseObject, error)
GetTagsForKeyConfiguration returns the tags for a key configuration
func (*APIController) GetTenantInfo ¶
func (c *APIController) GetTenantInfo( ctx context.Context, _ cmkapi.GetTenantInfoRequestObject, ) (cmkapi.GetTenantInfoResponseObject, error)
func (*APIController) GetTenantKeystores ¶
func (c *APIController) GetTenantKeystores( _ context.Context, _ cmkapi.GetTenantKeystoresRequestObject, ) (cmkapi.GetTenantKeystoresResponseObject, error)
func (*APIController) GetTenantWorkflowConfiguration ¶ added in v0.3.0
func (c *APIController) GetTenantWorkflowConfiguration( ctx context.Context, _ cmkapi.GetTenantWorkflowConfigurationRequestObject, ) (cmkapi.GetTenantWorkflowConfigurationResponseObject, error)
func (*APIController) GetTenants ¶
func (c *APIController) GetTenants( ctx context.Context, request cmkapi.GetTenantsRequestObject, ) (cmkapi.GetTenantsResponseObject, error)
func (*APIController) GetUserInfo ¶
func (c *APIController) GetUserInfo( ctx context.Context, _ cmkapi.GetUserInfoRequestObject, ) (cmkapi.GetUserInfoResponseObject, error)
func (*APIController) GetWorkflowByID ¶
func (c *APIController) GetWorkflowByID(ctx context.Context, request cmkapi.GetWorkflowByIDRequestObject, ) (cmkapi.GetWorkflowByIDResponseObject, error)
func (*APIController) GetWorkflows ¶
func (c *APIController) GetWorkflows( ctx context.Context, request cmkapi.GetWorkflowsRequestObject, ) (cmkapi.GetWorkflowsResponseObject, error)
GetWorkflows returns a list of workflows
func (*APIController) ImportKeyMaterial ¶
func (c *APIController) ImportKeyMaterial(ctx context.Context, request cmkapi.ImportKeyMaterialRequestObject, ) (cmkapi.ImportKeyMaterialResponseObject, error)
func (*APIController) LinkSystemAction ¶
func (c *APIController) LinkSystemAction( ctx context.Context, request cmkapi.LinkSystemActionRequestObject, ) (cmkapi.LinkSystemActionResponseObject, error)
func (*APIController) PostKeyConfigurations ¶
func (c *APIController) PostKeyConfigurations( ctx context.Context, request cmkapi.PostKeyConfigurationsRequestObject, ) (cmkapi.PostKeyConfigurationsResponseObject, error)
PostKeyConfigurations creates a new key configuration
func (*APIController) PostKeys ¶
func (c *APIController) PostKeys(ctx context.Context, request cmkapi.PostKeysRequestObject, ) (cmkapi.PostKeysResponseObject, error)
PostKeys handles the creation of a new key
func (*APIController) SendRecoveryActions ¶
func (c *APIController) SendRecoveryActions( ctx context.Context, request cmkapi.SendRecoveryActionsRequestObject, ) (cmkapi.SendRecoveryActionsResponseObject, error)
func (*APIController) TransitionWorkflow ¶
func (c *APIController) TransitionWorkflow( ctx context.Context, request cmkapi.TransitionWorkflowRequestObject, ) (cmkapi.TransitionWorkflowResponseObject, error)
func (*APIController) UnlinkSystemAction ¶
func (c *APIController) UnlinkSystemAction( ctx context.Context, request cmkapi.UnlinkSystemActionRequestObject, ) (cmkapi.UnlinkSystemActionResponseObject, error)
func (*APIController) UpdateGroup ¶
func (c *APIController) UpdateGroup( ctx context.Context, request cmkapi.UpdateGroupRequestObject, ) (cmkapi.UpdateGroupResponseObject, error)
func (*APIController) UpdateKey ¶
func (c *APIController) UpdateKey(ctx context.Context, request cmkapi.UpdateKeyRequestObject, ) (cmkapi.UpdateKeyResponseObject, error)
UpdateKey handles updating an existing key
func (*APIController) UpdateKeyConfigurationByID ¶
func (c *APIController) UpdateKeyConfigurationByID( ctx context.Context, request cmkapi.UpdateKeyConfigurationByIDRequestObject, ) (cmkapi.UpdateKeyConfigurationByIDResponseObject, error)
UpdateKeyConfigurationByID updates a key configuration by ID
func (*APIController) UpdateTenantWorkflowConfiguration ¶ added in v0.3.0
func (c *APIController) UpdateTenantWorkflowConfiguration( ctx context.Context, request cmkapi.UpdateTenantWorkflowConfigurationRequestObject, ) (cmkapi.UpdateTenantWorkflowConfigurationResponseObject, error)