\AccountsApi

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

Method	HTTP request	Description
AccountsAdHocConnect	Post /api/Accounts/AdHocConnect
AccountsAddAccount	Post /api/Accounts
AccountsCPMChangeNow	Post /api/Accounts/{accountId}/Change
AccountsCPMSetNext	Post /api/Accounts/{accountId}/SetNextPassword
AccountsChangeCredentialsInTheVault	Post /api/Accounts/{accountId}/Password/Update
AccountsCheckIn	Post /api/Accounts/{accountId}/CheckIn
AccountsClearAccount	Delete /api/Accounts/{accountId}/LinkAccount/{extraPasswordIndex}
AccountsDeleteAccount	Delete /api/Accounts/{id}
AccountsDownload	Post /api/Accounts/{accountId}/Secret/Retrieve
AccountsGeneratePassword	Post /api/Accounts/{accountId}/Secret/Generate
AccountsGetAccount	Get /api/Accounts/{id}
AccountsGetAccounts	Get /api/Accounts
AccountsGetVersions	Get /api/Accounts/{accountId}/Secret/Versions
AccountsGrantAccess	Post /api/Accounts/{accountId}/GrantAdministrativeAccess
AccountsLinkAccount	Post /api/Accounts/{id}/LinkAccount
AccountsPSMConnect	Post /api/Accounts/{accountId}/PSMConnect
AccountsReconcile	Post /api/Accounts/{accountId}/Reconcile
AccountsRetrieve	Post /api/Accounts/{accountId}/Password/Retrieve
AccountsRevokeAccess	Post /api/Accounts/{accountId}/RevokeAdministrativeAccess
AccountsUpdateAccount	Patch /api/Accounts/{accountId}
AccountsVerify	Post /api/Accounts/{accountId}/Verify

AccountsAdHocConnect

AccountsAdHocConnect(ctx).ConnectionData(connectionData).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    connectionData := *openapiclient.NewAdHocConnectionData("Secret_example", "Address_example", "UserName_example", "PlatformId_example", *openapiclient.NewAccountPSMConnectPrerequisites("ConnectionComponent_example")) // AdHocConnectionData | The information for the connection request.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsAdHocConnect(context.Background()).ConnectionData(connectionData).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsAdHocConnect``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAccountsAdHocConnectRequest struct via the builder pattern

Name	Type	Description	Notes
connectionData	AdHocConnectionData	The information for the connection request.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsAddAccount

map[string]interface{} AccountsAddAccount(ctx).Account(account).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    account := *openapiclient.NewAccountModel("PlatformId_example", "SafeName_example") // AccountModel | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsAddAccount(context.Background()).Account(account).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsAddAccount``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsAddAccount`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsAddAccount`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAccountsAddAccountRequest struct via the builder pattern

Name	Type	Description	Notes
account	AccountModel

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsCPMChangeNow

map[string]interface{} AccountsCPMChangeNow(ctx, accountId).ChangeProperties(changeProperties).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.
    changeProperties := *openapiclient.NewChangeCredentialsNowProperties() // ChangeCredentialsNowProperties | The change credentials properties.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsCPMChangeNow(context.Background(), accountId).ChangeProperties(changeProperties).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsCPMChangeNow``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsCPMChangeNow`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsCPMChangeNow`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsCPMChangeNowRequest struct via the builder pattern

Name	Type	Description	Notes

changeProperties | ChangeCredentialsNowProperties | The change credentials properties. |

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsCPMSetNext

map[string]interface{} AccountsCPMSetNext(ctx, accountId).ChangeProperties(changeProperties).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.
    changeProperties := *openapiclient.NewSetNextCredentialsProperties("NewCredentials_example") // SetNextCredentialsProperties | change properties data.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsCPMSetNext(context.Background(), accountId).ChangeProperties(changeProperties).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsCPMSetNext``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsCPMSetNext`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsCPMSetNext`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsCPMSetNextRequest struct via the builder pattern

Name	Type	Description	Notes

changeProperties | SetNextCredentialsProperties | change properties data. |

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsChangeCredentialsInTheVault

map[string]interface{} AccountsChangeCredentialsInTheVault(ctx, accountId).ChangeProperties(changeProperties).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.
    changeProperties := *openapiclient.NewChangeInVaultProperties("NewCredentials_example") // ChangeInVaultProperties | The change properties data.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsChangeCredentialsInTheVault(context.Background(), accountId).ChangeProperties(changeProperties).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsChangeCredentialsInTheVault``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsChangeCredentialsInTheVault`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsChangeCredentialsInTheVault`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsChangeCredentialsInTheVaultRequest struct via the builder pattern

Name	Type	Description	Notes

changeProperties | ChangeInVaultProperties | The change properties data. |

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsCheckIn

map[string]interface{} AccountsCheckIn(ctx, accountId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsCheckIn(context.Background(), accountId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsCheckIn``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsCheckIn`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsCheckIn`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsCheckInRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsClearAccount

AccountsClearAccount(ctx, accountId, extraPasswordIndex).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.
    extraPasswordIndex := int32(56) // int32 | The linked account's extra password index.              The index can be for Reconcile account, Logon account, or other linked account that is defined in the Platform configuration.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsClearAccount(context.Background(), accountId, extraPasswordIndex).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsClearAccount``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.
extraPasswordIndex	int32	The linked account's extra password index. The index can be for Reconcile account, Logon account, or other linked account that is defined in the Platform configuration.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsClearAccountRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsDeleteAccount

map[string]interface{} AccountsDeleteAccount(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The account's unique ID, composed of the SafeID and internal AccountID of the account to delete.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsDeleteAccount(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsDeleteAccount``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsDeleteAccount`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsDeleteAccount`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The account's unique ID, composed of the SafeID and internal AccountID of the account to delete.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsDeleteAccountRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsDownload

map[string]interface{} AccountsDownload(ctx, accountId).AccountContentPrerequisites(accountContentPrerequisites).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.
    accountContentPrerequisites := *openapiclient.NewAccountContentPrerequsites() // AccountContentPrerequsites | The account content prerequisites.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsDownload(context.Background(), accountId).AccountContentPrerequisites(accountContentPrerequisites).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsDownload``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsDownload`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsDownload`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsDownloadRequest struct via the builder pattern

Name	Type	Description	Notes

accountContentPrerequisites | AccountContentPrerequsites | The account content prerequisites. |

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsGeneratePassword

[]GeneratedPassword AccountsGeneratePassword(ctx, accountId).AccDetails(accDetails).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | Unique ID of the account.
    accDetails := *openapiclient.NewGeneratePasswordAccountDetailsJson("AccountId_example") // GeneratePasswordAccountDetailsJson | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsGeneratePassword(context.Background(), accountId).AccDetails(accDetails).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsGeneratePassword``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsGeneratePassword`: []GeneratedPassword
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsGeneratePassword`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	Unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsGeneratePasswordRequest struct via the builder pattern

Name	Type	Description	Notes

accDetails | GeneratePasswordAccountDetailsJson | |

Return type

[]GeneratedPassword

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsGetAccount

AccountModel AccountsGetAccount(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The account's unique ID.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsGetAccount(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsGetAccount``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsGetAccount`: AccountModel
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsGetAccount`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The account's unique ID.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsGetAccountRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

AccountModel

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsGetAccounts

GetAccountsResponse AccountsGetAccounts(ctx).Search(search).Sort(sort).Offset(offset).Limit(limit).Filter(filter).SearchType(searchType).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    search := "search_example" // string | List of keywords separated with space to search in accounts. (optional)
    sort := []string{"Inner_example"} // []string | Property or properties to sort returned accounts, followed by asc (default) or desc to control sort direction. Multiple sorts are comma-separated. Maximum number of properties is 3. (optional)
    offset := int32(56) // int32 | Offset of the first returned account into the collection of results. (optional)
    limit := int32(56) // int32 | Maximum number of returned accounts. If not specified, the default value is 50. The maximum number that can be specified is 1000. (optional)
    filter := "filter_example" // string | Search for accounts filtered by specific Safe. Filter=safename eq [safe name] (optional)
    searchType := "searchType_example" // string | Type of search to perform - if keywords are contained in the relevant account properties values or in the start of the properties values (the later enhances performance) (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsGetAccounts(context.Background()).Search(search).Sort(sort).Offset(offset).Limit(limit).Filter(filter).SearchType(searchType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsGetAccounts``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsGetAccounts`: GetAccountsResponse
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsGetAccounts`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAccountsGetAccountsRequest struct via the builder pattern

Name	Type	Description
search	string	List of keywords separated with space to search in accounts.
sort	[]string	Property or properties to sort returned accounts, followed by asc (default) or desc to control sort direction. Multiple sorts are comma-separated. Maximum number of properties is 3.
offset	int32	Offset of the first returned account into the collection of results.
limit	int32	Maximum number of returned accounts. If not specified, the default value is 50. The maximum number that can be specified is 1000.
filter	string	Search for accounts filtered by specific Safe. Filter=safename eq [safe name]
searchType	string	Type of search to perform - if keywords are contained in the relevant account properties values or in the start of the properties values (the later enhances performance)

Return type

GetAccountsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsGetVersions

[]VersionData AccountsGetVersions(ctx, accountId).ShowTemporary(showTemporary).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.
    showTemporary := true // bool | Whether to return both real and temporary password version or only real. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsGetVersions(context.Background(), accountId).ShowTemporary(showTemporary).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsGetVersions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsGetVersions`: []VersionData
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsGetVersions`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsGetVersionsRequest struct via the builder pattern

Name	Type	Description	Notes

showTemporary | bool | Whether to return both real and temporary password version or only real. |

Return type

[]VersionData

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsGrantAccess

map[string]interface{} AccountsGrantAccess(ctx, accountId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The local account that will be used to add the logged on user to the Administrators group on the machine.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsGrantAccess(context.Background(), accountId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsGrantAccess``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsGrantAccess`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsGrantAccess`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The local account that will be used to add the logged on user to the Administrators group on the machine.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsGrantAccessRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsLinkAccount

AccountsLinkAccount(ctx, id).LinkAccount(linkAccount).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | The unique ID of the account.
    linkAccount := *openapiclient.NewLinkAccountData("Name_example", "Safe_example", "Folder_example", int32(123)) // LinkAccountData | The details of the linked account.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsLinkAccount(context.Background(), id).LinkAccount(linkAccount).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsLinkAccount``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsLinkAccountRequest struct via the builder pattern

Name	Type	Description	Notes

linkAccount | LinkAccountData | The details of the linked account. |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsPSMConnect

AccountsPSMConnect(ctx, accountId).Request(request).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account to retrieve and use to connect to the target system through PSM.
    request := *openapiclient.NewAccountPSMConnectPrerequisites("ConnectionComponent_example") // AccountPSMConnectPrerequisites | The information of the request to connect.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsPSMConnect(context.Background(), accountId).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsPSMConnect``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account to retrieve and use to connect to the target system through PSM.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsPSMConnectRequest struct via the builder pattern

Name	Type	Description	Notes

request | AccountPSMConnectPrerequisites | The information of the request to connect. |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsReconcile

map[string]interface{} AccountsReconcile(ctx, accountId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsReconcile(context.Background(), accountId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsReconcile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsReconcile`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsReconcile`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsReconcileRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsRetrieve

map[string]interface{} AccountsRetrieve(ctx, accountId).AccountContentPrerequisites(accountContentPrerequisites).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.
    accountContentPrerequisites := *openapiclient.NewAccountContentPrerequsites() // AccountContentPrerequsites | The account content prerequisites.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsRetrieve(context.Background(), accountId).AccountContentPrerequisites(accountContentPrerequisites).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsRetrieve`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

accountContentPrerequisites | AccountContentPrerequsites | The account content prerequisites. |

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsRevokeAccess

AccountsRevokeAccess(ctx, accountId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The local account for the target machine on which the logged on user will be removed from the Administrators group

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsRevokeAccess(context.Background(), accountId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsRevokeAccess``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The local account for the target machine on which the logged on user will be removed from the Administrators group

Other Parameters

Other parameters are passed through a pointer to a apiAccountsRevokeAccessRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsUpdateAccount

AccountModel AccountsUpdateAccount(ctx, accountId).AccountPatch(accountPatch).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account to update. This is retrieved by the Get Account Service.
    accountPatch := *openapiclient.NewJsonPatchDocumentAccountModel() // JsonPatchDocumentAccountModel | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsUpdateAccount(context.Background(), accountId).AccountPatch(accountPatch).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsUpdateAccount``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsUpdateAccount`: AccountModel
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsUpdateAccount`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account to update. This is retrieved by the Get Account Service.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsUpdateAccountRequest struct via the builder pattern

Name	Type	Description	Notes

accountPatch | JsonPatchDocumentAccountModel | |

Return type

AccountModel

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsVerify

map[string]interface{} AccountsVerify(ctx, accountId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    accountId := "accountId_example" // string | The unique ID of the account.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccountsApi.AccountsVerify(context.Background(), accountId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccountsApi.AccountsVerify``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AccountsVerify`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `AccountsApi.AccountsVerify`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	string	The unique ID of the account.

Other Parameters

Other parameters are passed through a pointer to a apiAccountsVerifyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml, multipart/form-data, application/vnd.cyberark.api+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AccountsApi.md

Latest commit

History

AccountsApi.md

File metadata and controls

\AccountsApi

AccountsAdHocConnect

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsAddAccount

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsCPMChangeNow

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsCPMSetNext

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsChangeCredentialsInTheVault

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsCheckIn

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsClearAccount

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsDeleteAccount

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsDownload

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsGeneratePassword

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AccountsGetAccount

Example

Path Parameters