docs/api-map.json

{
  "New-SIASession": {
    "method": "POST",
    "endpoint": "/oauth2/platformtoken",
    "apiVersion": "n/a",
    "documentation": "https://api-docs.cyberark.com/create-api-token/docs/create-api-token",
    "service": "Idira Identity Security Platform"
  },
  "Get-SIASession": {
    "method": null,
    "endpoint": null,
    "apiVersion": null,
    "documentation": null,
    "service": "client-side"
  },
  "Close-SIASession": {
    "method": null,
    "endpoint": null,
    "apiVersion": null,
    "documentation": null,
    "service": "client-side"
  },
  "Get-SIAConnector": {
    "method": "GET",
    "endpoint": "/api/connectors",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Add-SIAConnectorPoolAssignment": {
    "method": "POST",
    "endpoint": "/api/connectors/connector-pools/{connector_pool_id}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Update-SIAConnector": {
    "method": "POST",
    "endpoint": "/api/connectors/{connector_id}/upgrade | /api/connectors/{connector_id}/rotate",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Test-SIAConnector": {
    "method": "POST",
    "endpoint": "/api/connectors/{connector_id}/reachability",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Remove-SIAConnector": {
    "method": "DELETE",
    "endpoint": "/api/connectors/{connector_id}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "New-SIAConnectorInstallScript": {
    "method": "POST",
    "endpoint": "/api/connectors/setup-script",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Set-SIAConnectorMaintenanceMode": {
    "method": "PUT",
    "endpoint": "/api/connectors/{connector_id}/maintenance",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIAHttpsRelay": {
    "method": "GET",
    "endpoint": "/api/https-relays",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Remove-SIAHttpsRelay": {
    "method": "DELETE",
    "endpoint": "/api/https-relays/{https_relay_id}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "New-SIAHttpsRelayInstallScript": {
    "method": "POST",
    "endpoint": "/api/https-relays/setup-script",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Update-SIAHttpsRelay": {
    "method": "POST",
    "endpoint": "/api/https-relays/{https_relay_id}/upgrade | /api/https-relays/{https_relay_id}/rotate",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIAWindowsStrongAccount": {
    "method": "GET",
    "endpoint": "/api/secrets/public/v1 | /api/secrets/public/v2 | /api/secrets/public/v1/{secret_id}",
    "apiVersion": "2.0.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa-strong-accounts-api.htm",
    "service": "Secure Infrastructure Access"
  },
  "New-SIAWindowsStrongAccount": {
    "method": "POST",
    "endpoint": "/api/secrets/public/v1",
    "apiVersion": "2.0.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa-strong-accounts-api.htm",
    "service": "Secure Infrastructure Access"
  },
  "Set-SIAWindowsStrongAccount": {
    "method": "PUT",
    "endpoint": "/api/secrets/public/v1/{secret_id}",
    "apiVersion": "2.0.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa-strong-accounts-api.htm",
    "service": "Secure Infrastructure Access"
  },
  "Remove-SIAWindowsStrongAccount": {
    "method": "DELETE",
    "endpoint": "/api/secrets/public/v1/{secret_id}",
    "apiVersion": "2.0.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa-strong-accounts-api.htm",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIADatabaseStrongAccount": {
    "method": "GET",
    "endpoint": "/api/database-strong-accounts | /api/database-strong-accounts/{strong_account_id}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/strong-account-apis-for-sia-databases",
    "service": "Secure Infrastructure Access"
  },
  "New-SIADatabaseStrongAccount": {
    "method": "POST",
    "endpoint": "/api/database-strong-accounts",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/strong-account-apis-for-sia-databases",
    "service": "Secure Infrastructure Access"
  },
  "Set-SIADatabaseStrongAccount": {
    "method": "PUT",
    "endpoint": "/api/database-strong-accounts/{strong_account_id}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/strong-account-apis-for-sia-databases",
    "service": "Secure Infrastructure Access"
  },
  "Remove-SIADatabaseStrongAccount": {
    "method": "DELETE",
    "endpoint": "/api/database-strong-accounts/{strong_account_id}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/strong-account-apis-for-sia-databases",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIATargetSet": {
    "method": "GET",
    "endpoint": "/api/targetsets",
    "apiVersion": "0.2.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa-target-sets.htm",
    "service": "Secure Infrastructure Access"
  },
  "New-SIATargetSet": {
    "method": "POST",
    "endpoint": "/api/targetsets/bulk",
    "apiVersion": "0.2.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa-target-sets.htm",
    "service": "Secure Infrastructure Access"
  },
  "Remove-SIATargetSet": {
    "method": "DELETE",
    "endpoint": "/api/targetsets/bulk",
    "apiVersion": "0.2.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa-target-sets.htm",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIASSHCAPublicKey": {
    "method": "GET",
    "endpoint": "/api/public-keys",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-public-keys-api",
    "service": "Secure Infrastructure Access"
  },
  "New-SIASSHCAPublicKeyScript": {
    "method": "GET",
    "endpoint": "/api/public-keys/scripts",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-public-keys-api",
    "service": "Secure Infrastructure Access"
  },
  "Update-SIASSHCAPublicKey": {
    "method": "POST",
    "endpoint": "/api/public-keys/rotation/generate-new",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-public-keys-api",
    "service": "Secure Infrastructure Access"
  },
  "Disable-SIASSHCAPublicKey": {
    "method": "POST",
    "endpoint": "/api/public-keys/rotation/deactivate-previous",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-public-keys-api",
    "service": "Secure Infrastructure Access"
  },
  "Enable-SIASSHCAPublicKey": {
    "method": "POST",
    "endpoint": "/api/public-keys/rotation/reactivate-previous",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-public-keys-api",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIAMFAKey": {
    "method": "GET",
    "endpoint": "/api/ssh/sso/key",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-mfa-key-api",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIASetting": {
    "method": "GET",
    "endpoint": "/api/settings | /api/settings/{feature_name}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-settings-api",
    "service": "Secure Infrastructure Access"
  },
  "Set-SIASetting": {
    "method": "PUT | PATCH",
    "endpoint": "/api/settings | /api/settings/{feature_name}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-settings-api",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIASSHHostKeyFingerprint": {
    "method": "GET",
    "endpoint": "/api/ssh-fingerprints/{target_id}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-host-key-fingerprints-api",
    "service": "Secure Infrastructure Access"
  },
  "Add-SIASSHHostKeyFingerprint": {
    "method": "POST",
    "endpoint": "/api/ssh-fingerprints",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-host-key-fingerprints-api",
    "service": "Secure Infrastructure Access"
  },
  "Set-SIASSHHostKeyFingerprint": {
    "method": "PUT",
    "endpoint": "/api/ssh-fingerprints",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-host-key-fingerprints-api",
    "service": "Secure Infrastructure Access"
  },
  "Remove-SIASSHHostKeyFingerprint": {
    "method": "DELETE",
    "endpoint": "/api/ssh-fingerprints/{target_id}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-infra-access/docs/sia-ssh-host-key-fingerprints-api",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIAAccessPolicy": {
    "method": "GET",
    "endpoint": "/api/access-policies | /api/access-policies/{policy_id}",
    "apiVersion": "1.0.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa_policies.htm",
    "service": "Secure Infrastructure Access"
  },
  "New-SIAAccessPolicy": {
    "method": "POST",
    "endpoint": "/api/access-policies",
    "apiVersion": "1.0.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa_policies.htm",
    "service": "Secure Infrastructure Access"
  },
  "Set-SIAAccessPolicy": {
    "method": "PUT",
    "endpoint": "/api/access-policies/{policy_id}",
    "apiVersion": "1.0.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa_policies.htm",
    "service": "Secure Infrastructure Access"
  },
  "Remove-SIAAccessPolicy": {
    "method": "DELETE",
    "endpoint": "/api/access-policies/{policy_id}",
    "apiVersion": "1.0.0",
    "documentation": "https://docs.cyberark.com/setup/latest/en/content/privileged-access/apis/dpa_policies.htm",
    "service": "Secure Infrastructure Access"
  },
  "Get-SIAPolicy": {
    "method": "GET",
    "endpoint": "/policies | /policies/{policyId}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/uap-schema-api/docs/access-control-policies-api",
    "service": "Access Control Policies"
  },
  "New-SIAPolicy": {
    "method": "POST",
    "endpoint": "/policies",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/uap-schema-api/docs/access-control-policies-api",
    "service": "Access Control Policies"
  },
  "Set-SIAPolicy": {
    "method": "PUT",
    "endpoint": "/policies/{policyId}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/uap-schema-api/docs/access-control-policies-api",
    "service": "Access Control Policies"
  },
  "Remove-SIAPolicy": {
    "method": "DELETE",
    "endpoint": "/policies/{policyId}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/uap-schema-api/docs/access-control-policies-api",
    "service": "Access Control Policies"
  },
  "Test-SIAPolicy": {
    "method": "POST",
    "endpoint": "/policies/{policyId}/validate",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/uap-schema-api/docs/access-control-policies-api",
    "service": "Access Control Policies"
  },
  "Get-SIAAccessRequestForm": {
    "method": "GET",
    "endpoint": "/workflows/request-forms",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/access-request-api/docs/access-request-api",
    "service": "Access Requests"
  },
  "Get-SIAAccessRequest": {
    "method": "GET",
    "endpoint": "/workflows/requests | /workflows/requests/{requestId}",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/access-request-api/docs/access-request-api",
    "service": "Access Requests"
  },
  "New-SIAAccessRequest": {
    "method": "POST",
    "endpoint": "/workflows/requests",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/access-request-api/docs/access-request-api",
    "service": "Access Requests"
  },
  "Stop-SIAAccessRequest": {
    "method": "POST",
    "endpoint": "/workflows/requests/{requestId}/cancel",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/access-request-api/docs/access-request-api",
    "service": "Access Requests"
  },
  "Approve-SIAAccessRequest": {
    "method": "POST",
    "endpoint": "/workflows/requests/{requestId}/finalize",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/access-request-api/docs/access-request-api",
    "service": "Access Requests"
  },
  "Deny-SIAAccessRequest": {
    "method": "POST",
    "endpoint": "/workflows/requests/{requestId}/finalize",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/access-request-api/docs/access-request-api",
    "service": "Access Requests"
  },
  "Get-SIAAsset": {
    "method": "GET",
    "endpoint": "/api/assets",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-access/docs/secure-access-api",
    "service": "Access"
  },
  "Unlock-SIAAssetSecret": {
    "method": "POST",
    "endpoint": "/api/assets/{assetId}/secret",
    "apiVersion": "main-public",
    "documentation": "https://api-docs.cyberark.com/secure-access/docs/secure-access-api",
    "service": "Access"
  },
  "Get-SIAModuleConfiguration": {
    "method": null,
    "endpoint": null,
    "apiVersion": null,
    "documentation": null,
    "service": "client-side"
  },
  "Set-SIAModuleConfiguration": {
    "method": null,
    "endpoint": null,
    "apiVersion": null,
    "documentation": null,
    "service": "client-side"
  }
}