Documentation
¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AuditApiFindAuditOpts
- type AuditApiService
- type BasicAuth
- type BreakGlassApiService
- func (a *BreakGlassApiService) ApplyRequest(ctx context.Context, shares []string) (DsvApplyResponse, *http.Response, error)
- func (a *BreakGlassApiService) GenerateRequest(ctx context.Context, newAdmins []string, minNumberOfShares int64) (DsvGenerateResponse, *http.Response, error)
- func (a *BreakGlassApiService) GetStatus(ctx context.Context) (DsvStatusResponse, *http.Response, error)
- type ClientsApiDeleteClientCredentialOpts
- type ClientsApiSearchClientsOpts
- type ClientsApiService
- func (a *ClientsApiService) CreateClientCredential(ctx context.Context, body DsvClientCreate) (DsvClientCredentialsResponse, *http.Response, error)
- func (a *ClientsApiService) DeleteClientCredential(ctx context.Context, clientId string, ...) (DsvMessageResponse, *http.Response, error)
- func (a *ClientsApiService) GetBootstrapClientCredential(ctx context.Context) (DsvClientCredentialsResponse, *http.Response, error)
- func (a *ClientsApiService) GetClientCredential(ctx context.Context, clientId string) (DsvClientCredentialsResponse, *http.Response, error)
- func (a *ClientsApiService) RestoreClient(ctx context.Context, clientId string) (*http.Response, error)
- func (a *ClientsApiService) SearchClients(ctx context.Context, role string, ...) (DsvClientSearchModel, *http.Response, error)
- type ConfigApiService
- func (a *ConfigApiService) GetConfig(ctx context.Context) (DsvConfigResponse, *http.Response, error)
- func (a *ConfigApiService) GetConfigByVersion(ctx context.Context, version int64) (DsvConfigVersionResponse, *http.Response, error)
- func (a *ConfigApiService) PostConfig(ctx context.Context, body DsvPostConfigModel) (DsvConfigResponse, *http.Response, error)
- type Configuration
- type DsvAccessTokenResponse
- type DsvAddMemberResponse
- type DsvAddToGroupsRequest
- type DsvAddToGroupsResponse
- type DsvApplyResponse
- type DsvAudit
- type DsvAuthProperties
- type DsvAuthentication
- type DsvAuthenticationDetailsModel
- type DsvAuthenticationProviderPropertiesModel
- type DsvAuthenticationSettingsCreateModel
- type DsvAuthenticationSettingsResponse
- type DsvAuthenticationSettingsSearchResponse
- type DsvAuthenticationSettingsVersionResponse
- type DsvAutoKey
- type DsvAutoKeyResponse
- type DsvClientCreate
- type DsvClientCredentialsResponse
- type DsvClientSearchModel
- type DsvCondition
- type DsvConditions
- type DsvConfigResponse
- type DsvConfigVersionResponse
- type DsvCreateGroup
- type DsvDecryptionResponse
- type DsvDefaultPolicy
- type DsvEncryptionResponse
- type DsvEngineCreate
- type DsvEngineCreateResponse
- type DsvEngineGetResponse
- type DsvEngineListResult
- type DsvEnginePingResponse
- type DsvEngineSearchResponse
- type DsvGenerateResponse
- type DsvGroup
- type DsvGroupMemberInfo
- type DsvGroupResponse
- type DsvGroupSearch
- type DsvHistory
- type DsvHttpError
- type DsvInitiateCertAuthResponse
- type DsvKey
- type DsvLogSearchResponse
- type DsvManualKeyData
- type DsvMasterkey
- type DsvMemberRequest
- type DsvMemberResponse
- type DsvMessageResponse
- type DsvPageInfo
- type DsvPasswordChangeModel
- type DsvPolicyCreate
- type DsvPolicyResponse
- type DsvPolicySearchResponse
- type DsvPolicyUpdate
- type DsvPolicyVersionResponse
- type DsvPool
- type DsvPoolCreate
- type DsvPoolListResult
- type DsvPostConfigModel
- type DsvResponseCertificate
- type DsvResponseRootCertificate
- type DsvResponseSshCertificate
- type DsvRoleCreate
- type DsvRoleDetailsModel
- type DsvRoleResponse
- type DsvRoleSearchResponse
- type DsvRoleVersionResponse
- type DsvRoles
- type DsvRootCaRegistration
- type DsvRootCaSecret
- type DsvSecretCreate
- type DsvSecretDescription
- type DsvSecretListPathsResponse
- type DsvSecretResponse
- type DsvSecretSearch
- type DsvSecretUpdate
- type DsvSecretVersionResponse
- type DsvSettings
- type DsvSiemCreateUpdateRequestModel
- type DsvSiemNoSensitiveResponseModel
- type DsvSiemResponse
- type DsvSiemSearchResponse
- type DsvSignedLeafCertificate
- type DsvSigningRequest
- type DsvSigningRequestInformation
- type DsvSshCertInformation
- type DsvStatusResponse
- type DsvTaskResult
- type DsvTaskState
- type DsvUpdateKeyRequest
- type DsvUsageResponseGeneral
- type DsvUserCreateModel
- type DsvUserResponse
- type DsvUserSearch
- type DsvUserUpdateModel
- type DsvUserVersionResponse
- type EaaSAutoApiDecryptOpts
- type EaaSAutoApiEncryptOpts
- type EaaSAutoApiRotationRequestOpts
- type EaaSAutoApiService
- func (a *EaaSAutoApiService) CreateKey(ctx context.Context, path string) (DsvAutoKeyResponse, *http.Response, error)
- func (a *EaaSAutoApiService) Decrypt(ctx context.Context, path string, ciphertext []int32, ...) (DsvDecryptionResponse, *http.Response, error)
- func (a *EaaSAutoApiService) DeleteKey(ctx context.Context, path string) (DsvMessageResponse, *http.Response, error)
- func (a *EaaSAutoApiService) Encrypt(ctx context.Context, path string, plaintext string, ...) (DsvEncryptionResponse, *http.Response, error)
- func (a *EaaSAutoApiService) GetKeyMetadata(ctx context.Context, path string) (DsvAutoKeyResponse, *http.Response, error)
- func (a *EaaSAutoApiService) RestoreKey(ctx context.Context, path string) (*http.Response, error)
- func (a *EaaSAutoApiService) RotationRequest(ctx context.Context, path string, ciphertext []int32, startingVersion string, ...) (DsvEncryptionResponse, *http.Response, error)
- type EaaSManualApiDecryptWithManualKeyOpts
- type EaaSManualApiEncryptWithManualKeyOpts
- type EaaSManualApiService
- func (a *EaaSManualApiService) DecryptWithManualKey(ctx context.Context, path string, ciphertext []int32, ...) (DsvDecryptionResponse, *http.Response, error)
- func (a *EaaSManualApiService) DeleteManualKey(ctx context.Context, path string) (DsvMessageResponse, *http.Response, error)
- func (a *EaaSManualApiService) EncryptWithManualKey(ctx context.Context, path string, plaintext string, ...) (DsvEncryptionResponse, *http.Response, error)
- func (a *EaaSManualApiService) ReadManualKey(ctx context.Context, path string) (DsvSecretResponse, *http.Response, error)
- func (a *EaaSManualApiService) RestoreManualKey(ctx context.Context, path string) (*http.Response, error)
- func (a *EaaSManualApiService) UpdateKey(ctx context.Context, body DsvUpdateKeyRequest, path string) (DsvSecretResponse, *http.Response, error)
- func (a *EaaSManualApiService) UploadKey(ctx context.Context, body DsvManualKeyData, path string) (DsvSecretResponse, *http.Response, error)
- type EnginesApiDeleteEngineOpts
- type EnginesApiService
- func (a *EnginesApiService) CreateEngine(ctx context.Context, body DsvEngineCreate) (DsvEngineCreateResponse, *http.Response, error)
- func (a *EnginesApiService) DeleteEngine(ctx context.Context, path string, ...) (DsvMessageResponse, *http.Response, error)
- func (a *EnginesApiService) GetEngine(ctx context.Context, path string) (DsvEngineGetResponse, *http.Response, error)
- func (a *EnginesApiService) ListEngines(ctx context.Context) (DsvEngineListResult, *http.Response, error)
- func (a *EnginesApiService) PingEngine(ctx context.Context, path string) (DsvEnginePingResponse, *http.Response, error)
- type GenericSwaggerError
- type GroupsApiDeleteGroupOpts
- type GroupsApiSearchGroupsOpts
- type GroupsApiService
- func (a *GroupsApiService) AddMember(ctx context.Context, name string, body DsvMemberRequest) (DsvAddMemberResponse, *http.Response, error)
- func (a *GroupsApiService) CreateGroup(ctx context.Context, body DsvCreateGroup) (DsvAddMemberResponse, *http.Response, error)
- func (a *GroupsApiService) DeleteGroup(ctx context.Context, name string, localVarOptionals *GroupsApiDeleteGroupOpts) (DsvMessageResponse, *http.Response, error)
- func (a *GroupsApiService) DeleteMember(ctx context.Context, name string, body DsvMemberRequest) (*http.Response, error)
- func (a *GroupsApiService) GetGroup(ctx context.Context, name string) (DsvGroupResponse, *http.Response, error)
- func (a *GroupsApiService) RestoreGroup(ctx context.Context, name string) (*http.Response, error)
- func (a *GroupsApiService) SearchGroups(ctx context.Context, localVarOptionals *GroupsApiSearchGroupsOpts) (DsvGroupSearch, *http.Response, error)
- type HomeApiDeleteHomeSecretOpts
- type HomeApiGetHomeSecretDescriptionOpts
- type HomeApiGetHomeSecretOpts
- type HomeApiRestoreHomeSecretOpts
- type HomeApiSearchHomeSecretsOpts
- type HomeApiService
- func (a *HomeApiService) CreateHomeSecret(ctx context.Context, path string, body DsvSecretCreate) (DsvSecretResponse, *http.Response, error)
- func (a *HomeApiService) DeleteHomeSecret(ctx context.Context, path string, ...) (DsvMessageResponse, *http.Response, error)
- func (a *HomeApiService) GetHomeSecret(ctx context.Context, path string, localVarOptionals *HomeApiGetHomeSecretOpts) (DsvSecretResponse, *http.Response, error)
- func (a *HomeApiService) GetHomeSecretByVersion(ctx context.Context, path string, version int64) (DsvSecretVersionResponse, *http.Response, error)
- func (a *HomeApiService) GetHomeSecretDescription(ctx context.Context, path string, ...) (DsvSecretDescription, *http.Response, error)
- func (a *HomeApiService) RestoreHomeSecret(ctx context.Context, path string, ...) (*http.Response, error)
- func (a *HomeApiService) RollbackHomeSecret(ctx context.Context, path string, version int64) (DsvSecretVersionResponse, *http.Response, error)
- func (a *HomeApiService) SearchHomeSecrets(ctx context.Context, localVarOptionals *HomeApiSearchHomeSecretsOpts) (DsvSecretSearch, *http.Response, error)
- func (a *HomeApiService) UpdateHomeSecret(ctx context.Context, path string, body DsvSecretUpdate) (DsvSecretResponse, *http.Response, error)
- type KeyApiService
- type PKIApiService
- func (a *PKIApiService) LeafParams(ctx context.Context, body DsvSigningRequestInformation) (DsvResponseCertificate, *http.Response, error)
- func (a *PKIApiService) RegisterRoot(ctx context.Context, body DsvRootCaSecret) (DsvResponseRootCertificate, *http.Response, error)
- func (a *PKIApiService) RootCARegistration(ctx context.Context, body DsvRootCaRegistration) (DsvResponseCertificate, *http.Response, error)
- func (a *PKIApiService) SSHCertParams(ctx context.Context, body DsvSshCertInformation) (DsvResponseSshCertificate, *http.Response, error)
- func (a *PKIApiService) SignCertificate(ctx context.Context, body DsvSigningRequest) (DsvSignedLeafCertificate, *http.Response, error)
- type PoliciesApiDeletePolicyOpts
- type PoliciesApiSearchFilterOpts
- type PoliciesApiService
- func (a *PoliciesApiService) CreatePolicy(ctx context.Context, body DsvPolicyCreate) (DsvPolicyResponse, *http.Response, error)
- func (a *PoliciesApiService) DeletePolicy(ctx context.Context, path string, ...) (DsvMessageResponse, *http.Response, error)
- func (a *PoliciesApiService) GetPolicy(ctx context.Context, path string) (DsvPolicyResponse, *http.Response, error)
- func (a *PoliciesApiService) GetPolicyByVersion(ctx context.Context, path string, version int64) (DsvPolicyVersionResponse, *http.Response, error)
- func (a *PoliciesApiService) RestorePolicy(ctx context.Context, path string) (*http.Response, error)
- func (a *PoliciesApiService) RollbackPolicy(ctx context.Context, path string, version int64) (DsvPolicyResponse, *http.Response, error)
- func (a *PoliciesApiService) SearchFilter(ctx context.Context, localVarOptionals *PoliciesApiSearchFilterOpts) (DsvPolicySearchResponse, *http.Response, error)
- func (a *PoliciesApiService) UpdatePolicy(ctx context.Context, path string, body DsvPolicyUpdate) (DsvPolicyResponse, *http.Response, error)
- type PoolsApiService
- func (a *PoolsApiService) CreatePool(ctx context.Context, body DsvPoolCreate) (DsvPool, *http.Response, error)
- func (a *PoolsApiService) DeletePool(ctx context.Context, name string) (DsvMessageResponse, *http.Response, error)
- func (a *PoolsApiService) GetPool(ctx context.Context, name string) (DsvPool, *http.Response, error)
- func (a *PoolsApiService) ListPools(ctx context.Context) (DsvPoolListResult, *http.Response, error)
- type RolesApiDeleteRoleOpts
- type RolesApiSearchRolesOpts
- type RolesApiService
- func (a *RolesApiService) CreateRole(ctx context.Context, body DsvRoleCreate) (DsvRoleResponse, *http.Response, error)
- func (a *RolesApiService) DeleteRole(ctx context.Context, name string, localVarOptionals *RolesApiDeleteRoleOpts) (DsvMessageResponse, *http.Response, error)
- func (a *RolesApiService) GetRole(ctx context.Context, name string) (DsvRoleResponse, *http.Response, error)
- func (a *RolesApiService) GetRoleByVersion(ctx context.Context, name string, version int64) (DsvRoleVersionResponse, *http.Response, error)
- func (a *RolesApiService) RestoreRole(ctx context.Context, name string) (*http.Response, error)
- func (a *RolesApiService) SearchRoles(ctx context.Context, localVarOptionals *RolesApiSearchRolesOpts) (DsvRoleSearchResponse, *http.Response, error)
- func (a *RolesApiService) UpdateRole(ctx context.Context, name string, role DsvRoleDetailsModel) (DsvRoleResponse, *http.Response, error)
- type SIEMApiSearchSiemsOpts
- type SIEMApiService
- func (a *SIEMApiService) SearchSiems(ctx context.Context, localVarOptionals *SIEMApiSearchSiemsOpts) (DsvSiemSearchResponse, *http.Response, error)
- func (a *SIEMApiService) SiemCreate(ctx context.Context, body DsvSiemCreateUpdateRequestModel) (DsvSiemResponse, *http.Response, error)
- func (a *SIEMApiService) SiemDelete(ctx context.Context, name string) (*http.Response, error)
- func (a *SIEMApiService) SiemGet(ctx context.Context, name string) (DsvSiemResponse, *http.Response, error)
- func (a *SIEMApiService) SiemUpdate(ctx context.Context, name string, body DsvSiemCreateUpdateRequestModel) (DsvSiemResponse, *http.Response, error)
- type SecretsApiDeleteSecretOpts
- type SecretsApiGetSecretDescriptionOpts
- type SecretsApiGetSecretOpts
- type SecretsApiListSecretPathsOpts
- type SecretsApiSearchSecretsOpts
- type SecretsApiService
- func (a *SecretsApiService) CreateSecret(ctx context.Context, path string, body DsvSecretCreate) (DsvSecretResponse, *http.Response, error)
- func (a *SecretsApiService) DeleteSecret(ctx context.Context, path string, ...) (DsvMessageResponse, *http.Response, error)
- func (a *SecretsApiService) GetSecret(ctx context.Context, path string, localVarOptionals *SecretsApiGetSecretOpts) (DsvSecretResponse, *http.Response, error)
- func (a *SecretsApiService) GetSecretByVersion(ctx context.Context, path string, version int64) (DsvSecretVersionResponse, *http.Response, error)
- func (a *SecretsApiService) GetSecretDescription(ctx context.Context, path string, ...) (DsvSecretDescription, *http.Response, error)
- func (a *SecretsApiService) ListSecretPaths(ctx context.Context, path string, ...) (DsvSecretListPathsResponse, *http.Response, error)
- func (a *SecretsApiService) RollbackSecret(ctx context.Context, path string, version int64) (DsvSecretVersionResponse, *http.Response, error)
- func (a *SecretsApiService) SearchSecrets(ctx context.Context, localVarOptionals *SecretsApiSearchSecretsOpts) (DsvSecretSearch, *http.Response, error)
- func (a *SecretsApiService) UpdateSecret(ctx context.Context, path string, body DsvSecretUpdate) (DsvSecretResponse, *http.Response, error)
- type SettingsApiDeleteAuthSettingsOpts
- type SettingsApiSearchSettingsOpts
- type SettingsApiService
- func (a *SettingsApiService) CreateAuthSettings(ctx context.Context, body DsvAuthenticationSettingsCreateModel) (DsvAuthenticationSettingsResponse, *http.Response, error)
- func (a *SettingsApiService) DeleteAuthSettings(ctx context.Context, name string, ...) (DsvMessageResponse, *http.Response, error)
- func (a *SettingsApiService) GetAuthSettings(ctx context.Context, name string) (DsvAuthenticationSettingsResponse, *http.Response, error)
- func (a *SettingsApiService) GetAuthSettingsByVersion(ctx context.Context, name string, version int64) (DsvAuthenticationSettingsVersionResponse, *http.Response, error)
- func (a *SettingsApiService) RestoreAuthSettings(ctx context.Context, name string) (*http.Response, error)
- func (a *SettingsApiService) RollbackAuthSettings(ctx context.Context, name string, version int64) (DsvAuthenticationSettingsResponse, *http.Response, error)
- func (a *SettingsApiService) SearchSettings(ctx context.Context, localVarOptionals *SettingsApiSearchSettingsOpts) (DsvAuthenticationSettingsSearchResponse, *http.Response, error)
- func (a *SettingsApiService) UpdateAuthSettings(ctx context.Context, name string, body DsvAuthenticationDetailsModel) (DsvAuthenticationSettingsResponse, *http.Response, error)
- type TasksApiService
- type TokensApiService
- func (a *TokensApiService) InitCertAuth(ctx context.Context, clientCertificate string) (DsvInitiateCertAuthResponse, *http.Response, error)
- func (a *TokensApiService) Revoke(ctx context.Context, refreshtoken string) (*http.Response, error)
- func (a *TokensApiService) Token(ctx context.Context, grantType string, localVarOptionals *TokensApiTokenOpts) (DsvAccessTokenResponse, *http.Response, error)
- type TokensApiTokenOpts
- type UsageApiGetUsageOpts
- type UsageApiService
- type UsersApiDeleteUserOpts
- type UsersApiSearchUsersOpts
- type UsersApiService
- func (a *UsersApiService) AddToGroups(ctx context.Context, name string, body DsvAddToGroupsRequest) (DsvAddToGroupsResponse, *http.Response, error)
- func (a *UsersApiService) ChangePassword(ctx context.Context, name string, body DsvPasswordChangeModel) (DsvMessageResponse, *http.Response, error)
- func (a *UsersApiService) CreateUser(ctx context.Context, body DsvUserCreateModel) (DsvUserResponse, *http.Response, error)
- func (a *UsersApiService) DeleteUser(ctx context.Context, name string, localVarOptionals *UsersApiDeleteUserOpts) (DsvMessageResponse, *http.Response, error)
- func (a *UsersApiService) GetMember(ctx context.Context, name string) (DsvMemberResponse, *http.Response, error)
- func (a *UsersApiService) GetUser(ctx context.Context, name string) (DsvUserResponse, *http.Response, error)
- func (a *UsersApiService) GetUserByVersion(ctx context.Context, name string, version int64) (DsvUserVersionResponse, *http.Response, error)
- func (a *UsersApiService) RestoreUser(ctx context.Context, name string) (*http.Response, error)
- func (a *UsersApiService) SearchUsers(ctx context.Context, localVarOptionals *UsersApiSearchUsersOpts) (DsvUserSearch, *http.Response, error)
- func (a *UsersApiService) UpdateUser(ctx context.Context, name string, body DsvUserUpdateModel) (DsvUserResponse, *http.Response, error)
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes a oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct {
AuditApi *AuditApiService
BreakGlassApi *BreakGlassApiService
ClientsApi *ClientsApiService
ConfigApi *ConfigApiService
EaaSAutoApi *EaaSAutoApiService
EaaSManualApi *EaaSManualApiService
EnginesApi *EnginesApiService
GroupsApi *GroupsApiService
HomeApi *HomeApiService
KeyApi *KeyApiService
PKIApi *PKIApiService
PoliciesApi *PoliciesApiService
PoolsApi *PoolsApiService
RolesApi *RolesApiService
SIEMApi *SIEMApiService
SecretsApi *SecretsApiService
SettingsApi *SettingsApiService
TasksApi *TasksApiService
TokensApi *TokensApiService
UsageApi *UsageApiService
UsersApi *UsersApiService
// contains filtered or unexported fields
}
APIClient manages communication with the DevOps Secrets Vault API API v1.0.0 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
Change base path to allow switching to mocks
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct {
*http.Response `json:"-"`
Message string `json:"message,omitempty"`
// Operation is the name of the swagger operation.
Operation string `json:"operation,omitempty"`
// RequestURL is the request URL. This value is always available, even if the
// embedded *http.Response is nil.
RequestURL string `json:"url,omitempty"`
// Method is the HTTP method used for the request. This value is always
// available, even if the embedded *http.Response is nil.
Method string `json:"method,omitempty"`
// Payload holds the contents of the response body (which may be nil or empty).
// This is provided here as the raw response.Body() reader will have already
// been drained.
Payload []byte `json:"-"`
}
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
type AuditApiFindAuditOpts ¶
type AuditApiService ¶
type AuditApiService service
func (*AuditApiService) DownloadAudit ¶
func (a *AuditApiService) DownloadAudit(ctx context.Context, startDate string, endDate string) (string, *http.Response, error)
AuditApiService Download Audit Records Download a zip of audit records for a time range
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param startDate The start date to find audits from
- @param endDate The end date to find audits to
@return string
func (*AuditApiService) FindAudit ¶
func (a *AuditApiService) FindAudit(ctx context.Context, localVarOptionals *AuditApiFindAuditOpts) (DsvLogSearchResponse, *http.Response, error)
type BasicAuth ¶
type BasicAuth struct {
UserName string `json:"userName,omitempty"`
Password string `json:"password,omitempty"`
}
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type BreakGlassApiService ¶
type BreakGlassApiService service
func (*BreakGlassApiService) ApplyRequest ¶
func (a *BreakGlassApiService) ApplyRequest(ctx context.Context, shares []string) (DsvApplyResponse, *http.Response, error)
BreakGlassApiService Apply Apply secret shares to break glass and give users admin rights
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param shares
@return DsvApplyResponse
func (*BreakGlassApiService) GenerateRequest ¶
func (a *BreakGlassApiService) GenerateRequest(ctx context.Context, newAdmins []string, minNumberOfShares int64) (DsvGenerateResponse, *http.Response, error)
BreakGlassApiService Generate Generate a new break glass secret and shares
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param newAdmins
- @param minNumberOfShares
@return DsvGenerateResponse
func (*BreakGlassApiService) GetStatus ¶
func (a *BreakGlassApiService) GetStatus(ctx context.Context) (DsvStatusResponse, *http.Response, error)
BreakGlassApiService Get Status Get break glass status
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return DsvStatusResponse
type ClientsApiService ¶
type ClientsApiService service
func (*ClientsApiService) CreateClientCredential ¶
func (a *ClientsApiService) CreateClientCredential(ctx context.Context, body DsvClientCreate) (DsvClientCredentialsResponse, *http.Response, error)
ClientsApiService Create a Client Credential Request a new client credential for a role and get back the client id and secret key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvClientCredentialsResponse
func (*ClientsApiService) DeleteClientCredential ¶
func (a *ClientsApiService) DeleteClientCredential(ctx context.Context, clientId string, localVarOptionals *ClientsApiDeleteClientCredentialOpts) (DsvMessageResponse, *http.Response, error)
func (*ClientsApiService) GetBootstrapClientCredential ¶
func (a *ClientsApiService) GetBootstrapClientCredential(ctx context.Context) (DsvClientCredentialsResponse, *http.Response, error)
ClientsApiService Get a Client Bootstrap Credential including secret Get a client credential by url.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return DsvClientCredentialsResponse
func (*ClientsApiService) GetClientCredential ¶
func (a *ClientsApiService) GetClientCredential(ctx context.Context, clientId string) (DsvClientCredentialsResponse, *http.Response, error)
ClientsApiService Get a Client Credential Get a client credential by client id. The secret key is omitted.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clientId ClientId property of the client credentials
@return DsvClientCredentialsResponse
func (*ClientsApiService) RestoreClient ¶
func (a *ClientsApiService) RestoreClient(ctx context.Context, clientId string) (*http.Response, error)
ClientsApiService Restore a Client Restore a client by ID.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clientId ClientId property of the client credentials
func (*ClientsApiService) SearchClients ¶
func (a *ClientsApiService) SearchClients(ctx context.Context, role string, localVarOptionals *ClientsApiSearchClientsOpts) (DsvClientSearchModel, *http.Response, error)
type ConfigApiService ¶
type ConfigApiService service
func (*ConfigApiService) GetConfig ¶
func (a *ConfigApiService) GetConfig(ctx context.Context) (DsvConfigResponse, *http.Response, error)
ConfigApiService Get Config Get config data.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return DsvConfigResponse
func (*ConfigApiService) GetConfigByVersion ¶
func (a *ConfigApiService) GetConfigByVersion(ctx context.Context, version int64) (DsvConfigVersionResponse, *http.Response, error)
ConfigApiService Get Config By Version Get zero or more representations of config specified by version number.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param version Versions to return
@return DsvConfigVersionResponse
func (*ConfigApiService) PostConfig ¶
func (a *ConfigApiService) PostConfig(ctx context.Context, body DsvPostConfigModel) (DsvConfigResponse, *http.Response, error)
ConfigApiService Create Config Create or update config.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvConfigResponse
type Configuration ¶
type Configuration struct {
BasePath string `json:"basePath,omitempty"`
Host string `json:"host,omitempty"`
Scheme string `json:"scheme,omitempty"`
DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
UserAgent string `json:"userAgent,omitempty"`
HTTPClient *http.Client
}
func NewConfiguration ¶
func NewConfiguration() *Configuration
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
type DsvAccessTokenResponse ¶
type DsvAccessTokenResponse struct {
// JWT access token for authorized requests
AccessToken string `json:"accessToken,omitempty"`
// Seconds until access token expires
ExpiresIn int64 `json:"expiresIn,omitempty"`
// Refresh token that can be used to get a new access token
RefreshToken string `json:"refreshToken,omitempty"`
// Token type
TokenType string `json:"tokenType,omitempty"`
}
AccessTokenResponse contains the bearer access token for accessing authorized endpoints
type DsvAddMemberResponse ¶
type DsvAddMemberResponse struct {
AddedMemberNames []string `json:"addedMemberNames,omitempty"`
Errors map[string]string `json:"errors,omitempty"`
}
AddMemberResponse for Add members response
type DsvAddToGroupsRequest ¶
type DsvAddToGroupsRequest struct {
// List of group names
GroupNames []string `json:"groupNames,omitempty"`
}
AddToGroupsRequest to add user to a list of groups
type DsvAddToGroupsResponse ¶
AddToGroupsResponse to add user to a list of groups
type DsvApplyResponse ¶
type DsvApplyResponse struct {
Status string `json:"status,omitempty"`
}
type DsvAudit ¶
type DsvAudit struct {
// Action performed
Action string `json:"action,omitempty"`
// Audit created date
Created time.Time `json:"created,omitempty"`
// Audit id
Id string `json:"id,omitempty"`
// IP Address logged from client
Ipaddress string `json:"ipaddress,omitempty"`
// Message additional details
Message string `json:"message,omitempty"`
// Resource path action performed on
Path string `json:"path,omitempty"`
// Security principal that performed action
Principal string `json:"principal,omitempty"`
// Principal item ID
PrincipalItemId string `json:"principalItemId,omitempty"`
// Http status code
Status int64 `json:"status,omitempty"`
// Tenant ID
Tenant string `json:"tenant,omitempty"`
// Tenant Name
TenantName string `json:"tenantName,omitempty"`
}
Audit model
type DsvAuthProperties ¶
type DsvAuthProperties struct {
AccountId string `json:"accountId,omitempty"`
BaseUri string `json:"baseUri,omitempty"`
ClientEmail string `json:"clientEmail,omitempty"`
ClientId string `json:"clientId,omitempty"`
ClientSecret string `json:"clientSecret,omitempty"`
Default_ bool `json:"default,omitempty"`
PrivateKey string `json:"privateKey,omitempty"`
PrivateKeyId string `json:"privateKeyId,omitempty"`
ProjectId string `json:"projectId,omitempty"`
SendWelcomeEmail bool `json:"sendWelcomeEmail,omitempty"`
TenantId string `json:"tenantId,omitempty"`
TokenUri string `json:"tokenUri,omitempty"`
Type_ string `json:"type,omitempty"`
UsernameClaim string `json:"usernameClaim,omitempty"`
}
type DsvAuthentication ¶
type DsvAuthentication struct {
ID string `json:"ID,omitempty"`
Name string `json:"name,omitempty"`
Properties *DsvAuthProperties `json:"properties,omitempty"`
Type_ string `json:"type,omitempty"`
}
Authentication is the 3rd party authentication providers
type DsvAuthenticationDetailsModel ¶
type DsvAuthenticationDetailsModel struct {
Properties *DsvAuthenticationProviderPropertiesModel `json:"properties,omitempty"`
// AuthenticationSettings provider system type.
Type_ string `json:"type,omitempty"`
}
type DsvAuthenticationProviderPropertiesModel ¶
type DsvAuthenticationProviderPropertiesModel struct {
AccountId string `json:"accountId,omitempty"`
BaseUri string `json:"baseUri,omitempty"`
ClientEmail string `json:"clientEmail,omitempty"`
ClientId string `json:"clientId,omitempty"`
ClientSecret string `json:"clientSecret,omitempty"`
Default_ bool `json:"default,omitempty"`
PrivateKey string `json:"privateKey,omitempty"`
PrivateKeyId string `json:"privateKeyId,omitempty"`
ProjectId string `json:"projectId,omitempty"`
SendWelcomeEmail bool `json:"sendWelcomeEmail,omitempty"`
TenantId string `json:"tenantId,omitempty"`
TokenUri string `json:"tokenUri,omitempty"`
Type_ string `json:"type,omitempty"`
UsernameClaim string `json:"usernameClaim,omitempty"`
}
type DsvAuthenticationSettingsCreateModel ¶
type DsvAuthenticationSettingsCreateModel struct {
// Name of authentication provider.
Name string `json:"name"`
Properties *DsvAuthenticationProviderPropertiesModel `json:"properties,omitempty"`
// AuthenticationSettings provider system type.
Type_ string `json:"type,omitempty"`
}
type DsvAuthenticationSettingsResponse ¶
type DsvAuthenticationSettingsResponse struct {
Created string `json:"created,omitempty"`
CreatedBy string `json:"createdBy,omitempty"`
Id string `json:"id,omitempty"`
LastModified string `json:"lastModified,omitempty"`
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
Name string `json:"name,omitempty"`
Properties *DsvAuthenticationProviderPropertiesModel `json:"properties,omitempty"`
// AuthenticationSettings provider system type.
Type_ string `json:"type,omitempty"`
Version string `json:"version,omitempty"`
}
type DsvAuthenticationSettingsSearchResponse ¶
type DsvAuthenticationSettingsSearchResponse struct {
// Cursor to next batch of results.
Cursor string `json:"cursor,omitempty"`
// AuthenticationSettings settings that match the search term.
Data []DsvAuthenticationSettingsResponse `json:"data,omitempty"`
// The number of results in this response.
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor.
Limit int64 `json:"limit,omitempty"`
}
type DsvAuthenticationSettingsVersionResponse ¶
type DsvAuthenticationSettingsVersionResponse struct {
// AuthenticationSettingsVersionResponse that match the version.
Data []DsvAuthenticationSettingsResponse `json:"data,omitempty"`
}
type DsvAutoKey ¶
type DsvAutoKey struct {
// Created date
Created string `json:"created,omitempty"`
// Who created the item
CreatedBy string `json:"createdBy,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
// Current version
Version string `json:"version,omitempty"`
}
type DsvAutoKeyResponse ¶
type DsvAutoKeyResponse struct {
// Created date
Created string `json:"created,omitempty"`
// Who created the item
CreatedBy string `json:"createdBy,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
// A path to a data-key managed by DSV
Path string `json:"path,omitempty"`
// Current version
Version string `json:"version,omitempty"`
}
AutoKeyResponse contains the metadata of a data key
type DsvClientCreate ¶
type DsvClientCreate struct {
// Client description
Description string `json:"description,omitempty"`
// Name of role to assign to client
Role string `json:"role"`
// TTL expiration in seconds
Ttl int64 `json:"ttl,omitempty"`
Url bool `json:"url,omitempty"`
UrlTTL int64 `json:"urlTTL,omitempty"`
// Uses the number of times the client credential can be read. if set to 0, it can be used infinitely. default is 0.
UsesLimit int64 `json:"usesLimit,omitempty"`
}
type DsvClientCredentialsResponse ¶
type DsvClientCredentialsResponse struct {
// TTL expiration in seconds
TTL int64 `json:"TTL,omitempty"`
// Url already used or not
Accessed string `json:"accessed,omitempty"`
// Unique uuid of client credentials
ClientId string `json:"clientId,omitempty"`
// Secret key returned on create
ClientSecret string `json:"clientSecret,omitempty"`
// Created date
Created string `json:"created,omitempty"`
// Who created
CreatedBy string `json:"createdBy,omitempty"`
Description string `json:"description,omitempty"`
// ExpiredAt expiration time
ExpiredAt string `json:"expiredAt,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
// Assigned role for determining access
Role string `json:"role,omitempty"`
Status string `json:"status,omitempty"`
// If Url requested
Url bool `json:"url,omitempty"`
// Url expiration time
UrlExpires string `json:"urlExpires,omitempty"`
// URL Path
UrlPath string `json:"urlPath,omitempty"`
// Url expiration in seconds
UrlTTL int64 `json:"urlTTL,omitempty"`
UsedCount int64 `json:"usedCount,omitempty"`
// Uses the number of times the client credential can be read. if set to 0, it can be used infinitely. default is 0.
UsesLimit int64 `json:"usesLimit,omitempty"`
}
ClientCredentials are used in the client_credentials authentication flow
type DsvClientSearchModel ¶
type DsvClientSearchModel struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// List of client credentials with a matching role
Data []DsvClientCredentialsResponse `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Total number of items
Total int64 `json:"total,omitempty"`
}
Client Credential search response with metadata
type DsvCondition ¶
type DsvCondition struct {
// GetName returns the condition's name.
GetName string `json:"GetName,omitempty"`
}
type DsvConditions ¶
type DsvConditions struct {
}
type DsvConfigResponse ¶
type DsvConfigResponse struct {
Created string `json:"created,omitempty"`
CreatedBy string `json:"createdBy,omitempty"`
LastModified string `json:"lastModified,omitempty"`
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
PermissionDocument []DsvDefaultPolicy `json:"permissionDocument,omitempty"`
RefreshTokenTTLHours int64 `json:"refreshTokenTTLHours,omitempty"`
Settings *DsvSettings `json:"settings,omitempty"`
TenantName string `json:"tenantName,omitempty"`
Version string `json:"version,omitempty"`
}
Document is the per-tenant configuration store
type DsvConfigVersionResponse ¶
type DsvConfigVersionResponse struct {
Data []DsvConfigResponse `json:"data,omitempty"`
}
type DsvCreateGroup ¶
type DsvDecryptionResponse ¶
type DsvDecryptionResponse struct {
Data string `json:"data,omitempty"`
// Path of the key with which decryption was performed
Path string `json:"path,omitempty"`
// Version of the key with which decryption was performed
Version string `json:"version,omitempty"`
}
DecryptionResponse contains data decrypted from ciphertext
type DsvDefaultPolicy ¶
type DsvDefaultPolicy struct {
Actions []string `json:"actions,omitempty"`
Conditions *DsvConditions `json:"conditions,omitempty"`
Description string `json:"description,omitempty"`
Effect string `json:"effect,omitempty"`
Id string `json:"id,omitempty"`
Meta []int32 `json:"meta,omitempty"`
Resources []string `json:"resources,omitempty"`
Subjects []string `json:"subjects,omitempty"`
}
type DsvEncryptionResponse ¶
type DsvEncryptionResponse struct {
Ciphertext []int32 `json:"ciphertext,omitempty"`
// Path of the key with which encryption was performed
Path string `json:"path,omitempty"`
// Version of the key with which encryption was performed
Version string `json:"version,omitempty"`
}
EncryptionResponse contains ciphertext produced from encrypting a plaintext string with a key
type DsvEngineCreate ¶
type DsvEngineCreateResponse ¶
type DsvEngineCreateResponse struct {
// Created date
Created string `json:"created,omitempty"`
// Who created the item
CreatedBy string `json:"createdBy,omitempty"`
Endpoint string `json:"endpoint,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
LastHeartbeat string `json:"lastHeartbeat,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
Name string `json:"name,omitempty"`
PoolName string `json:"poolName,omitempty"`
PrivateKey string `json:"privateKey,omitempty"`
PublicKey string `json:"publicKey,omitempty"`
// Current version
Version string `json:"version,omitempty"`
}
Initialized engine and corresponding public / private key pair for signing engine tokens
type DsvEngineGetResponse ¶
type DsvEngineGetResponse struct {
// Created date
Created string `json:"created,omitempty"`
// Who created the item
CreatedBy string `json:"createdBy,omitempty"`
Endpoint string `json:"endpoint,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
LastHeartbeat string `json:"lastHeartbeat,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
Name string `json:"name,omitempty"`
PoolName string `json:"poolName,omitempty"`
PublicKey string `json:"publicKey,omitempty"`
// Current version
Version string `json:"version,omitempty"`
}
Engine is the stored record
type DsvEngineListResult ¶
type DsvEnginePingResponse ¶
type DsvEnginePingResponse struct {
Message string `json:"message,omitempty"`
}
type DsvEngineSearchResponse ¶
type DsvEngineSearchResponse struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// Policies that match the search term
Data []DsvEngineGetResponse `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Sort order
Sort string `json:"sort,omitempty"`
}
Search results response
type DsvGenerateResponse ¶
type DsvGroup ¶
type DsvGroup struct {
// Name
GroupName string `json:"groupName,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
// Members
Members []string `json:"members,omitempty"`
// MetaData
MetaData []map[string]string `json:"metaData,omitempty"`
// Total number of members
Total int64 `json:"total,omitempty"`
}
type DsvGroupMemberInfo ¶
type DsvGroupResponse ¶
type DsvGroupResponse struct {
// Created date
Created string `json:"created,omitempty"`
// Who created
CreatedBy string `json:"createdBy,omitempty"`
// Name
GroupName string `json:"groupName,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
// Members
Members []string `json:"members,omitempty"`
// MetaData
MetaData []map[string]string `json:"metaData,omitempty"`
// Total number of members
Total int64 `json:"total,omitempty"`
Version string `json:"version,omitempty"`
}
GroupResponse response with metadata
type DsvGroupSearch ¶
type DsvGroupSearch struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// Groups that match the search term
Data []DsvGroupResponse `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Sort order
Sort string `json:"sort,omitempty"`
// Total number of items
Total int64 `json:"total,omitempty"`
}
Group search response with metadata
type DsvHttpError ¶
type DsvHttpError struct {
// HTTP status code
Code int64 `json:"code,omitempty"`
Errors map[string][]string `json:"errors,omitempty"`
// Detailed error message
Message string `json:"message,omitempty"`
}
HTTPError contains the status code and a detailed error message
type DsvInitiateCertAuthResponse ¶
type DsvInitiateCertAuthResponse struct {
// Challenge id
CertChallengeId string `json:"cert_challenge_id,omitempty"`
// Encrypted and base64 encoded challenge
Encrypted string `json:"encrypted,omitempty"`
}
InitiateCertAuthResponse contains challenge to decrypt and challenge id
type DsvLogSearchResponse ¶
type DsvLogSearchResponse struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// List of matching records
Data []DsvAudit `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Number of all items that match the criteria.
TotalItems int64 `json:"totalItems,omitempty"`
}
type DsvManualKeyData ¶
type DsvManualKeyData struct {
Metadata map[string]interface{} `json:"metadata,omitempty"`
// Base64 encoded nonce to be used with key. If not provided, DSV generates it for the user.
Nonce string `json:"nonce,omitempty"`
// Base64 encoded private key
PrivateKey string `json:"privateKey"`
// Encryption scheme to be used.
Scheme string `json:"scheme"`
}
type DsvMasterkey ¶
type DsvMemberRequest ¶
type DsvMemberRequest struct {
// Names
MemberNames []string `json:"memberNames,omitempty"`
}
MemberRequest to add users to or delete from a group
type DsvMemberResponse ¶
type DsvMemberResponse struct {
// Groups information
Groups []DsvGroupMemberInfo `json:"groups,omitempty"`
// Name
Name string `json:"name,omitempty"`
// Total number of items
Total int64 `json:"total,omitempty"`
}
MemberResponse for member response
type DsvMessageResponse ¶
type DsvMessageResponse struct {
Message string `json:"message,omitempty"`
}
MessageResponse is a generic response that includes a message for the user
type DsvPasswordChangeModel ¶
type DsvPasswordChangeModel struct {
// The user's current password
CurrentPassword string `json:"currentPassword"`
// The new password to use
NewPassword string `json:"newPassword"`
}
PasswordChange model for submitting password change requests
type DsvPolicyCreate ¶
type DsvPolicyCreate struct {
Path string `json:"path"`
Policy string `json:"policy"`
Serialization string `json:"serialization,omitempty"`
}
PolicyCreate struct
type DsvPolicyResponse ¶
type DsvPolicyResponse struct {
// Created date
Created string `json:"created,omitempty"`
// Who created the item
CreatedBy string `json:"createdBy,omitempty"`
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
Path string `json:"path,omitempty"`
PermissionDocument []DsvDefaultPolicy `json:"permissionDocument,omitempty"`
// Current version
Version string `json:"version,omitempty"`
}
Policy is a named set of permissions
type DsvPolicySearchResponse ¶
type DsvPolicySearchResponse struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// Policies that match the search term
Data []DsvPolicyResponse `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Sort order
Sort string `json:"sort,omitempty"`
}
Search results response
type DsvPolicyUpdate ¶
type DsvPolicyUpdate struct {
Policy string `json:"policy"`
Serialization string `json:"serialization,omitempty"`
}
PolicyUpdate struct
type DsvPolicyVersionResponse ¶
type DsvPolicyVersionResponse struct {
// Policies that match the version
Data []DsvPolicyResponse `json:"data,omitempty"`
}
Version results response
type DsvPool ¶
type DsvPool struct {
// Created date
Created string `json:"created,omitempty"`
// Who created the item
CreatedBy string `json:"createdBy,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
Name string `json:"name,omitempty"`
// Current version
Version string `json:"version,omitempty"`
}
Created Engine Pool
type DsvPoolCreate ¶
type DsvPoolCreate struct {
// Name of engine pool
Name string `json:"name"`
}
type DsvPoolListResult ¶
type DsvPoolListResult struct {
Name string `json:"name,omitempty"`
}
type DsvPostConfigModel ¶
type DsvResponseCertificate ¶
type DsvResponseSshCertificate ¶
type DsvResponseSshCertificate struct {
SshCertificate string `json:"sshCertificate,omitempty"`
}
type DsvRoleCreate ¶
type DsvRoleCreate struct {
// Role description
Description string `json:"description,omitempty"`
// External identifier, such as an AWS arn for 3rd party authentication
ExternalId string `json:"externalId,omitempty"`
// Name of role
Name string `json:"name"`
// Provider name defined in the authentication settings section of configuration
Provider string `json:"provider,omitempty"`
}
type DsvRoleDetailsModel ¶
type DsvRoleDetailsModel struct {
// Role description
Description string `json:"description,omitempty"`
// External identifier, such as an AWS arn for 3rd party authentication
ExternalId string `json:"externalId,omitempty"`
// Provider name defined in the authentication settings section of configuration
Provider string `json:"provider,omitempty"`
}
RoleDetails defines the editable properties of a Role
type DsvRoleResponse ¶
type DsvRoleResponse struct {
// Created date
Created string `json:"created,omitempty"`
// Who created
CreatedBy string `json:"createdBy,omitempty"`
// Role description
Description string `json:"description,omitempty"`
// External identifier, such as an AWS arn for 3rd party authentication
ExternalId string `json:"externalId,omitempty"`
Groups []string `json:"groups,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
// Name of role
Name string `json:"name"`
// Provider name defined in the authentication settings section of configuration
Provider string `json:"provider,omitempty"`
Version string `json:"version,omitempty"`
}
Role defines the role security principal and any mappings to 3rd party providers
type DsvRoleSearchResponse ¶
type DsvRoleSearchResponse struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// List of matching roles
Data []DsvRoleResponse `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Total number of items
Total int64 `json:"total,omitempty"`
}
Role search response with metadata
type DsvRoleVersionResponse ¶
type DsvRoleVersionResponse struct {
Data *DsvRoles `json:"data,omitempty"`
}
type DsvRootCaRegistration ¶
type DsvRootCaRegistration struct {
CommonName string `json:"commonName"`
Country string `json:"country,omitempty"`
// URL of the CRL from which the revocation of leaf certificates can be checked
Crl string `json:"crl,omitempty"`
Description string `json:"description,omitempty"`
// List of domains for which certificate signing is allowed
Domains []string `json:"domains"`
EmailAddress string `json:"emailAddress,omitempty"`
Locality string `json:"locality,omitempty"`
// Maximum TTL of a signed certificate issued from a given root CA (in hours)
MaxTTL int64 `json:"maxTTL"`
Organization string `json:"organization,omitempty"`
OrganizationalUnit string `json:"organizationalUnit,omitempty"`
// The name of the secret containing the root CA certificate
RootCAPath string `json:"rootCAPath"`
State string `json:"state,omitempty"`
// The name of the secret in which to store the generated certificate and private key
StorePath string `json:"storePath,omitempty"`
}
type DsvRootCaSecret ¶
type DsvRootCaSecret struct {
// Certificate of the root CA that contains information about it and public key
Certificate string `json:"certificate"`
// URL of the CRL from which the revocation of leaf certificates can be checked
Crl string `json:"crl,omitempty"`
// List of domains for which certificate signing is allowed
Domains []string `json:"domains"`
// Maximum TTL of a signed certificate issued from a given root CA (in hours)
MaxTTL int64 `json:"maxTTL"`
// Private key of the root CA
PrivateKey string `json:"privateKey"`
// RootCAPath to secret, which also serves as an identifier of the root CA
RootCAPath string `json:"rootCAPath"`
}
type DsvSecretCreate ¶
type DsvSecretDescription ¶
type DsvSecretDescription struct {
// The user defined metadata
Attributes map[string]interface{} `json:"attributes,omitempty"`
// Created date
Created string `json:"created,omitempty"`
// Who created
CreatedBy string `json:"createdBy,omitempty"`
// Description of secret
Description string `json:"description,omitempty"`
// The unique id for this item
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
// The path the secret is located at
Path string `json:"path,omitempty"`
Version string `json:"version,omitempty"`
}
ResponseModelDescription contains metadata but not the sensitive secret data
type DsvSecretListPathsResponse ¶
type DsvSecretListPathsResponse struct {
// Matching secret paths
Data []string `json:"data,omitempty"`
}
type DsvSecretResponse ¶
type DsvSecretResponse struct {
// The user defined metadata
Attributes map[string]interface{} `json:"attributes,omitempty"`
// Created date
Created string `json:"created,omitempty"`
// Who created
CreatedBy string `json:"createdBy,omitempty"`
// The sensitive secret info, such as a password or key
Data map[string]interface{} `json:"data,omitempty"`
// Description of secret
Description string `json:"description,omitempty"`
// The unique id for this item
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
// The path the secret is located at
Path string `json:"path,omitempty"`
Version string `json:"version,omitempty"`
}
ResponseModelFull contains the sensitive secret data along with secret metadata
type DsvSecretSearch ¶
type DsvSecretSearch struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// The returned secret descriptions
Data []DsvSecretDescription `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Sort order
Sort string `json:"sort,omitempty"`
// Total number of items
Total int64 `json:"total,omitempty"`
}
Secret search response with metadata
type DsvSecretUpdate ¶
type DsvSecretUpdate struct {
// The user defined metadata
Attributes map[string]interface{} `json:"attributes,omitempty"`
// The secret data
Data map[string]interface{} `json:"data,omitempty"`
// The secret's description
Description string `json:"description,omitempty"`
// Overwrite data and description on update
Overwrite bool `json:"overwrite,omitempty"`
}
type DsvSecretVersionResponse ¶
type DsvSecretVersionResponse struct {
Data []DsvSecretResponse `json:"data,omitempty"`
}
type DsvSettings ¶
type DsvSettings struct {
Authentication []DsvAuthentication `json:"authentication,omitempty"`
}
Settings is the per tenant app config settings
type DsvSiemCreateUpdateRequestModel ¶
type DsvSiemCreateUpdateRequestModel struct {
// Denotes whether the endpoint can use self signed root certifcate for handshake (only for https protocol)
AllowSelfSigned bool `json:"allowSelfSigned,omitempty"`
// Authentication token
Auth string `json:"auth"`
// Authentication method (token)
AuthMethod string `json:"authMethod"`
// Endpoint
Endpoint string `json:"endpoint,omitempty"`
// Collect Server IP/FQDN
Host string `json:"host"`
// Logging Format (i.e. syslog (RFC 5424))
LoggingFormat string `json:"loggingFormat"`
// Name of registered SIEM endpoint, similar to path
Name string `json:"name"`
// Engine pool name, used when sending request to a DSV engine instance
Pool string `json:"pool,omitempty"`
// Port
Port int64 `json:"port"`
// Type of protocol (i.e. TCP, UDP)
Protocol string `json:"protocol"`
// Denotes whether the endpoint should be accessed through a DSV engine instance
SendToEngine bool `json:"sendToEngine,omitempty"`
// Type of endpoint (\"syslog\", \"cef\", \"json\", \"splunk\")
SiemType string `json:"siemType"`
}
type DsvSiemNoSensitiveResponseModel ¶
type DsvSiemNoSensitiveResponseModel struct {
// Denotes whether the endpoint can use self signed root certifcate for handshake (only for https protocol)
AllowSelfSigned bool `json:"allowSelfSigned,omitempty"`
// Authentication method (token)
AuthMethod string `json:"authMethod,omitempty"`
// Endpoint
Endpoint string `json:"endpoint,omitempty"`
// Failed is true if send has failed too many times, false otherwise
Failed bool `json:"failed,omitempty"`
// Number of failed send events
FailedEvents int64 `json:"failedEvents,omitempty"`
// Collect Server IP/FQDN
Host string `json:"host,omitempty"`
// The unique id for this item
Id string `json:"id,omitempty"`
// Logging format (e.g. \"rfc5424\" for syslog)
LoggingFormat string `json:"loggingFormat,omitempty"`
// Name of registered SIEM endpoint, similar to path
Name string `json:"name,omitempty"`
// Engine pool name, used when sending request to a DSV engine instance
Pool string `json:"pool,omitempty"`
// Collect Server Port
Port int64 `json:"port,omitempty"`
// Type of protocol (\"tcp\", \"udp\", \"http\", \"https\", \"tls\")
Protocol string `json:"protocol,omitempty"`
// Denotes whether the endpoint should be accessed through a DSV engine instance
SendToEngine bool `json:"sendToEngine,omitempty"`
// Type of endpoint (\"syslog\", \"cef\", \"json\", \"splunk\")
SiemType string `json:"siemType,omitempty"`
}
type DsvSiemResponse ¶
type DsvSiemResponse struct {
// Denotes whether the endpoint can use self signed root certifcate for handshake (only for https protocol)
AllowSelfSigned bool `json:"allowSelfSigned,omitempty"`
// Authentication token
Auth string `json:"auth,omitempty"`
// Authentication method (token)
AuthMethod string `json:"authMethod,omitempty"`
// Endpoint
Endpoint string `json:"endpoint,omitempty"`
// Failed is true if send has failed too many times, false otherwise
Failed bool `json:"failed,omitempty"`
// Number of failed send events
FailedEvents int64 `json:"failedEvents,omitempty"`
// Collect Server IP/FQDN
Host string `json:"host,omitempty"`
// The unique id for this item
Id string `json:"id,omitempty"`
// Logging format (e.g. \"rfc5424\" for syslog)
LoggingFormat string `json:"loggingFormat,omitempty"`
// Name of registered SIEM endpoint, similar to path
Name string `json:"name,omitempty"`
// Engine pool name, used when sending request to a DSV engine instance
Pool string `json:"pool,omitempty"`
// Collect Server Port
Port int64 `json:"port,omitempty"`
// Type of protocol (\"tcp\", \"udp\", \"http\", \"https\", \"tls\")
Protocol string `json:"protocol,omitempty"`
// Denotes whether the endpoint should be accessed through a DSV engine instance
SendToEngine bool `json:"sendToEngine,omitempty"`
// Type of endpoint (\"syslog\", \"cef\", \"json\", \"splunk\")
SiemType string `json:"siemType,omitempty"`
}
type DsvSiemSearchResponse ¶
type DsvSiemSearchResponse struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// List of matching siems
Data []DsvSiemNoSensitiveResponseModel `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Total number of items
Total int64 `json:"total,omitempty"`
}
type DsvSigningRequest ¶
type DsvSigningRequest struct {
// Boolean indicating whether to return a root certificate
Chain bool `json:"chain,omitempty"`
// Certificate Signing Request
Csr string `json:"csr"`
// Path to secret - registered root CA
RootCAPath string `json:"rootCAPath"`
// A list of Subject Alternative Names for a certificate (each domain must be present in the list of allowed domains)
SubjectAltNames []string `json:"subjectAltNames,omitempty"`
// TTL for a generated certificate (in hours, cannot exceed the maximum TTL specified in root CA secret)
Ttl int64 `json:"ttl,omitempty"`
}
type DsvSigningRequestInformation ¶
type DsvSigningRequestInformation struct {
// Boolean indicating whether to return a root certificate
Chain bool `json:"chain,omitempty"`
CommonName string `json:"commonName"`
Country string `json:"country,omitempty"`
Description string `json:"description,omitempty"`
EmailAddress string `json:"emailAddress,omitempty"`
Locality string `json:"locality,omitempty"`
Organization string `json:"organization,omitempty"`
OrganizationalUnit string `json:"organizationalUnit,omitempty"`
// The name of the secret containing the root CA certificate
RootCAPath string `json:"rootCAPath"`
State string `json:"state,omitempty"`
// The name of the secret in which to store the generated certificate and private key
StorePath string `json:"storePath,omitempty"`
// TTL for a generated certificate (in hours, cannot exceed the maximum TTL specified in root CA secret)
Ttl int64 `json:"ttl,omitempty"`
}
type DsvSshCertInformation ¶
type DsvSshCertInformation struct {
// Path to secret containing leaf certificate
LeafCAPath string `json:"leafCAPath"`
// A list of principals on a certificate (user or host names)
Principals []string `json:"principals"`
// Path to secret containing root certificate
RootCAPath string `json:"rootCAPath"`
// TTL for a generated certificate (in hours)
Ttl int64 `json:"ttl"`
}
type DsvStatusResponse ¶
type DsvStatusResponse struct {
Status string `json:"status,omitempty"`
}
type DsvTaskResult ¶
type DsvTaskResult struct {
Type_ string `json:"type,omitempty"`
Value interface{} `json:"value,omitempty"`
}
Any metadata values
type DsvTaskState ¶
type DsvTaskState struct {
CreatedAt time.Time `json:"createdAt,omitempty"`
Results []DsvTaskResult `json:"results,omitempty"`
State string `json:"state,omitempty"`
TaskName string `json:"taskName,omitempty"`
}
TaskState represents a state of a task
type DsvUpdateKeyRequest ¶
type DsvUsageResponseGeneral ¶
type DsvUsageResponseGeneral struct {
EndDate string `json:"endDate,omitempty"`
// Keys are days, values are numbers of API requests made that day.
RequestsUsed map[string]int64 `json:"requestsUsed,omitempty"`
StartDate string `json:"startDate,omitempty"`
TotalKeys int64 `json:"totalKeys,omitempty"`
TotalRequestsUsed int64 `json:"totalRequestsUsed,omitempty"`
TotalSecrets int64 `json:"totalSecrets,omitempty"`
}
type DsvUserCreateModel ¶
type DsvUserCreateModel struct {
// The display name of the user
DisplayName string `json:"displayName,omitempty"`
// External identifier, such as an AWS arn for 3rd party authentication
ExternalId string `json:"externalId,omitempty"`
// User's password (not required if using 3rd party auth)
Password string `json:"password,omitempty"`
// Provider name defined in the authentication settings section of configuration
Provider string `json:"provider,omitempty"`
// The name of the user
UserName string `json:"userName"`
}
Creation properties of a user
type DsvUserResponse ¶
type DsvUserResponse struct {
// Created date
Created string `json:"created,omitempty"`
// Who created
CreatedBy string `json:"createdBy,omitempty"`
// The display name of the user
DisplayName string `json:"displayName,omitempty"`
// External identifier, such as an AWS arn for 3rd party authentication
ExternalId string `json:"externalId,omitempty"`
// the id for this item
Id string `json:"id,omitempty"`
// Last updated date
LastModified string `json:"lastModified,omitempty"`
// Who performed the last modification
LastModifiedBy string `json:"lastModifiedBy,omitempty"`
// Provider name defined in the authentication settings section of configuration
Provider string `json:"provider,omitempty"`
// The name of the user
UserName string `json:"userName,omitempty"`
// Current version
Version string `json:"version,omitempty"`
}
User contains user data along with user metadata
type DsvUserSearch ¶
type DsvUserSearch struct {
// Cursor to next batch of results
Cursor string `json:"cursor,omitempty"`
// Users that match the search term
Data []DsvUserResponse `json:"data,omitempty"`
// The number of results in this response
Length int64 `json:"length,omitempty"`
// The maximum number of results per cursor
Limit int64 `json:"limit,omitempty"`
// Total number of items
Total int64 `json:"total,omitempty"`
}
User search response with metadata
type DsvUserUpdateModel ¶
type DsvUserUpdateModel struct {
// The display name of the user
DisplayName string `json:"displayName,omitempty"`
// User's password (not required if using 3rd party auth)
Password string `json:"password,omitempty"`
}
Editable properties of a user
type DsvUserVersionResponse ¶
type DsvUserVersionResponse struct {
Data []DsvUserResponse `json:"data,omitempty"`
}
type EaaSAutoApiDecryptOpts ¶
type EaaSAutoApiEncryptOpts ¶
type EaaSAutoApiService ¶
type EaaSAutoApiService service
func (*EaaSAutoApiService) CreateKey ¶
func (a *EaaSAutoApiService) CreateKey(ctx context.Context, path string) (DsvAutoKeyResponse, *http.Response, error)
EaaSAutoApiService Create Key Create a new encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full key path, for example, mykeys/key01
@return DsvAutoKeyResponse
func (*EaaSAutoApiService) Decrypt ¶
func (a *EaaSAutoApiService) Decrypt(ctx context.Context, path string, ciphertext []int32, localVarOptionals *EaaSAutoApiDecryptOpts) (DsvDecryptionResponse, *http.Response, error)
func (*EaaSAutoApiService) DeleteKey ¶
func (a *EaaSAutoApiService) DeleteKey(ctx context.Context, path string) (DsvMessageResponse, *http.Response, error)
EaaSAutoApiService Delete Key Delete an existing encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full key path, for example, mykeys/key01
@return DsvMessageResponse
func (*EaaSAutoApiService) Encrypt ¶
func (a *EaaSAutoApiService) Encrypt(ctx context.Context, path string, plaintext string, localVarOptionals *EaaSAutoApiEncryptOpts) (DsvEncryptionResponse, *http.Response, error)
func (*EaaSAutoApiService) GetKeyMetadata ¶
func (a *EaaSAutoApiService) GetKeyMetadata(ctx context.Context, path string) (DsvAutoKeyResponse, *http.Response, error)
EaaSAutoApiService Get Key Metadata Get metadata of an existing encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full key path, for example, mykeys/key01
@return DsvAutoKeyResponse
func (*EaaSAutoApiService) RestoreKey ¶
EaaSAutoApiService Restore Key Restore a soft-deleted encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full key path, for example, mykeys/key01
func (*EaaSAutoApiService) RotationRequest ¶
func (a *EaaSAutoApiService) RotationRequest(ctx context.Context, path string, ciphertext []int32, startingVersion string, localVarOptionals *EaaSAutoApiRotationRequestOpts) (DsvEncryptionResponse, *http.Response, error)
type EaaSManualApiService ¶
type EaaSManualApiService service
func (*EaaSManualApiService) DecryptWithManualKey ¶
func (a *EaaSManualApiService) DecryptWithManualKey(ctx context.Context, path string, ciphertext []int32, localVarOptionals *EaaSManualApiDecryptWithManualKeyOpts) (DsvDecryptionResponse, *http.Response, error)
func (*EaaSManualApiService) DeleteManualKey ¶
func (a *EaaSManualApiService) DeleteManualKey(ctx context.Context, path string) (DsvMessageResponse, *http.Response, error)
EaaSManualApiService Delete Key Delete an existing encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full key path, for example, mykeys/key01
@return DsvMessageResponse
func (*EaaSManualApiService) EncryptWithManualKey ¶
func (a *EaaSManualApiService) EncryptWithManualKey(ctx context.Context, path string, plaintext string, localVarOptionals *EaaSManualApiEncryptWithManualKeyOpts) (DsvEncryptionResponse, *http.Response, error)
func (*EaaSManualApiService) ReadManualKey ¶
func (a *EaaSManualApiService) ReadManualKey(ctx context.Context, path string) (DsvSecretResponse, *http.Response, error)
EaaSManualApiService Read Key Read existing encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full key path, for example, mykeys/key01
@return DsvSecretResponse
func (*EaaSManualApiService) RestoreManualKey ¶
func (a *EaaSManualApiService) RestoreManualKey(ctx context.Context, path string) (*http.Response, error)
EaaSManualApiService Restore Key Restore a soft-deleted encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full key path, for example, mykeys/key01
func (*EaaSManualApiService) UpdateKey ¶
func (a *EaaSManualApiService) UpdateKey(ctx context.Context, body DsvUpdateKeyRequest, path string) (DsvSecretResponse, *http.Response, error)
EaaSManualApiService Update Key Update an existing encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param path The full key path, for example, mykeys/key01
@return DsvSecretResponse
func (*EaaSManualApiService) UploadKey ¶
func (a *EaaSManualApiService) UploadKey(ctx context.Context, body DsvManualKeyData, path string) (DsvSecretResponse, *http.Response, error)
EaaSManualApiService Upload Key Upload a new encryption/decryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
- @param path The full key path, for example, mykeys/key01
@return DsvSecretResponse
type EnginesApiService ¶
type EnginesApiService service
func (*EnginesApiService) CreateEngine ¶
func (a *EnginesApiService) CreateEngine(ctx context.Context, body DsvEngineCreate) (DsvEngineCreateResponse, *http.Response, error)
EnginesApiService Create Engine Registers a new engine and returns its key pair.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvEngineCreateResponse
func (*EnginesApiService) DeleteEngine ¶
func (a *EnginesApiService) DeleteEngine(ctx context.Context, path string, localVarOptionals *EnginesApiDeleteEngineOpts) (DsvMessageResponse, *http.Response, error)
func (*EnginesApiService) GetEngine ¶
func (a *EnginesApiService) GetEngine(ctx context.Context, path string) (DsvEngineGetResponse, *http.Response, error)
EnginesApiService Get Engine Retrieve engine by name.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path Name of engine
@return DsvEngineGetResponse
func (*EnginesApiService) ListEngines ¶
func (a *EnginesApiService) ListEngines(ctx context.Context) (DsvEngineListResult, *http.Response, error)
EnginesApiService List Engines List all existing engines.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return DsvEngineListResult
func (*EnginesApiService) PingEngine ¶
func (a *EnginesApiService) PingEngine(ctx context.Context, path string) (DsvEnginePingResponse, *http.Response, error)
EnginesApiService Ping Engine Sends a message to the engine to validate connectivity.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path Name of engine
@return DsvEnginePingResponse
type GenericSwaggerError ¶
type GenericSwaggerError struct {
// contains filtered or unexported fields
}
GenericSwaggerError Provides access to the body, error and model on returned errors.
func (GenericSwaggerError) Body ¶
func (e GenericSwaggerError) Body() []byte
Body returns the raw bytes of the response
func (GenericSwaggerError) Error ¶
func (e GenericSwaggerError) Error() string
Error returns non-empty string if there was an error.
func (GenericSwaggerError) Model ¶
func (e GenericSwaggerError) Model() interface{}
Model returns the unpacked model of the error
type GroupsApiService ¶
type GroupsApiService service
func (*GroupsApiService) AddMember ¶
func (a *GroupsApiService) AddMember(ctx context.Context, name string, body DsvMemberRequest) (DsvAddMemberResponse, *http.Response, error)
GroupsApiService Add Members To Group Add one or more members to a group.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Group name
- @param body
@return DsvAddMemberResponse
func (*GroupsApiService) CreateGroup ¶
func (a *GroupsApiService) CreateGroup(ctx context.Context, body DsvCreateGroup) (DsvAddMemberResponse, *http.Response, error)
GroupsApiService Create Group Create a new group.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvAddMemberResponse
func (*GroupsApiService) DeleteGroup ¶
func (a *GroupsApiService) DeleteGroup(ctx context.Context, name string, localVarOptionals *GroupsApiDeleteGroupOpts) (DsvMessageResponse, *http.Response, error)
func (*GroupsApiService) DeleteMember ¶
func (a *GroupsApiService) DeleteMember(ctx context.Context, name string, body DsvMemberRequest) (*http.Response, error)
GroupsApiService Delete Members From Group Delete one or more members from a group.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Group name
- @param body
func (*GroupsApiService) GetGroup ¶
func (a *GroupsApiService) GetGroup(ctx context.Context, name string) (DsvGroupResponse, *http.Response, error)
GroupsApiService Get Group Retrieve an existing group by name.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Group name
@return DsvGroupResponse
func (*GroupsApiService) RestoreGroup ¶
GroupsApiService Restore Group Restore a soft-deleted group.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Group name
func (*GroupsApiService) SearchGroups ¶
func (a *GroupsApiService) SearchGroups(ctx context.Context, localVarOptionals *GroupsApiSearchGroupsOpts) (DsvGroupSearch, *http.Response, error)
type HomeApiService ¶
type HomeApiService service
func (*HomeApiService) CreateHomeSecret ¶
func (a *HomeApiService) CreateHomeSecret(ctx context.Context, path string, body DsvSecretCreate) (DsvSecretResponse, *http.Response, error)
HomeApiService Create home secrets Creates a new home secret.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full secret path i.e. servers/prod/webserver-01
- @param body
@return DsvSecretResponse
func (*HomeApiService) DeleteHomeSecret ¶
func (a *HomeApiService) DeleteHomeSecret(ctx context.Context, path string, localVarOptionals *HomeApiDeleteHomeSecretOpts) (DsvMessageResponse, *http.Response, error)
func (*HomeApiService) GetHomeSecret ¶
func (a *HomeApiService) GetHomeSecret(ctx context.Context, path string, localVarOptionals *HomeApiGetHomeSecretOpts) (DsvSecretResponse, *http.Response, error)
func (*HomeApiService) GetHomeSecretByVersion ¶
func (a *HomeApiService) GetHomeSecretByVersion(ctx context.Context, path string, version int64) (DsvSecretVersionResponse, *http.Response, error)
HomeApiService Get Home Secret By Version Gets a full home secret by path and version in the query.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full secret path i.e. servers/prod/webserver-01
- @param version Versions to return
@return DsvSecretVersionResponse
func (*HomeApiService) GetHomeSecretDescription ¶
func (a *HomeApiService) GetHomeSecretDescription(ctx context.Context, path string, localVarOptionals *HomeApiGetHomeSecretDescriptionOpts) (DsvSecretDescription, *http.Response, error)
func (*HomeApiService) RestoreHomeSecret ¶
func (a *HomeApiService) RestoreHomeSecret(ctx context.Context, path string, localVarOptionals *HomeApiRestoreHomeSecretOpts) (*http.Response, error)
func (*HomeApiService) RollbackHomeSecret ¶
func (a *HomeApiService) RollbackHomeSecret(ctx context.Context, path string, version int64) (DsvSecretVersionResponse, *http.Response, error)
HomeApiService Rollback a Home Secret Rollbacks a Home Secret to a previous version.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full secret path i.e. servers/prod/webserver-01
- @param version Versions to return
@return DsvSecretVersionResponse
func (*HomeApiService) SearchHomeSecrets ¶
func (a *HomeApiService) SearchHomeSecrets(ctx context.Context, localVarOptionals *HomeApiSearchHomeSecretsOpts) (DsvSecretSearch, *http.Response, error)
func (*HomeApiService) UpdateHomeSecret ¶
func (a *HomeApiService) UpdateHomeSecret(ctx context.Context, path string, body DsvSecretUpdate) (DsvSecretResponse, *http.Response, error)
HomeApiService Update home Secret Updates an existing home secret.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full secret path i.e. servers/prod/webserver-01
- @param body
@return DsvSecretResponse
type KeyApiService ¶
type KeyApiService service
func (*KeyApiService) Masterkeys ¶
func (a *KeyApiService) Masterkeys(ctx context.Context, body DsvMasterkey) (*http.Response, error)
KeyApiService Update Master Key Update Master Encryption key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
type PKIApiService ¶
type PKIApiService service
func (*PKIApiService) LeafParams ¶
func (a *PKIApiService) LeafParams(ctx context.Context, body DsvSigningRequestInformation) (DsvResponseCertificate, *http.Response, error)
PKIApiService Create Leaf Certificate and Private Key Create and return a signed certificate with a private key based on a registered root CA.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvResponseCertificate
func (*PKIApiService) RegisterRoot ¶
func (a *PKIApiService) RegisterRoot(ctx context.Context, body DsvRootCaSecret) (DsvResponseRootCertificate, *http.Response, error)
PKIApiService Register Root CA Register a root CA as a secret.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvResponseRootCertificate
func (*PKIApiService) RootCARegistration ¶
func (a *PKIApiService) RootCARegistration(ctx context.Context, body DsvRootCaRegistration) (DsvResponseCertificate, *http.Response, error)
PKIApiService Generate Root Certificate Create and return a new root certificate.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvResponseCertificate
func (*PKIApiService) SSHCertParams ¶
func (a *PKIApiService) SSHCertParams(ctx context.Context, body DsvSshCertInformation) (DsvResponseSshCertificate, *http.Response, error)
PKIApiService Create SSH Certificate Create, store and return a signed SSH certificate using a root private key and SHH-compatible leaf public key.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvResponseSshCertificate
func (*PKIApiService) SignCertificate ¶
func (a *PKIApiService) SignCertificate(ctx context.Context, body DsvSigningRequest) (DsvSignedLeafCertificate, *http.Response, error)
PKIApiService Create Signed Certificate Create and return a signed certificate based on a registered root CA with a given CSR.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvSignedLeafCertificate
type PoliciesApiService ¶
type PoliciesApiService service
func (*PoliciesApiService) CreatePolicy ¶
func (a *PoliciesApiService) CreatePolicy(ctx context.Context, body DsvPolicyCreate) (DsvPolicyResponse, *http.Response, error)
PoliciesApiService Create Policy Creates new policy with permission document.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvPolicyResponse
func (*PoliciesApiService) DeletePolicy ¶
func (a *PoliciesApiService) DeletePolicy(ctx context.Context, path string, localVarOptionals *PoliciesApiDeletePolicyOpts) (DsvMessageResponse, *http.Response, error)
func (*PoliciesApiService) GetPolicy ¶
func (a *PoliciesApiService) GetPolicy(ctx context.Context, path string) (DsvPolicyResponse, *http.Response, error)
PoliciesApiService Get Policy Retrieve policy by path.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path Full path to lookup policy
@return DsvPolicyResponse
func (*PoliciesApiService) GetPolicyByVersion ¶
func (a *PoliciesApiService) GetPolicyByVersion(ctx context.Context, path string, version int64) (DsvPolicyVersionResponse, *http.Response, error)
PoliciesApiService Get a list of policies by version Get a full policies by path and version in the query.Returns a list of zero up to n versions of an item.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path Full path to lookup policy
- @param version Versions to return
@return DsvPolicyVersionResponse
func (*PoliciesApiService) RestorePolicy ¶
func (a *PoliciesApiService) RestorePolicy(ctx context.Context, path string) (*http.Response, error)
PoliciesApiService Restore Policy Restore an existing policy by path.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path Full path to lookup policy
func (*PoliciesApiService) RollbackPolicy ¶
func (a *PoliciesApiService) RollbackPolicy(ctx context.Context, path string, version int64) (DsvPolicyResponse, *http.Response, error)
PoliciesApiService Rollback Policy Overwrites an existing policy with its previous version.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path Full path to lookup policy
- @param version Versions to return
@return DsvPolicyResponse
func (*PoliciesApiService) SearchFilter ¶
func (a *PoliciesApiService) SearchFilter(ctx context.Context, localVarOptionals *PoliciesApiSearchFilterOpts) (DsvPolicySearchResponse, *http.Response, error)
func (*PoliciesApiService) UpdatePolicy ¶
func (a *PoliciesApiService) UpdatePolicy(ctx context.Context, path string, body DsvPolicyUpdate) (DsvPolicyResponse, *http.Response, error)
PoliciesApiService Update Policy Overwrites an existing policy with an updated permissions document.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path Full path for policy
- @param body
@return DsvPolicyResponse
type PoolsApiService ¶
type PoolsApiService service
func (*PoolsApiService) CreatePool ¶
func (a *PoolsApiService) CreatePool(ctx context.Context, body DsvPoolCreate) (DsvPool, *http.Response, error)
PoolsApiService Create Pool Create an engine pool.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvPool
func (*PoolsApiService) DeletePool ¶
func (a *PoolsApiService) DeletePool(ctx context.Context, name string) (DsvMessageResponse, *http.Response, error)
PoolsApiService Delete Pool Delete an engine pool by name.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Name to lookup path by
@return DsvMessageResponse
func (*PoolsApiService) GetPool ¶
func (a *PoolsApiService) GetPool(ctx context.Context, name string) (DsvPool, *http.Response, error)
PoolsApiService Get Pool Retrieve pool by name.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Name to lookup path by
@return DsvPool
func (*PoolsApiService) ListPools ¶
func (a *PoolsApiService) ListPools(ctx context.Context) (DsvPoolListResult, *http.Response, error)
PoolsApiService List Pools List all existing pools.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return DsvPoolListResult
type RolesApiDeleteRoleOpts ¶
type RolesApiSearchRolesOpts ¶
type RolesApiService ¶
type RolesApiService service
func (*RolesApiService) CreateRole ¶
func (a *RolesApiService) CreateRole(ctx context.Context, body DsvRoleCreate) (DsvRoleResponse, *http.Response, error)
RolesApiService Create a Role Creates a new role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvRoleResponse
func (*RolesApiService) DeleteRole ¶
func (a *RolesApiService) DeleteRole(ctx context.Context, name string, localVarOptionals *RolesApiDeleteRoleOpts) (DsvMessageResponse, *http.Response, error)
func (*RolesApiService) GetRole ¶
func (a *RolesApiService) GetRole(ctx context.Context, name string) (DsvRoleResponse, *http.Response, error)
RolesApiService Get a Role Retrieve an existing role by role name. For roles linked to 3rd party providers, such as AWS or Azure, the role name must be prefixed with the provider name from configuration in the format of <providername>:<rolename> i.e. aws-dev:db
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full role name to lookup role by
@return DsvRoleResponse
func (*RolesApiService) GetRoleByVersion ¶
func (a *RolesApiService) GetRoleByVersion(ctx context.Context, name string, version int64) (DsvRoleVersionResponse, *http.Response, error)
RolesApiService Get a Role By Version Retrieve an existing role by role name and versions. For roles linked to 3rd party providers, such as AWS or Azure, the role name must be prefixed with the provider name from configuration in the format of <providername>:<rolename> i.e. aws-dev:db
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full name to lookup role by
- @param version Versions to return
@return DsvRoleVersionResponse
func (*RolesApiService) RestoreRole ¶
RolesApiService Restore a Role Restore a role by path.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full role name to lookup role by
func (*RolesApiService) SearchRoles ¶
func (a *RolesApiService) SearchRoles(ctx context.Context, localVarOptionals *RolesApiSearchRolesOpts) (DsvRoleSearchResponse, *http.Response, error)
func (*RolesApiService) UpdateRole ¶
func (a *RolesApiService) UpdateRole(ctx context.Context, name string, role DsvRoleDetailsModel) (DsvRoleResponse, *http.Response, error)
RolesApiService Update a Role Update an existing role.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full role name to lookup role by
- @param role
@return DsvRoleResponse
type SIEMApiSearchSiemsOpts ¶
type SIEMApiService ¶
type SIEMApiService service
func (*SIEMApiService) SearchSiems ¶
func (a *SIEMApiService) SearchSiems(ctx context.Context, localVarOptionals *SIEMApiSearchSiemsOpts) (DsvSiemSearchResponse, *http.Response, error)
func (*SIEMApiService) SiemCreate ¶
func (a *SIEMApiService) SiemCreate(ctx context.Context, body DsvSiemCreateUpdateRequestModel) (DsvSiemResponse, *http.Response, error)
SIEMApiService Create SIEM Endpoint Creates a new SIEM endpoint.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvSiemResponse
func (*SIEMApiService) SiemDelete ¶
SIEMApiService Delete SIEM Endpoint Delete an existing SIEM endpoint.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name
func (*SIEMApiService) SiemGet ¶
func (a *SIEMApiService) SiemGet(ctx context.Context, name string) (DsvSiemResponse, *http.Response, error)
SIEMApiService Get SIEM Endpoint Retrieve an existing SIEM endpoint.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name
@return DsvSiemResponse
func (*SIEMApiService) SiemUpdate ¶
func (a *SIEMApiService) SiemUpdate(ctx context.Context, name string, body DsvSiemCreateUpdateRequestModel) (DsvSiemResponse, *http.Response, error)
SIEMApiService Update SIEM Endpoint Update an existing SIEM endpoint. Update sets \"failed\" to \"false\" and \"failedEvents\" to \"0\" automatically.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name
- @param body
@return DsvSiemResponse
type SecretsApiGetSecretOpts ¶
type SecretsApiService ¶
type SecretsApiService service
func (*SecretsApiService) CreateSecret ¶
func (a *SecretsApiService) CreateSecret(ctx context.Context, path string, body DsvSecretCreate) (DsvSecretResponse, *http.Response, error)
SecretsApiService Create Secret Creates a new secret.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full secret path i.e. servers/prod/webserver-01
- @param body
@return DsvSecretResponse
func (*SecretsApiService) DeleteSecret ¶
func (a *SecretsApiService) DeleteSecret(ctx context.Context, path string, localVarOptionals *SecretsApiDeleteSecretOpts) (DsvMessageResponse, *http.Response, error)
func (*SecretsApiService) GetSecret ¶
func (a *SecretsApiService) GetSecret(ctx context.Context, path string, localVarOptionals *SecretsApiGetSecretOpts) (DsvSecretResponse, *http.Response, error)
func (*SecretsApiService) GetSecretByVersion ¶
func (a *SecretsApiService) GetSecretByVersion(ctx context.Context, path string, version int64) (DsvSecretVersionResponse, *http.Response, error)
SecretsApiService Get Secret By Version Gets a full secret by path and version in the query.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full secret path i.e. servers/prod/webserver-01
- @param version Versions to return
@return DsvSecretVersionResponse
func (*SecretsApiService) GetSecretDescription ¶
func (a *SecretsApiService) GetSecretDescription(ctx context.Context, path string, localVarOptionals *SecretsApiGetSecretDescriptionOpts) (DsvSecretDescription, *http.Response, error)
func (*SecretsApiService) ListSecretPaths ¶
func (a *SecretsApiService) ListSecretPaths(ctx context.Context, path string, localVarOptionals *SecretsApiListSecretPathsOpts) (DsvSecretListPathsResponse, *http.Response, error)
func (*SecretsApiService) RollbackSecret ¶
func (a *SecretsApiService) RollbackSecret(ctx context.Context, path string, version int64) (DsvSecretVersionResponse, *http.Response, error)
SecretsApiService Rollback a Secret Rollbacks a Secret to a previous version.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full secret path i.e. servers/prod/webserver-01
- @param version Versions to return
@return DsvSecretVersionResponse
func (*SecretsApiService) SearchSecrets ¶
func (a *SecretsApiService) SearchSecrets(ctx context.Context, localVarOptionals *SecretsApiSearchSecretsOpts) (DsvSecretSearch, *http.Response, error)
func (*SecretsApiService) UpdateSecret ¶
func (a *SecretsApiService) UpdateSecret(ctx context.Context, path string, body DsvSecretUpdate) (DsvSecretResponse, *http.Response, error)
SecretsApiService Update Secret Updates an existing secret.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param path The full secret path i.e. servers/prod/webserver-01
- @param body
@return DsvSecretResponse
type SettingsApiService ¶
type SettingsApiService service
func (*SettingsApiService) CreateAuthSettings ¶
func (a *SettingsApiService) CreateAuthSettings(ctx context.Context, body DsvAuthenticationSettingsCreateModel) (DsvAuthenticationSettingsResponse, *http.Response, error)
SettingsApiService Create Authentication Provider Creates new authentication provider settings.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvAuthenticationSettingsResponse
func (*SettingsApiService) DeleteAuthSettings ¶
func (a *SettingsApiService) DeleteAuthSettings(ctx context.Context, name string, localVarOptionals *SettingsApiDeleteAuthSettingsOpts) (DsvMessageResponse, *http.Response, error)
func (*SettingsApiService) GetAuthSettings ¶
func (a *SettingsApiService) GetAuthSettings(ctx context.Context, name string) (DsvAuthenticationSettingsResponse, *http.Response, error)
SettingsApiService Get Authentication Provider Retrieve authentication providers by name.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full name to lookup authentication settings by.
@return DsvAuthenticationSettingsResponse
func (*SettingsApiService) GetAuthSettingsByVersion ¶
func (a *SettingsApiService) GetAuthSettingsByVersion(ctx context.Context, name string, version int64) (DsvAuthenticationSettingsVersionResponse, *http.Response, error)
SettingsApiService Get a list of Authentication Settings by version Get a full Settings by name and version in the query. Returns a list of zero up to n versions of an item.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full name to lookup authentication settings by.
- @param version Versions to return.
@return DsvAuthenticationSettingsVersionResponse
func (*SettingsApiService) RestoreAuthSettings ¶
func (a *SettingsApiService) RestoreAuthSettings(ctx context.Context, name string) (*http.Response, error)
SettingsApiService Restore Authentication Provider Restore authentication provider settings if it had been marked for deletion.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full name to lookup authentication settings by.
func (*SettingsApiService) RollbackAuthSettings ¶
func (a *SettingsApiService) RollbackAuthSettings(ctx context.Context, name string, version int64) (DsvAuthenticationSettingsResponse, *http.Response, error)
SettingsApiService Rollback Authentication Provider Rollback authentication provider to a previous version.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full name to lookup authentication settings by.
- @param version Versions to return.
@return DsvAuthenticationSettingsResponse
func (*SettingsApiService) SearchSettings ¶
func (a *SettingsApiService) SearchSettings(ctx context.Context, localVarOptionals *SettingsApiSearchSettingsOpts) (DsvAuthenticationSettingsSearchResponse, *http.Response, error)
func (*SettingsApiService) UpdateAuthSettings ¶
func (a *SettingsApiService) UpdateAuthSettings(ctx context.Context, name string, body DsvAuthenticationDetailsModel) (DsvAuthenticationSettingsResponse, *http.Response, error)
SettingsApiService Update Authentication Provider Updates all fields on an existing authentication provider.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full name to lookup authentication settings by.
- @param body
@return DsvAuthenticationSettingsResponse
type TasksApiService ¶
type TasksApiService service
func (*TasksApiService) GetTaskStatus ¶
func (a *TasksApiService) GetTaskStatus(ctx context.Context, id string) (DsvTaskState, *http.Response, error)
TasksApiService Get background task status Get background task status by task uuid
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param id Task status uuid
@return DsvTaskState
type TokensApiService ¶
type TokensApiService service
func (*TokensApiService) InitCertAuth ¶
func (a *TokensApiService) InitCertAuth(ctx context.Context, clientCertificate string) (DsvInitiateCertAuthResponse, *http.Response, error)
TokensApiService Initiate authentication by certificate Request a challenge to decrypt to prove ownership of the private key for authentication by certificate flow. Challenge id returned in response is only valid for 5 minutes.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clientCertificate Base64 encoded client certificate in PEM format
@return DsvInitiateCertAuthResponse
func (*TokensApiService) Revoke ¶
TokensApiService Revoke Refresh Token Revoke an existing refresh token to prevent it from being used for authentication.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param refreshtoken Refresh token to revoke
func (*TokensApiService) Token ¶
func (a *TokensApiService) Token(ctx context.Context, grantType string, localVarOptionals *TokensApiTokenOpts) (DsvAccessTokenResponse, *http.Response, error)
type TokensApiTokenOpts ¶
type TokensApiTokenOpts struct {
Username optional.String
Password optional.String
Provider optional.String
AwsBody optional.String
AwsHeaders optional.String
Jwt optional.String
ClientId optional.String
ClientSecret optional.String
RefreshToken optional.String
CertChallengeId optional.String
DecryptedChallenge optional.String
}
type UsageApiGetUsageOpts ¶
type UsageApiService ¶
type UsageApiService service
func (*UsageApiService) GetUsage ¶
func (a *UsageApiService) GetUsage(ctx context.Context, startDate string, localVarOptionals *UsageApiGetUsageOpts) (DsvUsageResponseGeneral, *http.Response, error)
type UsersApiDeleteUserOpts ¶
type UsersApiSearchUsersOpts ¶
type UsersApiService ¶
type UsersApiService service
func (*UsersApiService) AddToGroups ¶
func (a *UsersApiService) AddToGroups(ctx context.Context, name string, body DsvAddToGroupsRequest) (DsvAddToGroupsResponse, *http.Response, error)
UsersApiService Add Member To Groups Add a user to one or more groups.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full user name to lookup user by
- @param body
@return DsvAddToGroupsResponse
func (*UsersApiService) ChangePassword ¶
func (a *UsersApiService) ChangePassword(ctx context.Context, name string, body DsvPasswordChangeModel) (DsvMessageResponse, *http.Response, error)
UsersApiService Change Password Allows the user to change their own password.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full user name to lookup user by
- @param body
@return DsvMessageResponse
func (*UsersApiService) CreateUser ¶
func (a *UsersApiService) CreateUser(ctx context.Context, body DsvUserCreateModel) (DsvUserResponse, *http.Response, error)
UsersApiService Create a User Create a new user.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param body
@return DsvUserResponse
func (*UsersApiService) DeleteUser ¶
func (a *UsersApiService) DeleteUser(ctx context.Context, name string, localVarOptionals *UsersApiDeleteUserOpts) (DsvMessageResponse, *http.Response, error)
func (*UsersApiService) GetMember ¶
func (a *UsersApiService) GetMember(ctx context.Context, name string) (DsvMemberResponse, *http.Response, error)
UsersApiService Get Member Group Retrieve a member's group by member name.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Member name to lookup member
@return DsvMemberResponse
func (*UsersApiService) GetUser ¶
func (a *UsersApiService) GetUser(ctx context.Context, name string) (DsvUserResponse, *http.Response, error)
UsersApiService Get a User Retrieve an existing user by user name. For users linked to 3rd party providers, such as AWS or Azure, the user name must be prefixed with the provider name from configuration in the format of <providername>:<username> i.e. aws-dev:db
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full user name to lookup user by
@return DsvUserResponse
func (*UsersApiService) GetUserByVersion ¶
func (a *UsersApiService) GetUserByVersion(ctx context.Context, name string, version int64) (DsvUserVersionResponse, *http.Response, error)
UsersApiService Get a User By Version Retrieve an existing user by user name and version. For users linked to 3rd party providers, such as AWS or Azure, the user name must be prefixed with the provider name from configuration in the format of <providername>:<username> i.e. aws-dev:db
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full user name to lookup user by
- @param version Versions to return
@return DsvUserVersionResponse
func (*UsersApiService) RestoreUser ¶
UsersApiService Restore a User Restore a user by path.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full user name to lookup user by
func (*UsersApiService) SearchUsers ¶
func (a *UsersApiService) SearchUsers(ctx context.Context, localVarOptionals *UsersApiSearchUsersOpts) (DsvUserSearch, *http.Response, error)
func (*UsersApiService) UpdateUser ¶
func (a *UsersApiService) UpdateUser(ctx context.Context, name string, body DsvUserUpdateModel) (DsvUserResponse, *http.Response, error)
UsersApiService Update a User Update an existing user.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param name Full user name to lookup user by
- @param body
@return DsvUserResponse
Source Files
¶
- api_audit.go
- api_break_glass.go
- api_clients.go
- api_config.go
- api_eaa_s_auto.go
- api_eaa_s_manual.go
- api_engines.go
- api_groups.go
- api_home.go
- api_key.go
- api_pki.go
- api_policies.go
- api_pools.go
- api_roles.go
- api_secrets.go
- api_settings.go
- api_siem.go
- api_tasks.go
- api_tokens.go
- api_usage.go
- api_users.go
- client.go
- configuration.go
- dsv_model_access_token_response.go
- dsv_model_add_member_response.go
- dsv_model_add_to_groups_request.go
- dsv_model_add_to_groups_response.go
- dsv_model_apply_response.go
- dsv_model_audit.go
- dsv_model_auth_properties.go
- dsv_model_authentication.go
- dsv_model_authentication_details_model.go
- dsv_model_authentication_provider_properties_model.go
- dsv_model_authentication_settings_create_model.go
- dsv_model_authentication_settings_response.go
- dsv_model_authentication_settings_search_response.go
- dsv_model_authentication_settings_version_response.go
- dsv_model_auto_key.go
- dsv_model_auto_key_response.go
- dsv_model_client_create.go
- dsv_model_client_credentials_response.go
- dsv_model_client_search_model.go
- dsv_model_condition.go
- dsv_model_conditions.go
- dsv_model_config_response.go
- dsv_model_config_version_response.go
- dsv_model_create_group.go
- dsv_model_decryption_response.go
- dsv_model_default_policy.go
- dsv_model_encryption_response.go
- dsv_model_engine_create.go
- dsv_model_engine_create_response.go
- dsv_model_engine_get_response.go
- dsv_model_engine_list_result.go
- dsv_model_engine_ping_response.go
- dsv_model_engine_search_response.go
- dsv_model_generate_response.go
- dsv_model_group.go
- dsv_model_group_member_info.go
- dsv_model_group_response.go
- dsv_model_group_search.go
- dsv_model_history.go
- dsv_model_http_error.go
- dsv_model_initiate_cert_auth_response.go
- dsv_model_key.go
- dsv_model_log_search_response.go
- dsv_model_manual_key_data.go
- dsv_model_masterkey.go
- dsv_model_member_request.go
- dsv_model_member_response.go
- dsv_model_message_response.go
- dsv_model_page_info.go
- dsv_model_password_change_model.go
- dsv_model_policy_create.go
- dsv_model_policy_response.go
- dsv_model_policy_search_response.go
- dsv_model_policy_update.go
- dsv_model_policy_version_response.go
- dsv_model_pool.go
- dsv_model_pool_create.go
- dsv_model_pool_list_result.go
- dsv_model_post_config_model.go
- dsv_model_response_certificate.go
- dsv_model_response_root_certificate.go
- dsv_model_response_ssh_certificate.go
- dsv_model_role_create.go
- dsv_model_role_details_model.go
- dsv_model_role_response.go
- dsv_model_role_search_response.go
- dsv_model_role_version_response.go
- dsv_model_roles.go
- dsv_model_root_ca_registration.go
- dsv_model_root_ca_secret.go
- dsv_model_secret_create.go
- dsv_model_secret_description.go
- dsv_model_secret_list_paths_response.go
- dsv_model_secret_response.go
- dsv_model_secret_search.go
- dsv_model_secret_update.go
- dsv_model_secret_version_response.go
- dsv_model_settings.go
- dsv_model_siem_create_update_request_model.go
- dsv_model_siem_no_sensitive_response_model.go
- dsv_model_siem_response.go
- dsv_model_siem_search_response.go
- dsv_model_signed_leaf_certificate.go
- dsv_model_signing_request.go
- dsv_model_signing_request_information.go
- dsv_model_ssh_cert_information.go
- dsv_model_status_response.go
- dsv_model_task_result.go
- dsv_model_task_state.go
- dsv_model_update_key_request.go
- dsv_model_usage_response_general.go
- dsv_model_user_create_model.go
- dsv_model_user_response.go
- dsv_model_user_search.go
- dsv_model_user_update_model.go
- dsv_model_user_version_response.go
- response.go