https://github.com/wanmail/cyberark-pvwa

cyberark Privileged Access Security REST API go client
https://github.com/wanmail/cyberark-pvwa
cyberark cyberark-api go kms
Last synced: 3 months ago
JSON representation
cyberark Privileged Access Security REST API go client
Host: GitHub
URL: https://github.com/wanmail/cyberark-pvwa
Owner: wanmail
Created: 2022-05-30T07:00:18.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-05-31T04:33:24.000Z (over 3 years ago)
Last Synced: 2025-04-06T00:23:39.594Z (6 months ago)
Topics: cyberark, cyberark-api, go, kms
Language: Shell
Homepage:
Size: 461 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

          # 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](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) 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:

```shell

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:

```golang

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

```

To use a proxy, set the environment variable `HTTP_PROXY`:

```golang

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`.

```golang

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`.

```golang

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.

 ```go

	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**](docs/AccountGroupsApi.md#accountgroupsaddaccountgroup) | **Post** /api/AccountGroups | 

*AccountGroupsApi* | [**AccountGroupsAddAccountToGroup**](docs/AccountGroupsApi.md#accountgroupsaddaccounttogroup) | **Post** /api/AccountGroups/{groupId}/members | 

*AccountGroupsApi* | [**AccountGroupsDeleteAccountFromGroup**](docs/AccountGroupsApi.md#accountgroupsdeleteaccountfromgroup) | **Delete** /api/AccountGroups/{groupId}/members/{accountId} | 

*AccountGroupsApi* | [**AccountGroupsGetGroupAccounts**](docs/AccountGroupsApi.md#accountgroupsgetgroupaccounts) | **Get** /api/AccountGroups/{groupId}/members | 

*AccountGroupsApi* | [**AccountGroupsGetGroups**](docs/AccountGroupsApi.md#accountgroupsgetgroups) | **Get** /api/AccountGroups | 

*AccountsApi* | [**AccountsAdHocConnect**](docs/AccountsApi.md#accountsadhocconnect) | **Post** /api/Accounts/AdHocConnect | 

*AccountsApi* | [**AccountsAddAccount**](docs/AccountsApi.md#accountsaddaccount) | **Post** /api/Accounts | 

*AccountsApi* | [**AccountsCPMChangeNow**](docs/AccountsApi.md#accountscpmchangenow) | **Post** /api/Accounts/{accountId}/Change | 

*AccountsApi* | [**AccountsCPMSetNext**](docs/AccountsApi.md#accountscpmsetnext) | **Post** /api/Accounts/{accountId}/SetNextPassword | 

*AccountsApi* | [**AccountsChangeCredentialsInTheVault**](docs/AccountsApi.md#accountschangecredentialsinthevault) | **Post** /api/Accounts/{accountId}/Password/Update | 

*AccountsApi* | [**AccountsCheckIn**](docs/AccountsApi.md#accountscheckin) | **Post** /api/Accounts/{accountId}/CheckIn | 

*AccountsApi* | [**AccountsClearAccount**](docs/AccountsApi.md#accountsclearaccount) | **Delete** /api/Accounts/{accountId}/LinkAccount/{extraPasswordIndex} | 

*AccountsApi* | [**AccountsDeleteAccount**](docs/AccountsApi.md#accountsdeleteaccount) | **Delete** /api/Accounts/{id} | 

*AccountsApi* | [**AccountsDownload**](docs/AccountsApi.md#accountsdownload) | **Post** /api/Accounts/{accountId}/Secret/Retrieve | 

*AccountsApi* | [**AccountsGeneratePassword**](docs/AccountsApi.md#accountsgeneratepassword) | **Post** /api/Accounts/{accountId}/Secret/Generate | 

*AccountsApi* | [**AccountsGetAccount**](docs/AccountsApi.md#accountsgetaccount) | **Get** /api/Accounts/{id} | 

*AccountsApi* | [**AccountsGetAccounts**](docs/AccountsApi.md#accountsgetaccounts) | **Get** /api/Accounts | 

*AccountsApi* | [**AccountsGetVersions**](docs/AccountsApi.md#accountsgetversions) | **Get** /api/Accounts/{accountId}/Secret/Versions | 

*AccountsApi* | [**AccountsGrantAccess**](docs/AccountsApi.md#accountsgrantaccess) | **Post** /api/Accounts/{accountId}/GrantAdministrativeAccess | 

*AccountsApi* | [**AccountsLinkAccount**](docs/AccountsApi.md#accountslinkaccount) | **Post** /api/Accounts/{id}/LinkAccount | 

*AccountsApi* | [**AccountsPSMConnect**](docs/AccountsApi.md#accountspsmconnect) | **Post** /api/Accounts/{accountId}/PSMConnect | 

*AccountsApi* | [**AccountsReconcile**](docs/AccountsApi.md#accountsreconcile) | **Post** /api/Accounts/{accountId}/Reconcile | 

*AccountsApi* | [**AccountsRetrieve**](docs/AccountsApi.md#accountsretrieve) | **Post** /api/Accounts/{accountId}/Password/Retrieve | 

*AccountsApi* | [**AccountsRevokeAccess**](docs/AccountsApi.md#accountsrevokeaccess) | **Post** /api/Accounts/{accountId}/RevokeAdministrativeAccess | 

*AccountsApi* | [**AccountsUpdateAccount**](docs/AccountsApi.md#accountsupdateaccount) | **Patch** /api/Accounts/{accountId} | 

*AccountsApi* | [**AccountsVerify**](docs/AccountsApi.md#accountsverify) | **Post** /api/Accounts/{accountId}/Verify | 

*AllowedReferrerConfigurationApi* | [**AllowedReferrerConfigurationAddAllowedReferrer**](docs/AllowedReferrerConfigurationApi.md#allowedreferrerconfigurationaddallowedreferrer) | **Post** /api/Configuration/AccessRestriction/AllowedReferrers | 

*AllowedReferrerConfigurationApi* | [**AllowedReferrerConfigurationGetAllAllowedReferrers**](docs/AllowedReferrerConfigurationApi.md#allowedreferrerconfigurationgetallallowedreferrers) | **Get** /api/Configuration/AccessRestriction/AllowedReferrers | 

*AuthApi* | [**AuthLogoff**](docs/AuthApi.md#authlogoff) | **Post** /api/Auth/Logoff | 

*AuthApi* | [**AuthLogon**](docs/AuthApi.md#authlogon) | **Post** /api/Auth/{type}/Logon | 

*AuthenticationMethodConfigurationsApi* | [**AuthenticationMethodConfigurationsAddConfigurationValue**](docs/AuthenticationMethodConfigurationsApi.md#authenticationmethodconfigurationsaddconfigurationvalue) | **Post** /api/Configuration/AuthenticationMethods | 

*AuthenticationMethodConfigurationsApi* | [**AuthenticationMethodConfigurationsDeleteAuthenticationMethod**](docs/AuthenticationMethodConfigurationsApi.md#authenticationmethodconfigurationsdeleteauthenticationmethod) | **Delete** /api/Configuration/AuthenticationMethods/{id} | 

*AuthenticationMethodConfigurationsApi* | [**AuthenticationMethodConfigurationsGetAuthenticationMethod**](docs/AuthenticationMethodConfigurationsApi.md#authenticationmethodconfigurationsgetauthenticationmethod) | **Get** /api/Configuration/AuthenticationMethods/{id} | 

*AuthenticationMethodConfigurationsApi* | [**AuthenticationMethodConfigurationsGetAuthenticationMethods**](docs/AuthenticationMethodConfigurationsApi.md#authenticationmethodconfigurationsgetauthenticationmethods) | **Get** /api/Configuration/AuthenticationMethods | 

*AuthenticationMethodConfigurationsApi* | [**AuthenticationMethodConfigurationsUpdateAuthenticationMethod**](docs/AuthenticationMethodConfigurationsApi.md#authenticationmethodconfigurationsupdateauthenticationmethod) | **Put** /api/Configuration/AuthenticationMethods/{id} | 

*AutomaticOnboardingRulesApi* | [**AutomaticOnboardingRulesDeleteAutomaticOnboardingRule**](docs/AutomaticOnboardingRulesApi.md#automaticonboardingrulesdeleteautomaticonboardingrule) | **Delete** /api/AutomaticOnboardingRules/{id} | 

*AutomaticOnboardingRulesApi* | [**AutomaticOnboardingRulesGetAutomaticOnboardingRules**](docs/AutomaticOnboardingRulesApi.md#automaticonboardingrulesgetautomaticonboardingrules) | **Get** /api/AutomaticOnboardingRules | 

*AutomaticOnboardingRulesApi* | [**AutomaticOnboardingRulesPostAutomaticOnboardingRule**](docs/AutomaticOnboardingRulesApi.md#automaticonboardingrulespostautomaticonboardingrule) | **Post** /api/AutomaticOnboardingRules | 

*AutomaticOnboardingRulesApi* | [**AutomaticOnboardingRulesUpdateAutomaticOnboardingRule**](docs/AutomaticOnboardingRulesApi.md#automaticonboardingrulesupdateautomaticonboardingrule) | **Put** /api/AutomaticOnboardingRules/{id} | 

*BulkAccountsApi* | [**BulkAccountsAddBulkAccounts**](docs/BulkAccountsApi.md#bulkaccountsaddbulkaccounts) | **Post** /api/BulkActions/Accounts | 

*BulkAccountsApi* | [**BulkAccountsGetBulkAction**](docs/BulkAccountsApi.md#bulkaccountsgetbulkaction) | **Get** /api/BulkActions/Accounts/{bulkId} | 

*BulkAccountsApi* | [**BulkAccountsGetUserBulkAccountsActions**](docs/BulkAccountsApi.md#bulkaccountsgetuserbulkaccountsactions) | **Get** /api/BulkActions/Accounts | 

*ComponentsMonitoringDetailsApi* | [**ComponentsMonitoringDetailsGetComponentsMonitoringDetails**](docs/ComponentsMonitoringDetailsApi.md#componentsmonitoringdetailsgetcomponentsmonitoringdetails) | **Get** /api/ComponentsMonitoringDetails/{componentId} | 

*ComponentsMonitoringSummaryApi* | [**ComponentsMonitoringSummaryGetComponentsMonitoringSummary**](docs/ComponentsMonitoringSummaryApi.md#componentsmonitoringsummarygetcomponentsmonitoringsummary) | **Get** /api/ComponentsMonitoringSummary | 

*ConnectionComponentsApi* | [**ConnectionComponentsImport**](docs/ConnectionComponentsApi.md#connectioncomponentsimport) | **Post** /api/ConnectionComponents/import | 

*DiscoveredAccountsApi* | [**DiscoveredAccountsAddDiscoveredAccount**](docs/DiscoveredAccountsApi.md#discoveredaccountsadddiscoveredaccount) | **Post** /api/DiscoveredAccounts | 

*DiscoveredAccountsApi* | [**DiscoveredAccountsDeleteDiscoveredAccounts**](docs/DiscoveredAccountsApi.md#discoveredaccountsdeletediscoveredaccounts) | **Delete** /api/DiscoveredAccounts | 

*DiscoveredAccountsApi* | [**DiscoveredAccountsGetDiscoveredAccount**](docs/DiscoveredAccountsApi.md#discoveredaccountsgetdiscoveredaccount) | **Get** /api/DiscoveredAccounts/{id} | 

*DiscoveredAccountsApi* | [**DiscoveredAccountsGetDiscoveredAccounts**](docs/DiscoveredAccountsApi.md#discoveredaccountsgetdiscoveredaccounts) | **Get** /api/DiscoveredAccounts | 

*IncomingRequestsApi* | [**IncomingRequestsConfirmRequests**](docs/IncomingRequestsApi.md#incomingrequestsconfirmrequests) | **Post** /api/IncomingRequests/{RequestID}/confirm | 

*IncomingRequestsApi* | [**IncomingRequestsGetRequest**](docs/IncomingRequestsApi.md#incomingrequestsgetrequest) | **Get** /api/IncomingRequests/{RequestID} | 

*IncomingRequestsApi* | [**IncomingRequestsGetRequests**](docs/IncomingRequestsApi.md#incomingrequestsgetrequests) | **Get** /api/IncomingRequests | 

*IncomingRequestsApi* | [**IncomingRequestsRejectRequests**](docs/IncomingRequestsApi.md#incomingrequestsrejectrequests) | **Post** /api/IncomingRequests/{RequestID}/reject | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesAddDirectory**](docs/LDAPDirectoriesApi.md#ldapdirectoriesadddirectory) | **Post** /api/Configuration/LDAP/Directories | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesAddDirectoryMapping**](docs/LDAPDirectoriesApi.md#ldapdirectoriesadddirectorymapping) | **Post** /api/Configuration/LDAP/Directories/{directoryName}/Mappings | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesDeleteDirectory**](docs/LDAPDirectoriesApi.md#ldapdirectoriesdeletedirectory) | **Delete** /api/Configuration/LDAP/Directories/{directoryName} | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesDeleteDirectoryMapping**](docs/LDAPDirectoriesApi.md#ldapdirectoriesdeletedirectorymapping) | **Delete** /api/Configuration/LDAP/Directories/{directoryName}/Mappings/{mappingID} | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesGetDirectories**](docs/LDAPDirectoriesApi.md#ldapdirectoriesgetdirectories) | **Get** /api/Configuration/LDAP/Directories | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesGetDirectory**](docs/LDAPDirectoriesApi.md#ldapdirectoriesgetdirectory) | **Get** /api/Configuration/LDAP/Directories/{directoryName} | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesGetDirectoryMapping**](docs/LDAPDirectoriesApi.md#ldapdirectoriesgetdirectorymapping) | **Get** /api/Configuration/LDAP/Directories/{directoryName}/Mappings/{mappingID} | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesGetDirectoryMappings**](docs/LDAPDirectoriesApi.md#ldapdirectoriesgetdirectorymappings) | **Get** /api/Configuration/LDAP/Directories/{directoryName}/Mappings | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesSetDirectoryMappingsOrder**](docs/LDAPDirectoriesApi.md#ldapdirectoriessetdirectorymappingsorder) | **Post** /api/Configuration/LDAP/Directories/{directoryName}/Mappings/Reorder | 

*LDAPDirectoriesApi* | [**LDAPDirectoriesUpdateDirectoryMapping**](docs/LDAPDirectoriesApi.md#ldapdirectoriesupdatedirectorymapping) | **Put** /api/Configuration/LDAP/Directories/{directoryName}/Mappings/{mappingID} | 

*LiveSessionsApi* | [**LiveSessionsGetLiveSession**](docs/LiveSessionsApi.md#livesessionsgetlivesession) | **Get** /api/LiveSessions/{liveSessionId} | 

*LiveSessionsApi* | [**LiveSessionsGetLiveSessionActivities**](docs/LiveSessionsApi.md#livesessionsgetlivesessionactivities) | **Get** /api/LiveSessions/{liveSessionId}/activities | 

*LiveSessionsApi* | [**LiveSessionsGetLiveSessionProperties**](docs/LiveSessionsApi.md#livesessionsgetlivesessionproperties) | **Get** /api/LiveSessions/{liveSessionId}/properties | 

*LiveSessionsApi* | [**LiveSessionsGetLiveSessions**](docs/LiveSessionsApi.md#livesessionsgetlivesessions) | **Get** /api/LiveSessions | 

*LiveSessionsApi* | [**LiveSessionsPSMAutoTermination**](docs/LiveSessionsApi.md#livesessionspsmautotermination) | **Post** /api/LiveSessions/{liveSessionId}/terminate | 

*LiveSessionsApi* | [**LiveSessionsPSMMonitor**](docs/LiveSessionsApi.md#livesessionspsmmonitor) | **Get** /api/LiveSessions/{liveSessionId}/monitor | 

*LiveSessionsApi* | [**LiveSessionsPSMSessionResume**](docs/LiveSessionsApi.md#livesessionspsmsessionresume) | **Post** /api/LiveSessions/{liveSessionId}/resume | 

*LiveSessionsApi* | [**LiveSessionsPSMSuspend**](docs/LiveSessionsApi.md#livesessionspsmsuspend) | **Post** /api/LiveSessions/{liveSessionId}/suspend | 

*LoginsInfoApi* | [**LoginsInfoGetLoginsInfo**](docs/LoginsInfoApi.md#loginsinfogetloginsinfo) | **Get** /api/LoginsInfo | 

*MyRequestsApi* | [**MyRequestsCreateRequest**](docs/MyRequestsApi.md#myrequestscreaterequest) | **Post** /api/MyRequests | 

*MyRequestsApi* | [**MyRequestsDeleteMyRequests**](docs/MyRequestsApi.md#myrequestsdeletemyrequests) | **Delete** /api/MyRequests/{RequestID} | 

*MyRequestsApi* | [**MyRequestsGetRequest**](docs/MyRequestsApi.md#myrequestsgetrequest) | **Get** /api/MyRequests/{RequestID} | 

*MyRequestsApi* | [**MyRequestsGetRequests**](docs/MyRequestsApi.md#myrequestsgetrequests) | **Get** /api/MyRequests | 

*OIDCConfigurationApi* | [**OIDCConfigurationAddProvider**](docs/OIDCConfigurationApi.md#oidcconfigurationaddprovider) | **Post** /api/Configuration/OIDC/Providers | 

*OIDCConfigurationApi* | [**OIDCConfigurationDeleteProvider**](docs/OIDCConfigurationApi.md#oidcconfigurationdeleteprovider) | **Delete** /api/Configuration/OIDC/Providers/{id} | 

*OIDCConfigurationApi* | [**OIDCConfigurationGetProvider**](docs/OIDCConfigurationApi.md#oidcconfigurationgetprovider) | **Get** /api/Configuration/OIDC/Providers/{id} | 

*OIDCConfigurationApi* | [**OIDCConfigurationGetProviders**](docs/OIDCConfigurationApi.md#oidcconfigurationgetproviders) | **Get** /api/Configuration/OIDC/Providers | 

*OIDCConfigurationApi* | [**OIDCConfigurationUpdateProvider**](docs/OIDCConfigurationApi.md#oidcconfigurationupdateprovider) | **Put** /api/Configuration/OIDC/Providers/{id} | 

*PSMConnectorsApi* | [**PSMConnectorsGetPSMConnectorsController**](docs/PSMConnectorsApi.md#psmconnectorsgetpsmconnectorscontroller) | **Get** /api/PSM/Connectors | 

*PSMServersApi* | [**PSMServersGetPSMServersController**](docs/PSMServersApi.md#psmserversgetpsmserverscontroller) | **Get** /api/PSM/Servers | 

*PlatformsApi* | [**PlatformsActivateGroupPlatform**](docs/PlatformsApi.md#platformsactivategroupplatform) | **Post** /api/Platforms/Groups/{platformID}/activate | 

*PlatformsApi* | [**PlatformsActivateRotationalGroupPlatform**](docs/PlatformsApi.md#platformsactivaterotationalgroupplatform) | **Post** /api/Platforms/RotationalGroups/{platformID}/activate | 

*PlatformsApi* | [**PlatformsActivateTargetPlatform**](docs/PlatformsApi.md#platformsactivatetargetplatform) | **Post** /api/Platforms/Targets/{platformID}/activate | 

*PlatformsApi* | [**PlatformsDeactivateGroupPlatform**](docs/PlatformsApi.md#platformsdeactivategroupplatform) | **Post** /api/Platforms/Groups/{platformID}/deactivate | 

*PlatformsApi* | [**PlatformsDeactivateRotationalGroupPlatform**](docs/PlatformsApi.md#platformsdeactivaterotationalgroupplatform) | **Post** /api/Platforms/RotationalGroups/{platformID}/deactivate | 

*PlatformsApi* | [**PlatformsDeactivateTargetPlatform**](docs/PlatformsApi.md#platformsdeactivatetargetplatform) | **Post** /api/Platforms/Targets/{platformID}/deactivate | 

*PlatformsApi* | [**PlatformsDeleteDependentPlatform**](docs/PlatformsApi.md#platformsdeletedependentplatform) | **Delete** /api/Platforms/Dependents/{platformID} | 

*PlatformsApi* | [**PlatformsDeleteGroupPlatform**](docs/PlatformsApi.md#platformsdeletegroupplatform) | **Delete** /api/Platforms/Groups/{platformID} | 

*PlatformsApi* | [**PlatformsDeleteRotationalGroupPlatform**](docs/PlatformsApi.md#platformsdeleterotationalgroupplatform) | **Delete** /api/Platforms/RotationalGroups/{platformID} | 

*PlatformsApi* | [**PlatformsDeleteTargetPlatform**](docs/PlatformsApi.md#platformsdeletetargetplatform) | **Delete** /api/Platforms/Targets/{platformID} | 

*PlatformsApi* | [**PlatformsDuplicateDependentPlatform**](docs/PlatformsApi.md#platformsduplicatedependentplatform) | **Post** /api/Platforms/Dependents/{platformID}/Duplicate | 

*PlatformsApi* | [**PlatformsDuplicateGroupPlatform**](docs/PlatformsApi.md#platformsduplicategroupplatform) | **Post** /api/Platforms/Groups/{platformID}/Duplicate | 

*PlatformsApi* | [**PlatformsDuplicateRotationalGroupPlatform**](docs/PlatformsApi.md#platformsduplicaterotationalgroupplatform) | **Post** /api/Platforms/RotationalGroups/{platformID}/Duplicate | 

*PlatformsApi* | [**PlatformsDuplicateTargetPlatform**](docs/PlatformsApi.md#platformsduplicatetargetplatform) | **Post** /api/Platforms/Targets/{platformID}/Duplicate | 

*PlatformsApi* | [**PlatformsExport**](docs/PlatformsApi.md#platformsexport) | **Post** /api/Platforms/{PlatformID}/Export | 

*PlatformsApi* | [**PlatformsExportDependentPlatform**](docs/PlatformsApi.md#platformsexportdependentplatform) | **Post** /api/Platforms/Dependents/{platformID}/Export | 

*PlatformsApi* | [**PlatformsExportGroupPlatform**](docs/PlatformsApi.md#platformsexportgroupplatform) | **Post** /api/Platforms/Groups/{platformID}/Export | 

*PlatformsApi* | [**PlatformsExportRotationalGroupPlatform**](docs/PlatformsApi.md#platformsexportrotationalgroupplatform) | **Post** /api/Platforms/RotationalGroups/{platformID}/Export | 

*PlatformsApi* | [**PlatformsExportTargetPlatform**](docs/PlatformsApi.md#platformsexporttargetplatform) | **Post** /api/Platforms/Targets/{platformID}/Export | 

*PlatformsApi* | [**PlatformsGetDependentPlaforms**](docs/PlatformsApi.md#platformsgetdependentplaforms) | **Get** /api/Platforms/Dependents | 

*PlatformsApi* | [**PlatformsGetGroupPlaforms**](docs/PlatformsApi.md#platformsgetgroupplaforms) | **Get** /api/Platforms/Groups | 

*PlatformsApi* | [**PlatformsGetPlaform**](docs/PlatformsApi.md#platformsgetplaform) | **Get** /api/Platforms/{id} | 

*PlatformsApi* | [**PlatformsGetPlatforms**](docs/PlatformsApi.md#platformsgetplatforms) | **Get** /api/Platforms | 

*PlatformsApi* | [**PlatformsGetPrivilegedSessionManagementDetails**](docs/PlatformsApi.md#platformsgetprivilegedsessionmanagementdetails) | **Get** /api/Platforms/Targets/{platformID}/PrivilegedSessionManagement | 

*PlatformsApi* | [**PlatformsGetRotationalGroupPlaforms**](docs/PlatformsApi.md#platformsgetrotationalgroupplaforms) | **Get** /api/Platforms/RotationalGroups | 

*PlatformsApi* | [**PlatformsGetSafesByPlatform**](docs/PlatformsApi.md#platformsgetsafesbyplatform) | **Get** /api/Platforms/{PlatformId}/Safes | 

*PlatformsApi* | [**PlatformsGetSystemTypes**](docs/PlatformsApi.md#platformsgetsystemtypes) | **Get** /api/Platforms/Targets/SystemTypes | 

*PlatformsApi* | [**PlatformsGetTargetPlaforms**](docs/PlatformsApi.md#platformsgettargetplaforms) | **Get** /api/Platforms/Targets | 

*PlatformsApi* | [**PlatformsImport**](docs/PlatformsApi.md#platformsimport) | **Post** /api/Platforms/import | 

*PlatformsApi* | [**PlatformsSetPrivilegedSessionManagementDetails**](docs/PlatformsApi.md#platformssetprivilegedsessionmanagementdetails) | **Put** /api/Platforms/Targets/{platformID}/PrivilegedSessionManagement | 

*RecordingsApi* | [**RecordingsGetRecording**](docs/RecordingsApi.md#recordingsgetrecording) | **Get** /api/Recordings/{recordingId} | 

*RecordingsApi* | [**RecordingsGetRecordingActivities**](docs/RecordingsApi.md#recordingsgetrecordingactivities) | **Get** /api/Recordings/{recordingId}/activities | 

*RecordingsApi* | [**RecordingsGetRecordingFileValidityStatus**](docs/RecordingsApi.md#recordingsgetrecordingfilevaliditystatus) | **Get** /api/Recordings/{recordingId}/valid | 

*RecordingsApi* | [**RecordingsGetRecordingProperties**](docs/RecordingsApi.md#recordingsgetrecordingproperties) | **Get** /api/Recordings/{recordingId}/properties | 

*RecordingsApi* | [**RecordingsGetRecordings**](docs/RecordingsApi.md#recordingsgetrecordings) | **Get** /api/Recordings | 

*RecordingsApi* | [**RecordingsPlayRecording**](docs/RecordingsApi.md#recordingsplayrecording) | **Post** /api/Recordings/{recordingId}/Play | 

*SafesApi* | [**SafesAddSafe**](docs/SafesApi.md#safesaddsafe) | **Post** /api/Safes | 

*SafesApi* | [**SafesAddSafeMember**](docs/SafesApi.md#safesaddsafemember) | **Post** /api/Safes/{safeUrlId}/members | 

*SafesApi* | [**SafesDeleteSafe**](docs/SafesApi.md#safesdeletesafe) | **Delete** /api/Safes/{safeUrlId} | 

*SafesApi* | [**SafesDeleteSafeMember**](docs/SafesApi.md#safesdeletesafemember) | **Delete** /api/Safes/{safeUrlId}/members/{memberName} | 

*SafesApi* | [**SafesGetGroups**](docs/SafesApi.md#safesgetgroups) | **Get** /api/Safes/{safeName}/accountgroups | 

*SafesApi* | [**SafesGetSafeDetails**](docs/SafesApi.md#safesgetsafedetails) | **Get** /api/Safes/{safeUrlId} | 

*SafesApi* | [**SafesGetSafeMember**](docs/SafesApi.md#safesgetsafemember) | **Get** /api/Safes/{safeUrlId}/members/{memberName} | 

*SafesApi* | [**SafesGetSafeMembers**](docs/SafesApi.md#safesgetsafemembers) | **Get** /api/Safes/{safeUrlId}/members | 

*SafesApi* | [**SafesGetSafes**](docs/SafesApi.md#safesgetsafes) | **Get** /api/Safes | 

*SafesApi* | [**SafesUpdateSafe**](docs/SafesApi.md#safesupdatesafe) | **Put** /api/Safes/{safeUrlId} | 

*SafesApi* | [**SafesUpdateSafeMember**](docs/SafesApi.md#safesupdatesafemember) | **Put** /api/Safes/{safeUrlId}/members/{memberName} | 

*UserGroupsApi* | [**UserGroupsAddMemberToGroup**](docs/UserGroupsApi.md#usergroupsaddmembertogroup) | **Post** /api/UserGroups/{groupId}/Members | 

*UserGroupsApi* | [**UserGroupsCreateUserGroup**](docs/UserGroupsApi.md#usergroupscreateusergroup) | **Post** /api/UserGroups | 

*UserGroupsApi* | [**UserGroupsDeleteUserGroup**](docs/UserGroupsApi.md#usergroupsdeleteusergroup) | **Delete** /api/UserGroups/{groupId} | 

*UserGroupsApi* | [**UserGroupsEditUserGroup**](docs/UserGroupsApi.md#usergroupseditusergroup) | **Put** /api/UserGroups/{groupId} | 

*UserGroupsApi* | [**UserGroupsGetUserGroups**](docs/UserGroupsApi.md#usergroupsgetusergroups) | **Get** /api/UserGroups | 

*UserGroupsApi* | [**UserGroupsRemoveUserFromGroup**](docs/UserGroupsApi.md#usergroupsremoveuserfromgroup) | **Delete** /api/UserGroups/{groupId}/Members/{memberName} | 

*UsersApi* | [**UsersActivateUser**](docs/UsersApi.md#usersactivateuser) | **Post** /api/Users/{userID}/Activate | 

*UsersApi* | [**UsersAddUserSSHKey**](docs/UsersApi.md#usersaddusersshkey) | **Post** /api/Users/{userID}/Secret/SSHKeys | 

*UsersApi* | [**UsersCreateUser**](docs/UsersApi.md#userscreateuser) | **Post** /api/Users | 

*UsersApi* | [**UsersDeleteUser**](docs/UsersApi.md#usersdeleteuser) | **Delete** /api/Users/{userID} | 

*UsersApi* | [**UsersDeleteUserSSHKey**](docs/UsersApi.md#usersdeleteusersshkey) | **Delete** /api/Users/{userID}/Secret/SSHKeys | 

*UsersApi* | [**UsersDestroyAllUsersCachedSSHKey**](docs/UsersApi.md#usersdestroyalluserscachedsshkey) | **Delete** /api/Users/Secret/SSHKeys/ClearCache | 

*UsersApi* | [**UsersDestroyCurrentUserCachedSSHKey**](docs/UsersApi.md#usersdestroycurrentusercachedsshkey) | **Delete** /api/Users/Secret/SSHKeys/Cache | 

*UsersApi* | [**UsersDestroyUserCachedSSHKey**](docs/UsersApi.md#usersdestroyusercachedsshkey) | **Delete** /api/Users/{userID}/Secret/SSHKeys/Cache | 

*UsersApi* | [**UsersEditUser**](docs/UsersApi.md#usersedituser) | **Put** /api/Users/{userID} | 

*UsersApi* | [**UsersGenerateCurrentUserCachedSSHKey**](docs/UsersApi.md#usersgeneratecurrentusercachedsshkey) | **Post** /api/Users/Secret/SSHKeys/Cache | 

*UsersApi* | [**UsersGenerateUserCachedSSHKey**](docs/UsersApi.md#usersgenerateusercachedsshkey) | **Post** /api/Users/{userID}/Secret/SSHKeys/Cache | 

*UsersApi* | [**UsersGetUserDetails**](docs/UsersApi.md#usersgetuserdetails) | **Get** /api/Users/{userID} | 

*UsersApi* | [**UsersGetUserSSHKeys**](docs/UsersApi.md#usersgetusersshkeys) | **Get** /api/Users/{userID}/Secret/SSHKeys | 

*UsersApi* | [**UsersGetUsers**](docs/UsersApi.md#usersgetusers) | **Get** /api/Users | 

*UsersApi* | [**UsersResetUserPassword**](docs/UsersApi.md#usersresetuserpassword) | **Post** /api/Users/{userID}/ResetPassword | 

## Documentation For Models

 - [A4b](docs/A4b.md)

 - [Account](docs/Account.md)

 - [AccountContentPrerequsites](docs/AccountContentPrerequsites.md)

 - [AccountGroup](docs/AccountGroup.md)

 - [AccountGroupMember](docs/AccountGroupMember.md)

 - [AccountInSafe](docs/AccountInSafe.md)

 - [AccountInSafeResponse](docs/AccountInSafeResponse.md)

 - [AccountModel](docs/AccountModel.md)

 - [AccountPSMConnectPrerequisites](docs/AccountPSMConnectPrerequisites.md)

 - [AdHocConnectionData](docs/AdHocConnectionData.md)

 - [AddAccountGroupData](docs/AddAccountGroupData.md)

 - [AddMemberToAccountGroup](docs/AddMemberToAccountGroup.md)

 - [AddSafeMemberRequestBody](docs/AddSafeMemberRequestBody.md)

 - [AddSafeMemberResponse](docs/AddSafeMemberResponse.md)

 - [AddSafeRequest](docs/AddSafeRequest.md)

 - [AddSafeResponse](docs/AddSafeResponse.md)

 - [AddUserSSHKeyModel](docs/AddUserSSHKeyModel.md)

 - [AllowedReferrerDto](docs/AllowedReferrerDto.md)

 - [AuthenticationMethod](docs/AuthenticationMethod.md)

 - [AuthenticationMethodBase](docs/AuthenticationMethodBase.md)

 - [AuthenticationMethodsResponse](docs/AuthenticationMethodsResponse.md)

 - [AutomaticOnboardingRuleData](docs/AutomaticOnboardingRuleData.md)

 - [AutomaticOnboardingRuleDataIn](docs/AutomaticOnboardingRuleDataIn.md)

 - [AutomaticSecretManagement](docs/AutomaticSecretManagement.md)

 - [BaseUser](docs/BaseUser.md)

 - [BaseUserGroup](docs/BaseUserGroup.md)

 - [BaseUserPersonalDetails](docs/BaseUserPersonalDetails.md)

 - [BaseUsersFilters](docs/BaseUsersFilters.md)

 - [BulkAccountModel](docs/BulkAccountModel.md)

 - [BulkAccountsList](docs/BulkAccountsList.md)

 - [BulkAccountsModel](docs/BulkAccountsModel.md)

 - [BulkAccountsOperationResult](docs/BulkAccountsOperationResult.md)

 - [BulkAccountsOperationResultExtended](docs/BulkAccountsOperationResultExtended.md)

 - [BulkOperationSummary](docs/BulkOperationSummary.md)

 - [ChangeCredentialsNowProperties](docs/ChangeCredentialsNowProperties.md)

 - [ChangeInVaultProperties](docs/ChangeInVaultProperties.md)

 - [Command](docs/Command.md)

 - [ComponentMonitoringDetailsData](docs/ComponentMonitoringDetailsData.md)

 - [ComponentMonitoringSummaryData](docs/ComponentMonitoringSummaryData.md)

 - [ComponentMonitoringSummaryVaultData](docs/ComponentMonitoringSummaryVaultData.md)

 - [ComponentsMonitoringDetailsData](docs/ComponentsMonitoringDetailsData.md)

 - [ComponentsMonitoringSummaryData](docs/ComponentsMonitoringSummaryData.md)

 - [ConfirmRejectData](docs/ConfirmRejectData.md)

 - [ConfirmerMember](docs/ConfirmerMember.md)

 - [ConfirmerStatus](docs/ConfirmerStatus.md)

 - [ConnectionParameter](docs/ConnectionParameter.md)

 - [CredentialsManagement](docs/CredentialsManagement.md)

 - [CredentialsManagementPolicy](docs/CredentialsManagementPolicy.md)

 - [DeleteUserSSHKeyModel](docs/DeleteUserSSHKeyModel.md)

 - [DependentPlatform](docs/DependentPlatform.md)

 - [DiscoveredAccount](docs/DiscoveredAccount.md)

 - [DiscoveredAccountResponse](docs/DiscoveredAccountResponse.md)

 - [DiscoveredDependency](docs/DiscoveredDependency.md)

 - [DiscoveredDependencyResponse](docs/DiscoveredDependencyResponse.md)

 - [DuplicatePlatform](docs/DuplicatePlatform.md)

 - [FilterQS](docs/FilterQS.md)

 - [General](docs/General.md)

 - [GeneratePasswordAccountDetailsJson](docs/GeneratePasswordAccountDetailsJson.md)

 - [GenerateUserCachedSSHKeyModel](docs/GenerateUserCachedSSHKeyModel.md)

 - [GenerateUserCachedSSHKeyResponse](docs/GenerateUserCachedSSHKeyResponse.md)

 - [GeneratedPassword](docs/GeneratedPassword.md)

 - [GetAccountsRequest](docs/GetAccountsRequest.md)

 - [GetAccountsResponse](docs/GetAccountsResponse.md)

 - [GetBulkAccountsActionsRequest](docs/GetBulkAccountsActionsRequest.md)

 - [GetBulkAccountsActionsResult](docs/GetBulkAccountsActionsResult.md)

 - [GetDiscoveredAccount](docs/GetDiscoveredAccount.md)

 - [GetDiscoveredAccountsRequest](docs/GetDiscoveredAccountsRequest.md)

 - [GetDiscoveredAccountsResponse](docs/GetDiscoveredAccountsResponse.md)

 - [GetDiscoveredDependency](docs/GetDiscoveredDependency.md)

 - [GetPlatformsRequest](docs/GetPlatformsRequest.md)

 - [GetPlatformsRequestBase](docs/GetPlatformsRequestBase.md)

 - [GetSafeDetailsRequest](docs/GetSafeDetailsRequest.md)

 - [GetSafeDetailsResponse](docs/GetSafeDetailsResponse.md)

 - [GetSafeMemberRequest](docs/GetSafeMemberRequest.md)

 - [GetSafeMemberResponse](docs/GetSafeMemberResponse.md)

 - [GetSafesByPlatformRequest](docs/GetSafesByPlatformRequest.md)

 - [GetSafesParams](docs/GetSafesParams.md)

 - [GetTargetPlatformsRequest](docs/GetTargetPlatformsRequest.md)

 - [GetUserGroupsResponse](docs/GetUserGroupsResponse.md)

 - [GetUserSSHKeysModel](docs/GetUserSSHKeysModel.md)

 - [GetUserSSHKeysResponse](docs/GetUserSSHKeysResponse.md)

 - [GetUsersGroupParams](docs/GetUsersGroupParams.md)

 - [GroupMember](docs/GroupMember.md)

 - [GroupMembershipDetails](docs/GroupMembershipDetails.md)

 - [GroupPlatform](docs/GroupPlatform.md)

 - [Identity](docs/Identity.md)

 - [ImportConnectionComponentData](docs/ImportConnectionComponentData.md)

 - [ImportConnectionComponentResponse](docs/ImportConnectionComponentResponse.md)

 - [ImportPlatformData](docs/ImportPlatformData.md)

 - [ImportPlatformResponse](docs/ImportPlatformResponse.md)

 - [Incident](docs/Incident.md)

 - [IncomingRequest](docs/IncomingRequest.md)

 - [JsonPatchDocumentAccountModel](docs/JsonPatchDocumentAccountModel.md)

 - [LDAPDirectory](docs/LDAPDirectory.md)

 - [LDAPDirectoryBase](docs/LDAPDirectoryBase.md)

 - [LDAPDomainController](docs/LDAPDomainController.md)

 - [LDAPMappingData](docs/LDAPMappingData.md)

 - [LDAPMappingsOrder](docs/LDAPMappingsOrder.md)

 - [LinkAccountData](docs/LinkAccountData.md)

 - [LiveSession](docs/LiveSession.md)

 - [LoginsInfoData](docs/LoginsInfoData.md)

 - [LogoffData](docs/LogoffData.md)

 - [LogonData](docs/LogonData.md)

 - [MemberGroup](docs/MemberGroup.md)

 - [MonitoringQS](docs/MonitoringQS.md)

 - [MyRequest](docs/MyRequest.md)

 - [NewRequest](docs/NewRequest.md)

 - [OPConfigurationBase](docs/OPConfigurationBase.md)

 - [OPConfigurationData](docs/OPConfigurationData.md)

 - [OPConfigurations](docs/OPConfigurations.md)

 - [OperationAccountModel](docs/OperationAccountModel.md)

 - [PSMConnector](docs/PSMConnector.md)

 - [PSMServer](docs/PSMServer.md)

 - [PTAData](docs/PTAData.md)

 - [PageQS](docs/PageQS.md)

 - [Platform](docs/Platform.md)

 - [PlatformModel](docs/PlatformModel.md)

 - [PrivateSSHKeyModel](docs/PrivateSSHKeyModel.md)

 - [PrivilegedAccessWorkflows](docs/PrivilegedAccessWorkflows.md)

 - [PrivilegedAccessWorkflowsPolicy](docs/PrivilegedAccessWorkflowsPolicy.md)

 - [PrivilegedSessionManagement](docs/PrivilegedSessionManagement.md)

 - [PrivilegedSessionManagementBase](docs/PrivilegedSessionManagementBase.md)

 - [Properties](docs/Properties.md)

 - [PublicSSHKeyModel](docs/PublicSSHKeyModel.md)

 - [ReconcileTask](docs/ReconcileTask.md)

 - [RecordedCommand](docs/RecordedCommand.md)

 - [RecordingFile](docs/RecordingFile.md)

 - [RemoteMachinesAccess](docs/RemoteMachinesAccess.md)

 - [Request](docs/Request.md)

 - [ResetUserPassword](docs/ResetUserPassword.md)

 - [RotationalGroupPlatform](docs/RotationalGroupPlatform.md)

 - [RuleFiltersQS](docs/RuleFiltersQS.md)

 - [SafeCreator](docs/SafeCreator.md)

 - [SafeCreatorResponse](docs/SafeCreatorResponse.md)

 - [SafeListItem](docs/SafeListItem.md)

 - [SafeMemberResponse](docs/SafeMemberResponse.md)

 - [SafeMembersFilter](docs/SafeMembersFilter.md)

 - [SearchQS](docs/SearchQS.md)

 - [SecretUpdateConfiguration](docs/SecretUpdateConfiguration.md)

 - [Session](docs/Session.md)

 - [SessionData](docs/SessionData.md)

 - [SessionManagement](docs/SessionManagement.md)

 - [SetNextCredentialsProperties](docs/SetNextCredentialsProperties.md)

 - [SortQS](docs/SortQS.md)

 - [SystemType](docs/SystemType.md)

 - [TargetPlatform](docs/TargetPlatform.md)

 - [TaskRole](docs/TaskRole.md)

 - [TicketingSystem](docs/TicketingSystem.md)

 - [UpdateSafeMemberRequestBody](docs/UpdateSafeMemberRequestBody.md)

 - [UpdateSafeMemberResponse](docs/UpdateSafeMemberResponse.md)

 - [UpdateSafeRequestBody](docs/UpdateSafeRequestBody.md)

 - [UpdateSafeResponse](docs/UpdateSafeResponse.md)

 - [User](docs/User.md)

 - [UserBusinessAddress](docs/UserBusinessAddress.md)

 - [UserGroup](docs/UserGroup.md)

 - [UserInternet](docs/UserInternet.md)

 - [UserPersonalDetails](docs/UserPersonalDetails.md)

 - [UserPhone](docs/UserPhone.md)

 - [UsersFilters](docs/UsersFilters.md)

 - [VersionData](docs/VersionData.md)

 - [WorkflowPolicy](docs/WorkflowPolicy.md)

## 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
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/wanmail/cyberark-pvwa

Awesome Lists containing this project

README
