Go API client for openapi

Display the PVWA REST APIs below for a description of how to use them and try them out. Access information about additional REST APIs through the online documentation.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: v1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation For Authorization

You should use logon API get session token first.

   ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 0)

   client := openapi.NewAPIClient(openapi.NewConfiguration())

   token, _, err := client.AuthApi.AuthLogon(ctx, "radius").
   	Data(openapi.LogonData{
   		UserName: openapi.PtrString("username"),
   		Password: openapi.PtrString("password"),
   	}).
   	Execute()

   if err != nil {
   	panic(err)
   }

   cfg := client.GetConfig()
   if cfg.DefaultHeader == nil {
   	cfg.DefaultHeader = make(map[string]string)
   }
   cfg.AddDefaultHeader("Authorization", *token)

   // then you can use other APIs with this token

Documentation for API Endpoints

All URIs are relative to https://localhost/PasswordVault

Class	Method	HTTP request	Description
AccountGroupsApi	AccountGroupsAddAccountGroup	Post /api/AccountGroups
AccountGroupsApi	AccountGroupsAddAccountToGroup	Post /api/AccountGroups/{groupId}/members
AccountGroupsApi	AccountGroupsDeleteAccountFromGroup	Delete /api/AccountGroups/{groupId}/members/{accountId}
AccountGroupsApi	AccountGroupsGetGroupAccounts	Get /api/AccountGroups/{groupId}/members
AccountGroupsApi	AccountGroupsGetGroups	Get /api/AccountGroups
AccountsApi	AccountsAdHocConnect	Post /api/Accounts/AdHocConnect
AccountsApi	AccountsAddAccount	Post /api/Accounts
AccountsApi	AccountsCPMChangeNow	Post /api/Accounts/{accountId}/Change
AccountsApi	AccountsCPMSetNext	Post /api/Accounts/{accountId}/SetNextPassword
AccountsApi	AccountsChangeCredentialsInTheVault	Post /api/Accounts/{accountId}/Password/Update
AccountsApi	AccountsCheckIn	Post /api/Accounts/{accountId}/CheckIn
AccountsApi	AccountsClearAccount	Delete /api/Accounts/{accountId}/LinkAccount/{extraPasswordIndex}
AccountsApi	AccountsDeleteAccount	Delete /api/Accounts/{id}
AccountsApi	AccountsDownload	Post /api/Accounts/{accountId}/Secret/Retrieve
AccountsApi	AccountsGeneratePassword	Post /api/Accounts/{accountId}/Secret/Generate
AccountsApi	AccountsGetAccount	Get /api/Accounts/{id}
AccountsApi	AccountsGetAccounts	Get /api/Accounts
AccountsApi	AccountsGetVersions	Get /api/Accounts/{accountId}/Secret/Versions
AccountsApi	AccountsGrantAccess	Post /api/Accounts/{accountId}/GrantAdministrativeAccess
AccountsApi	AccountsLinkAccount	Post /api/Accounts/{id}/LinkAccount
AccountsApi	AccountsPSMConnect	Post /api/Accounts/{accountId}/PSMConnect
AccountsApi	AccountsReconcile	Post /api/Accounts/{accountId}/Reconcile
AccountsApi	AccountsRetrieve	Post /api/Accounts/{accountId}/Password/Retrieve
AccountsApi	AccountsRevokeAccess	Post /api/Accounts/{accountId}/RevokeAdministrativeAccess
AccountsApi	AccountsUpdateAccount	Patch /api/Accounts/{accountId}
AccountsApi	AccountsVerify	Post /api/Accounts/{accountId}/Verify
AllowedReferrerConfigurationApi	AllowedReferrerConfigurationAddAllowedReferrer	Post /api/Configuration/AccessRestriction/AllowedReferrers
AllowedReferrerConfigurationApi	AllowedReferrerConfigurationGetAllAllowedReferrers	Get /api/Configuration/AccessRestriction/AllowedReferrers
AuthApi	AuthLogoff	Post /api/Auth/Logoff
AuthApi	AuthLogon	Post /api/Auth/{type}/Logon
AuthenticationMethodConfigurationsApi	AuthenticationMethodConfigurationsAddConfigurationValue	Post /api/Configuration/AuthenticationMethods
AuthenticationMethodConfigurationsApi	AuthenticationMethodConfigurationsDeleteAuthenticationMethod	Delete /api/Configuration/AuthenticationMethods/{id}
AuthenticationMethodConfigurationsApi	AuthenticationMethodConfigurationsGetAuthenticationMethod	Get /api/Configuration/AuthenticationMethods/{id}
AuthenticationMethodConfigurationsApi	AuthenticationMethodConfigurationsGetAuthenticationMethods	Get /api/Configuration/AuthenticationMethods
AuthenticationMethodConfigurationsApi	AuthenticationMethodConfigurationsUpdateAuthenticationMethod	Put /api/Configuration/AuthenticationMethods/{id}
AutomaticOnboardingRulesApi	AutomaticOnboardingRulesDeleteAutomaticOnboardingRule	Delete /api/AutomaticOnboardingRules/{id}
AutomaticOnboardingRulesApi	AutomaticOnboardingRulesGetAutomaticOnboardingRules	Get /api/AutomaticOnboardingRules
AutomaticOnboardingRulesApi	AutomaticOnboardingRulesPostAutomaticOnboardingRule	Post /api/AutomaticOnboardingRules
AutomaticOnboardingRulesApi	AutomaticOnboardingRulesUpdateAutomaticOnboardingRule	Put /api/AutomaticOnboardingRules/{id}
BulkAccountsApi	BulkAccountsAddBulkAccounts	Post /api/BulkActions/Accounts
BulkAccountsApi	BulkAccountsGetBulkAction	Get /api/BulkActions/Accounts/{bulkId}
BulkAccountsApi	BulkAccountsGetUserBulkAccountsActions	Get /api/BulkActions/Accounts
ComponentsMonitoringDetailsApi	ComponentsMonitoringDetailsGetComponentsMonitoringDetails	Get /api/ComponentsMonitoringDetails/{componentId}
ComponentsMonitoringSummaryApi	ComponentsMonitoringSummaryGetComponentsMonitoringSummary	Get /api/ComponentsMonitoringSummary
ConnectionComponentsApi	ConnectionComponentsImport	Post /api/ConnectionComponents/import
DiscoveredAccountsApi	DiscoveredAccountsAddDiscoveredAccount	Post /api/DiscoveredAccounts
DiscoveredAccountsApi	DiscoveredAccountsDeleteDiscoveredAccounts	Delete /api/DiscoveredAccounts
DiscoveredAccountsApi	DiscoveredAccountsGetDiscoveredAccount	Get /api/DiscoveredAccounts/{id}
DiscoveredAccountsApi	DiscoveredAccountsGetDiscoveredAccounts	Get /api/DiscoveredAccounts
IncomingRequestsApi	IncomingRequestsConfirmRequests	Post /api/IncomingRequests/{RequestID}/confirm
IncomingRequestsApi	IncomingRequestsGetRequest	Get /api/IncomingRequests/{RequestID}
IncomingRequestsApi	IncomingRequestsGetRequests	Get /api/IncomingRequests
IncomingRequestsApi	IncomingRequestsRejectRequests	Post /api/IncomingRequests/{RequestID}/reject
LDAPDirectoriesApi	LDAPDirectoriesAddDirectory	Post /api/Configuration/LDAP/Directories
LDAPDirectoriesApi	LDAPDirectoriesAddDirectoryMapping	Post /api/Configuration/LDAP/Directories/{directoryName}/Mappings
LDAPDirectoriesApi	LDAPDirectoriesDeleteDirectory	Delete /api/Configuration/LDAP/Directories/{directoryName}
LDAPDirectoriesApi	LDAPDirectoriesDeleteDirectoryMapping	Delete /api/Configuration/LDAP/Directories/{directoryName}/Mappings/{mappingID}
LDAPDirectoriesApi	LDAPDirectoriesGetDirectories	Get /api/Configuration/LDAP/Directories
LDAPDirectoriesApi	LDAPDirectoriesGetDirectory	Get /api/Configuration/LDAP/Directories/{directoryName}
LDAPDirectoriesApi	LDAPDirectoriesGetDirectoryMapping	Get /api/Configuration/LDAP/Directories/{directoryName}/Mappings/{mappingID}
LDAPDirectoriesApi	LDAPDirectoriesGetDirectoryMappings	Get /api/Configuration/LDAP/Directories/{directoryName}/Mappings
LDAPDirectoriesApi	LDAPDirectoriesSetDirectoryMappingsOrder	Post /api/Configuration/LDAP/Directories/{directoryName}/Mappings/Reorder
LDAPDirectoriesApi	LDAPDirectoriesUpdateDirectoryMapping	Put /api/Configuration/LDAP/Directories/{directoryName}/Mappings/{mappingID}
LiveSessionsApi	LiveSessionsGetLiveSession	Get /api/LiveSessions/{liveSessionId}
LiveSessionsApi	LiveSessionsGetLiveSessionActivities	Get /api/LiveSessions/{liveSessionId}/activities
LiveSessionsApi	LiveSessionsGetLiveSessionProperties	Get /api/LiveSessions/{liveSessionId}/properties
LiveSessionsApi	LiveSessionsGetLiveSessions	Get /api/LiveSessions
LiveSessionsApi	LiveSessionsPSMAutoTermination	Post /api/LiveSessions/{liveSessionId}/terminate
LiveSessionsApi	LiveSessionsPSMMonitor	Get /api/LiveSessions/{liveSessionId}/monitor
LiveSessionsApi	LiveSessionsPSMSessionResume	Post /api/LiveSessions/{liveSessionId}/resume
LiveSessionsApi	LiveSessionsPSMSuspend	Post /api/LiveSessions/{liveSessionId}/suspend
LoginsInfoApi	LoginsInfoGetLoginsInfo	Get /api/LoginsInfo
MyRequestsApi	MyRequestsCreateRequest	Post /api/MyRequests
MyRequestsApi	MyRequestsDeleteMyRequests	Delete /api/MyRequests/{RequestID}
MyRequestsApi	MyRequestsGetRequest	Get /api/MyRequests/{RequestID}
MyRequestsApi	MyRequestsGetRequests	Get /api/MyRequests
OIDCConfigurationApi	OIDCConfigurationAddProvider	Post /api/Configuration/OIDC/Providers
OIDCConfigurationApi	OIDCConfigurationDeleteProvider	Delete /api/Configuration/OIDC/Providers/{id}
OIDCConfigurationApi	OIDCConfigurationGetProvider	Get /api/Configuration/OIDC/Providers/{id}
OIDCConfigurationApi	OIDCConfigurationGetProviders	Get /api/Configuration/OIDC/Providers
OIDCConfigurationApi	OIDCConfigurationUpdateProvider	Put /api/Configuration/OIDC/Providers/{id}
PSMConnectorsApi	PSMConnectorsGetPSMConnectorsController	Get /api/PSM/Connectors
PSMServersApi	PSMServersGetPSMServersController	Get /api/PSM/Servers
PlatformsApi	PlatformsActivateGroupPlatform	Post /api/Platforms/Groups/{platformID}/activate
PlatformsApi	PlatformsActivateRotationalGroupPlatform	Post /api/Platforms/RotationalGroups/{platformID}/activate
PlatformsApi	PlatformsActivateTargetPlatform	Post /api/Platforms/Targets/{platformID}/activate
PlatformsApi	PlatformsDeactivateGroupPlatform	Post /api/Platforms/Groups/{platformID}/deactivate
PlatformsApi	PlatformsDeactivateRotationalGroupPlatform	Post /api/Platforms/RotationalGroups/{platformID}/deactivate
PlatformsApi	PlatformsDeactivateTargetPlatform	Post /api/Platforms/Targets/{platformID}/deactivate
PlatformsApi	PlatformsDeleteDependentPlatform	Delete /api/Platforms/Dependents/{platformID}
PlatformsApi	PlatformsDeleteGroupPlatform	Delete /api/Platforms/Groups/{platformID}
PlatformsApi	PlatformsDeleteRotationalGroupPlatform	Delete /api/Platforms/RotationalGroups/{platformID}
PlatformsApi	PlatformsDeleteTargetPlatform	Delete /api/Platforms/Targets/{platformID}
PlatformsApi	PlatformsDuplicateDependentPlatform	Post /api/Platforms/Dependents/{platformID}/Duplicate
PlatformsApi	PlatformsDuplicateGroupPlatform	Post /api/Platforms/Groups/{platformID}/Duplicate
PlatformsApi	PlatformsDuplicateRotationalGroupPlatform	Post /api/Platforms/RotationalGroups/{platformID}/Duplicate
PlatformsApi	PlatformsDuplicateTargetPlatform	Post /api/Platforms/Targets/{platformID}/Duplicate
PlatformsApi	PlatformsExport	Post /api/Platforms/{PlatformID}/Export
PlatformsApi	PlatformsExportDependentPlatform	Post /api/Platforms/Dependents/{platformID}/Export
PlatformsApi	PlatformsExportGroupPlatform	Post /api/Platforms/Groups/{platformID}/Export
PlatformsApi	PlatformsExportRotationalGroupPlatform	Post /api/Platforms/RotationalGroups/{platformID}/Export
PlatformsApi	PlatformsExportTargetPlatform	Post /api/Platforms/Targets/{platformID}/Export
PlatformsApi	PlatformsGetDependentPlaforms	Get /api/Platforms/Dependents
PlatformsApi	PlatformsGetGroupPlaforms	Get /api/Platforms/Groups
PlatformsApi	PlatformsGetPlaform	Get /api/Platforms/{id}
PlatformsApi	PlatformsGetPlatforms	Get /api/Platforms
PlatformsApi	PlatformsGetPrivilegedSessionManagementDetails	Get /api/Platforms/Targets/{platformID}/PrivilegedSessionManagement
PlatformsApi	PlatformsGetRotationalGroupPlaforms	Get /api/Platforms/RotationalGroups
PlatformsApi	PlatformsGetSafesByPlatform	Get /api/Platforms/{PlatformId}/Safes
PlatformsApi	PlatformsGetSystemTypes	Get /api/Platforms/Targets/SystemTypes
PlatformsApi	PlatformsGetTargetPlaforms	Get /api/Platforms/Targets
PlatformsApi	PlatformsImport	Post /api/Platforms/import
PlatformsApi	PlatformsSetPrivilegedSessionManagementDetails	Put /api/Platforms/Targets/{platformID}/PrivilegedSessionManagement
RecordingsApi	RecordingsGetRecording	Get /api/Recordings/{recordingId}
RecordingsApi	RecordingsGetRecordingActivities	Get /api/Recordings/{recordingId}/activities
RecordingsApi	RecordingsGetRecordingFileValidityStatus	Get /api/Recordings/{recordingId}/valid
RecordingsApi	RecordingsGetRecordingProperties	Get /api/Recordings/{recordingId}/properties
RecordingsApi	RecordingsGetRecordings	Get /api/Recordings
RecordingsApi	RecordingsPlayRecording	Post /api/Recordings/{recordingId}/Play
SafesApi	SafesAddSafe	Post /api/Safes
SafesApi	SafesAddSafeMember	Post /api/Safes/{safeUrlId}/members
SafesApi	SafesDeleteSafe	Delete /api/Safes/{safeUrlId}
SafesApi	SafesDeleteSafeMember	Delete /api/Safes/{safeUrlId}/members/{memberName}
SafesApi	SafesGetGroups	Get /api/Safes/{safeName}/accountgroups
SafesApi	SafesGetSafeDetails	Get /api/Safes/{safeUrlId}
SafesApi	SafesGetSafeMember	Get /api/Safes/{safeUrlId}/members/{memberName}
SafesApi	SafesGetSafeMembers	Get /api/Safes/{safeUrlId}/members
SafesApi	SafesGetSafes	Get /api/Safes
SafesApi	SafesUpdateSafe	Put /api/Safes/{safeUrlId}
SafesApi	SafesUpdateSafeMember	Put /api/Safes/{safeUrlId}/members/{memberName}
UserGroupsApi	UserGroupsAddMemberToGroup	Post /api/UserGroups/{groupId}/Members
UserGroupsApi	UserGroupsCreateUserGroup	Post /api/UserGroups
UserGroupsApi	UserGroupsDeleteUserGroup	Delete /api/UserGroups/{groupId}
UserGroupsApi	UserGroupsEditUserGroup	Put /api/UserGroups/{groupId}
UserGroupsApi	UserGroupsGetUserGroups	Get /api/UserGroups
UserGroupsApi	UserGroupsRemoveUserFromGroup	Delete /api/UserGroups/{groupId}/Members/{memberName}
UsersApi	UsersActivateUser	Post /api/Users/{userID}/Activate
UsersApi	UsersAddUserSSHKey	Post /api/Users/{userID}/Secret/SSHKeys
UsersApi	UsersCreateUser	Post /api/Users
UsersApi	UsersDeleteUser	Delete /api/Users/{userID}
UsersApi	UsersDeleteUserSSHKey	Delete /api/Users/{userID}/Secret/SSHKeys
UsersApi	UsersDestroyAllUsersCachedSSHKey	Delete /api/Users/Secret/SSHKeys/ClearCache
UsersApi	UsersDestroyCurrentUserCachedSSHKey	Delete /api/Users/Secret/SSHKeys/Cache
UsersApi	UsersDestroyUserCachedSSHKey	Delete /api/Users/{userID}/Secret/SSHKeys/Cache
UsersApi	UsersEditUser	Put /api/Users/{userID}
UsersApi	UsersGenerateCurrentUserCachedSSHKey	Post /api/Users/Secret/SSHKeys/Cache
UsersApi	UsersGenerateUserCachedSSHKey	Post /api/Users/{userID}/Secret/SSHKeys/Cache
UsersApi	UsersGetUserDetails	Get /api/Users/{userID}
UsersApi	UsersGetUserSSHKeys	Get /api/Users/{userID}/Secret/SSHKeys
UsersApi	UsersGetUsers	Get /api/Users
UsersApi	UsersResetUserPassword	Post /api/Users/{userID}/ResetPassword

Documentation For Models

• A4b
• Account
• AccountContentPrerequsites
• AccountGroup
• AccountGroupMember
• AccountInSafe
• AccountInSafeResponse
• AccountModel
• AccountPSMConnectPrerequisites
• AdHocConnectionData
• AddAccountGroupData
• AddMemberToAccountGroup
• AddSafeMemberRequestBody
• AddSafeMemberResponse
• AddSafeRequest
• AddSafeResponse
• AddUserSSHKeyModel
• AllowedReferrerDto
• AuthenticationMethod
• AuthenticationMethodBase
• AuthenticationMethodsResponse
• AutomaticOnboardingRuleData
• AutomaticOnboardingRuleDataIn
• AutomaticSecretManagement
• BaseUser
• BaseUserGroup
• BaseUserPersonalDetails
• BaseUsersFilters
• BulkAccountModel
• BulkAccountsList
• BulkAccountsModel
• BulkAccountsOperationResult
• BulkAccountsOperationResultExtended
• BulkOperationSummary
• ChangeCredentialsNowProperties
• ChangeInVaultProperties
• Command
• ComponentMonitoringDetailsData
• ComponentMonitoringSummaryData
• ComponentMonitoringSummaryVaultData
• ComponentsMonitoringDetailsData
• ComponentsMonitoringSummaryData
• ConfirmRejectData
• ConfirmerMember
• ConfirmerStatus
• ConnectionParameter
• CredentialsManagement
• CredentialsManagementPolicy
• DeleteUserSSHKeyModel
• DependentPlatform
• DiscoveredAccount
• DiscoveredAccountResponse
• DiscoveredDependency
• DiscoveredDependencyResponse
• DuplicatePlatform
• FilterQS
• General
• GeneratePasswordAccountDetailsJson
• GenerateUserCachedSSHKeyModel
• GenerateUserCachedSSHKeyResponse
• GeneratedPassword
• GetAccountsRequest
• GetAccountsResponse
• GetBulkAccountsActionsRequest
• GetBulkAccountsActionsResult
• GetDiscoveredAccount
• GetDiscoveredAccountsRequest
• GetDiscoveredAccountsResponse
• GetDiscoveredDependency
• GetPlatformsRequest
• GetPlatformsRequestBase
• GetSafeDetailsRequest
• GetSafeDetailsResponse
• GetSafeMemberRequest
• GetSafeMemberResponse
• GetSafesByPlatformRequest
• GetSafesParams
• GetTargetPlatformsRequest
• GetUserGroupsResponse
• GetUserSSHKeysModel
• GetUserSSHKeysResponse
• GetUsersGroupParams
• GroupMember
• GroupMembershipDetails
• GroupPlatform
• Identity
• ImportConnectionComponentData
• ImportConnectionComponentResponse
• ImportPlatformData
• ImportPlatformResponse
• Incident
• IncomingRequest
• JsonPatchDocumentAccountModel
• LDAPDirectory
• LDAPDirectoryBase
• LDAPDomainController
• LDAPMappingData
• LDAPMappingsOrder
• LinkAccountData
• LiveSession
• LoginsInfoData
• LogoffData
• LogonData
• MemberGroup
• MonitoringQS
• MyRequest
• NewRequest
• OPConfigurationBase
• OPConfigurationData
• OPConfigurations
• OperationAccountModel
• PSMConnector
• PSMServer
• PTAData
• PageQS
• Platform
• PlatformModel
• PrivateSSHKeyModel
• PrivilegedAccessWorkflows
• PrivilegedAccessWorkflowsPolicy
• PrivilegedSessionManagement
• PrivilegedSessionManagementBase
• Properties
• PublicSSHKeyModel
• ReconcileTask
• RecordedCommand
• RecordingFile
• RemoteMachinesAccess
• Request
• ResetUserPassword
• RotationalGroupPlatform
• RuleFiltersQS
• SafeCreator
• SafeCreatorResponse
• SafeListItem
• SafeMemberResponse
• SafeMembersFilter
• SearchQS
• SecretUpdateConfiguration
• Session
• SessionData
• SessionManagement
• SetNextCredentialsProperties
• SortQS
• SystemType
• TargetPlatform
• TaskRole
• TicketingSystem
• UpdateSafeMemberRequestBody
• UpdateSafeMemberResponse
• UpdateSafeRequestBody
• UpdateSafeResponse
• User
• UserBusinessAddress
• UserGroup
• UserInternet
• UserPersonalDetails
• UserPhone
• UsersFilters
• VersionData
• WorkflowPolicy

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author