For AI agents: visit https://october.jeffarnim.com/childpath/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Guides
API Reference
Changelog
Custom Link
v1.0-ja
v1.0
v2.0.0
Log In
API Reference
Log In
English
v1.0
Home
Guides
API Reference
Changelog
Custom Link
New Page
JUMP TO
Authentication
My Requests
Updated Name
getting-started-with-the-simulator
Authentication
Metrics
Socure API Reference
ID+
Create a transaction
post
Predictive Document Verification
Document Request endpoint version 5
post
Document Request endpoint version 3
post
Image Request endpoint version 5
get
Image Request endpoint version 3
get
DocV Expire Session endpoint
post
One-Time Passcode Verification
Generate a one-time code
post
Verify an input one-time passcode
post
Reason Code
Retrieve a list of reason codes
get
Transaction Details
Retrieve transaction details by referenceId
get
Feedback
Send feedback data to Socure
post
Custom Watchlist
Update a custom watchlist
post
Events
Manage Global Watchlist transactions
post
Retrieve Global Watchlist transaction details
get
Retrieve Predictive DocV transaction details
get
Webhooks
New Global Watchlist event
post
New Global Watchlist auto-enrolled event
post
Predictive DocV events
post
Predictive DocV Multiple Document Capture events
post
Webhook Secret Key
Add a webhook secret key
post
Accounts and Ledgers Events API
Account Events
account_created.v1
post
account_updated.v1
post
account_closed.v1
post
Transaction Events
transaction_created.v1
post
transaction_declined.v1
post
Program API
Transactions
Get Transaction History
post
Get Authorization History
post
Get Account Overview
post
Create ACH Transaction
post
Add Paper Biller
post
Modify Paper Biller
post
Add RPPS Biller
post
Cancel Bill Payment
post
Create Bill Payment
post
Get Billers
post
Remove Biller
post
Get Bill Payment History
post
Modify RPPS Biller
post
Create Account Transfer
post
Get Deposit History
post
Get All Transaction History
post
Get Pending Fees
post
Get Payment History
post
Get Fee History
post
Get Fee Summary
post
Get ACH Accounts
post
Modify ACH Account
post
Add ACH Account
post
Remove ACH Account
post
Cancel ACH Transaction
post
Get ACH Transaction History
post
Add ACH Account Corporate
post
Create Hold
post
Expire Hold
post
Create Payment
post
Assess Fee
post
Reverse Fee
post
Create Adjustment
post
Reverse Adjustment
post
Get Hold History
post
Update Payment
post
Reverse Account Transfer
post
Update Pending Merchant Credit
post
Get Pending Merchant Credits
post
Modify Pending Deposit Status
post
Get Pending Deposits
post
Expire Authorization
post
Search Biller Directory
post
Get Scheduled Bill Payments
post
Get Direct Deposit Switch Token
post
Get Billpay Switch Token
post
Accounts and Cards
Get Balance
post
Create Account
post
Get Account Cards
post
Modify Status
post
Add Account
post
Update Account
post
Get Card
post
Get Access Token
post
Add Card
post
Create Provisioning Request
post
Create Single-Use Virtual Card
post
Get Savings Interest
post
Get Interest
post
Start Enrollment
post
Get Enrollment Info
post
Update Enrollment
post
Verify Enrollment
post
Complete Enrollment
post
Run Enrollment CIP
post
Run CIP
post
Create Virtual Card Account
post
Force Pass CIP
post
Get Account Features
post
Set Account Feature
post
Verify Account
post
Get Customer Note History
post
Add Customer Note
post
Set User-Defined Account Field
post
Get User-Defined Account Fields
post
Get Account by ID
post
Get Related Accounts
post
Search Accounts
post
Charge Off Account
post
Switch Product
post
Set Roundup Accounts
post
Get Roundup Accounts
post
Recover Charged-Off Account
post
Activate Card
post
Get Card PIN-Change Key
post
Commit Card PIN Change
post
Void Add Card
post
Reset Card PIN-Fail Count
post
Verify Card Security Code
post
Reissue Card
post
Replace Lost/Stolen Card
post
Get Card Tokens
post
Manage Card Token
post
Miscellaneous
Ping
post
Get Promontory Bank List
post
Get Ingo Customer ID
post
Get Call Status
post
Get Product Info
post
Transaction Simulation
Create Simulated Card Authorization
post
Create Simulated Card Settlement
post
Create Simulated Incoming ACH Transaction
post
Cancel Simulated Incoming ACH Transaction
post
Get Simulated Incoming ACH Transaction
post
Get All Simulated Incoming ACH Transactions
post
Overdraft
Get Overdraft Balance
post
Federal Benefit Enrollment
Create Federal Benefit Enrollment
post
Update Federal Benefit Enrollment
post
Get Federal Benefit Enrollments
post
Resubmit Federal Benefit Enrollment
post
Instant Issue
Void Create Account
post
Verify Instant-Issue Card
post
Move Card
post
Get Bulk Card Order
post
Create Bulk Card Order
post
Move Card Inventory
post
Get Load Locations
post
Account-Level Controls
Set Account-Level Auth Control
post
Get Auth Control
post
Get MCC Controls
post
Get Merchant Controls
post
Set Account-Level MCC Controls
post
Set Account-Level Merchant Control
post
Delete Account-Level Auth Control
post
Delete Account-Level MCC Control
post
Delete Account-Level Merchant Control
post
Corporate Credit and RTF
Get RTF Account Relationship
post
Get Corporate Credit Change History
post
Get Corporate Credit Summary
post
Set Corporate Credit Limit
post
Is Corporate Credit Funding Account
post
Is Corporate Credit Spending Account
post
Is RTF Funding Account
post
Is RTF Spending Account
post
Credit
Get Credit Limit Change History
post
Set Credit Limit
post
Get Credit Summary
post
Set AutoPay Plan
post
Set AutoPay Attempt
post
Get AutoPay History
post
Get Authorized Users
post
Location Management
Create Location
post
Modify Location
post
Get Locations
post
Create Location Fee
post
Modify Location Fee
post
IVR
Get IVR Call Status
post
Create IVR Call
post
Get IVR Call Identifier
post
Corporate Hierarchy
Create Group
post
Update Group
post
Get Root Groups
post
Get Groups Info
post
Set Account Group Relationships
post
Remove Account Group Relationship
post
Get Group Hierarchy
post
Get Account Group Relationships
post
Delete Groups
post
Alerts
Get Alerts
post
Get Alerts Blackout
post
Get Carriers List
post
Modify On-Demand Alert Status
post
Set Alerts
post
Set Alerts Blackout
post
Verify On-Demand Alert Status
post
HR API (Refactored)
Section 1
List employees (updated title)
get
Create employee
post
Section 2
Employee details
get
Section 3
Endpoint Title
get
Summary content
post
Zero Hash API
New Page
Sigma Computing Public REST API
accountTypes
List account types
get
Create an account type
post
Delete an account type
del
List account type permissions
get
allowedIps
List IP allowlist entries (Beta)
get
allowedIps\:batchCreate
Create IP allowlist entries (Beta)
post
allowedIps\:batchDelete
Delete IP allowlist entries (Beta)
post
auth
Get access token
post
connections
Look up connections by path
post
List connections
get
Create a connection
post
Update a connection
patch
Get connection details
get
Delete a connection
del
Update a connection
put
Add grants to a connection
post
List grants for a connection
get
Delete a grant for a connection
del
Sync a connection by path
post
Test a connection
get
List connection paths
get
Add grants to a connection path
post
List grants for a connection path
get
Delete a grant for a connection path
del
Get connection path for a table
get
Create a connection (Beta)
post
Update a connection (Beta)
patch
Get connection details (Beta)
get
Add dbt metadata for a connection (Beta)
post
List columns for a warehouse table
get
credentials
Create API credentials
post
Delete API credentials
del
dataModels
List data models
get
Get a data model
get
Run a scheduled materialization for a data model element
post
List columns for all elements in a data model
get
List elements in a data model
get
List lineage for a data model
get
Get a materialization job
get
List materialization schedules for a data model
get
List data model sources
get
Get the code representation of a data model
get
Update a data model from a code representation
put
Swap data model sources
post
List tags for a data model
get
Create a data model from a code representation
post
Tag a data model
post
Swap data model sources (Beta)
post
datasets
List datasets (Deprecated)
get
Get a dataset (Deprecated)
get
Get grants for a dataset (Deprecated)
get
Grant permissions on a dataset (Deprecated)
post
Delete a permission granted on a dataset (Deprecated)
del
Materialize a dataset (Deprecated)
post
List materializations for a dataset (Deprecated)
get
List dataset sources (Deprecated)
get
Migrate a dataset to a data model (Beta)
post
deploymentPolicies
Create a deployment policy (Beta)
post
List deployment policies (Beta)
get
Get a deployment policy (Beta)
get
Archive a deployment policy (Beta)
del
List documents for a deployment policy (Beta)
get
Add documents to a deployment policy (Beta)
post
Remove a document from a deployment policy (Beta)
del
Add a tenant to a deployment policy (Beta)
post
List tenants for a deployment policy (Beta)
get
Remove a tenant from a deployment policy (Beta)
del
List deployable tenant organizations (Beta)
get
favorites
Favorite a document
post
Get favorite documents for a user
get
Unfavorite a document
del
files
List files
get
Create a file
post
Get file information
get
Update a file
patch
Delete a file
del
grants
List grants
get
Create or update a grant
post
Get a grant
get
Delete a grant
del
members
List members
get
Create a member
post
Get member
get
Update member
patch
Deactivate member
del
List member files
get
List all favorite documents of a member
get
List recent files for a member
get
List teams for a member
get
List members (Paginated)
get
List scheduled exports for a user
get
query
Download an exported file
get
saml
List SAML service providers (Beta)
get
List SAML service provider certificates (Beta)
get
Create a SAML service provider certificate (Beta)
post
Get a SAML service provider certificate (Beta)
get
Remove a SAML service provider certificate (Beta)
del
Activate a SAML service provider certificate (Beta)
post
Deactivate a SAML service provider certificate (Beta)
post
shared_templates
Delete a template share
del
Accept a pending template share
post
List templates shared with your organization
get
sourceSwapPolicies
Create a source swap policy (Beta)
post
List source swap policies (Beta)
get
Update a source swap policy (Beta)
patch
Delete a source swap policy (Beta)
del
Get a source swap policy (Beta)
get
tags
Create a tag
post
Get tags
get
Delete a tag
del
Update a tag
patch
List workbooks for a tag
get
teams
List teams
get
Create a team
post
Get a team
get
Update a team
patch
Delete a team
del
Assign user attributes to a team
post
List team members
get
Update team members
patch
Get team user attributes
get
List teams (Paginated)
get
templates
List templates
get
Get template
get
Swap template data sources
post
Create workbook from template
post
tenants
Create a tenant organization (Beta)
post
List tenant organizations (Beta)
get
Update details of a tenant organization (Beta)
patch
Delete a tenant organization (Beta)
del
Get details for a tenant organization (Beta)
get
List tenant deployment capabilities (Beta)
get
Add deployment capabilities to a tenant (Beta)
post
Remove deployment capabilities from a tenant (Beta)
post
Get deployed workbook in tenant organization (Beta)
get
translations
List organization translation files
get
Create organization translation file
post
Get organization translation file
get
Update organization translation file
put
Delete organization translation file
del
Get organization translation file with variant
get
Update organization translation file with variant
put
Delete organization translation file with variant
del
user-attributes
List user attributes
get
Create a user attribute
post
Delete a user attribute
del
Get a user attribute
get
Get teams for a user attribute
get
Update a user attribute for teams
patch
Set a user attribute for teams
post
Delete a user attribute for a team
del
Get tenants for a user attribute
get
Update a user attribute for tenants (Beta)
patch
Set a user attribute for tenants (Beta)
post
Delete a user attribute for a tenant (Beta)
del
Get users for a user attribute
get
Update a user attribute for users
patch
Set a user attribute for users
post
Delete a user attribute for a user
del
webhooks
Send to a webhook (Beta)
post
whoami
Get current user
get
workbooks
List workbooks
get
Create a workbook
post
Get a workbook
get
List bookmarks in a workbook
get
Add a bookmark to a workbook
post
Get a bookmark
get
Update a workbook bookmark
patch
Delete a bookmark from a workbook
del
List columns for all elements in a workbook
get
List workbook controls
get
Duplicate a workbook
post
List elements in a workbook
get
List columns for a workbook element
get
Get the SQL query for a workbook element
get
Get embeds for a workbook
get
Create an embed for a workbook
post
Delete an embed from a workbook
del
Export data from a workbook
post
Grant permissions on a workbook to users or teams
post
Delete a workbook grant
del
List lineage for a workbook
get
List lineage of a workbook element
get
List materialization schedules for a workbook
get
Run a scheduled materialization for a workbook element
post
Get a materialization job
get
List workbook pages for a workbook
get
List elements in a workbook page
get
List SQL queries in a workbook
get
Save a template from a workbook
post
List scheduled workbook exports
get
Add workbook schedule
post
Update a workbook schedule
patch
Delete a scheduled export for a workbook
del
Get workbook schema
get
Export a workbook
post
Share a workbook with another organization
post
List workbook sources
get
Swap workbook data sources
post
Duplicate a tagged workbook
post
Get tags for a workbook
get
Remove a tag from a workbook
del
List bookmarks in a tagged workbook
get
Add a bookmark to a tagged workbook
post
Get a bookmark in a tagged workbook
get
Update a bookmark in a tagged workbook
patch
Delete a bookmark from a tagged workbook
del
Get version history for a workbook
get
Tag a workbook
post
List materialization schedules for a workbook (Paginated)
get
List scheduled workbook exports (Paginated)
get
Swap workbook sources (Beta)
post
Get the code representation of a workbook (Beta)
get
Update a workbook from a code representation (Beta)
put
Create a workbook from a code representation (Beta)
post
workspaces
List workspaces
get
Create a workspace
post
Get a workspace
get
Update a workspace
patch
Delete a workspace
del
Grant permissions to the workspace for users or teams
post
List grants for a workspace
get
Delete a workspace grant
del
List workspaces (Paginated)
get
api-connectors
List API connectors
get
Create an API connector
post
Get an API connector
get
Update an API connector
patch
Delete an API connector
del
api-credentials
List API credentials
get
Create an API credential
post
Get an API credential
get
Update an API credential
patch
Delete an API credential
del
reports
List reports
get
Create a report
post
Get a report
get
Duplicate a report
post
Export data from a report
post
List scheduled report exports
get
Add report schedule
post
Update a report schedule
patch
Delete a scheduled export for a report
del
Export a report
post
List report sources
get
Card issuing - Disputes
Disputes
Create dispute
post
Platform setup - Holidays
Holidays
Create holiday
post
List holidays
get
Get holiday
post
Update holiday name
put
Delete holiday
del
Check if business day
post
List non-business days
get
List holidays with administrative division ancestors
get
Holidays v2 - Transaction banking
Create holiday
post
List holidays
get
Update holiday
put
Holiday calendar
Create holiday calendar
post
Update holiday calendar
patch
Delete holiday calendar
del
Add holiday
post
Update holiday
patch
Delete holiday
del
Validate holiday
post
Holiday calendar data
Get holiday calendar
get
Get calendar by external ID
get
List calendar holidays
get
List ancestors
get
List ancestors by external ID
get
Get child group holiday tree
get
Get holiday calendar tree
get
Get calendar business day info
post
Get calendar non-business days
get
Batch search calendar business days
post
Payment Hub Api 2.0
Transfers
List Transfers
post
Public Api v3
Contact
List all contacts
get
Create a contact
post
Get a contact
get
Delete a contact
del
Signature Request
Initiate a new signature request
post
List signature requests
get
Fetch a signature request
get
Update a Signature Request
patch
Delete a signature request
del
Activate a signature request
post
Cancel a signature request
post
Send manual reminder to signer
post
Reactivate an expired signature request
post
Download signature request audit trails
get
Signer
Create a new signer
post
List signature request signers
get
Get a signer
get
Delete a signer
del
Update a signer
patch
Download audit trail PDF
get
Get signer audit trail
get
Document
Add document to a signature request
post
List signature request documents
get
Get a document
get
Delete a document
del
Update a document
patch
Replace a document
post
Download signature request documents
get
Upload a document
post
User
List all users
get
Webhook
Configure a new webhook
post
List webhooks
get
Get a webhook
get
Unsubscribe a webhook
del
Update a webhook
patch
Consumption
Get consumptions
get
Export consumption data
get
Follower
Create new followers
post
Approver
Create a new approver
post
Core platform - Accounting
Accounting event types
List accounting event types
get
Get accounting event type
get
Accounting entry types
Create accounting entry types
post
List accounting entry types
get
Get accounting entry type
get
Update accounting entry type
patch
Delete accounting entry type
del
List accounting entry types (outdated)
get
Get accounting entry type (outdated)
get
Accounting accounts
Create accounting account
post
List accounting accounts
get
Get accounting account
get
Update accounting account
patch
Delete accounting account
del
Accounting scripts V2
Create accounting script V2
post
List accounting scripts V2
get
Get accounting script V2
get
Accounting scripts V1
Create accounting script V1
post
List accounting scripts V1
get
Update accounting scripts V1
patch
Get accounting script V1
get
Update accounting script V1
patch
Deactivate accounting script V1
del
Accounting entry
Create accounting entry
post
Buckets
Get account buckets (updated)
get
GAR Partner API Documentation
Amenities Download
All amenities
get
Single amenity
get
Itinerary (Book & Post-book)
Book
post
Lookup
get
Cancel
put
Primary API
/users
Create a user
post
Secondary API
/users
Create a user
post
MISSION CONTROL
Connection Endpoints
(Beta) Get all connection endpoints
get
(Beta) Create a connection endpoint
post
(Beta) Get a connection endpoint
get
(Beta) Delete a connection endpoint
del
(Beta) Update a connection endpoint
patch
Broker Configuration Using SEMP Proxy
(Beta) Get a specific resource object for an event broker service by the object path using a SEMP GET
get
(Beta) Replace a resource object on an event broker service using a SEMP PUT
put
(Beta) Create a resource object for an event broker service using a SEMP POST
post
(Beta) Delete a resource object on an event broker service by object path using a SEMP DELETE
del
(Beta) Update a resource object on an event broker service using a SEMP PATCH
patch
Client Profiles
Get a list of client profiles
get
Create a client profile
post
Get a specific client profile for event broker service by name
get
Replace a client profile
put
Delete a client profile
del
Update a client profile
patch
Connection Endpoint DNS Names
(Beta) Get all connection endpoint DNS names for the event broker service
get
(Beta) Create a DNS name for an event broker service's connection endpoint
post
(Beta) Delete a connection endpoint DNS name from an event broker service
del
(Beta) Initiate the move of a DNS name from one connection endpoint to another
post
Customer-Controlled Clusters
(Beta) Create a Customer-Controlled Cluster
post
(Beta) Get a Customer-Controlled Cluster
get
(Beta) Delete a Customer-Controlled Cluster
del
(Beta) Update a Customer-Controlled Cluster
patch
(Beta) Get the health of a Customer-Controlled Cluster
get
(Beta) Get a Customer-Controlled Cluster's helm values
get
Environments
(Beta) Get details of an environment in Mission Control
get
(Beta) Update details for an environment in Mission Control
patch
Event Broker Services
Get a list of datacenters
get
Get a specific datacenter by identifier
get
Update a datacenter's environment
patch
Get a list of available software event broker versions by datacenter
get
(Beta) Get event broker versions
get
Get a list of software event broker versions available for creating event broker services
get
Get a list of event broker services
get
Create an event broker service
post
Get a specific event broker service by identifier
get
Delete an event broker service
del
Update an event broker service
patch
Create a clone of an existing event broker service
post
(Beta) Get the availability state of an event broker service
get
Update the event broker service message spool size
patch
(Beta) Get the status of all operations on an event broker service
get
Get the status of a service operation
get
(Beta) Update whether an event broker service allows basic authentication for management access
put
(Beta) Initiate an event broke service switchover
post
(Beta) Get the organization message spool expansion information
get
Get a list of service classes
get
Get a specific service class by identifier
get
Event Broker Upgrade Readiness
Get the upgrade readiness for an event broker service
get
Event Broker Upgrades
Get a list of event broker service upgrades
get
Create an event broker service upgrade
post
Get an event broker service upgrade
get
Maintenance Activities
Get a list of maintenance activities
get
Get a specific maintenance activity
get
Cancel a specific scheduled maintenance activity
post
Initiate a post-maintenance validation for a maintenance activity
post
Initiate a pre-maintenance validation for a maintenance activity
post
Create a reschedule request for a specific maintenance event
post
Maintenance Schedules
Get a list of maintenance schedules
get
Create a maintenance schedule
post
Get a maintenance schedule
get
Delete a maintenance schedule
del
Maintenance Windows
Get maintenance windows
get
Create a maintenance window
post
Get a specific maintenance window
get
Update a maintenance window
put
Delete a maintenance window
del
Recommended Event Broker Versions
Get a list of recommended software event broker versions for a service upgrade
get
Replication
(Beta) Get the status of a multi-resource operation
get
(Beta) Initiate authentication for replication config-sync connections using a pre-shared key
post
Server Certificates
(Beta) Get all server certificates
get
(Beta) Initiate an upload of a server certificate
post
(Beta) Get a server certificate by its ID
get
(Beta) Delete a server certificate by its ID
del
(Beta) Initiate installation of a server certificate by its ID
post
BeyondTrust Password Safe API
Access Levels
Get all access levels
get
Create access level assignment
post
Access Policies
Get all access policies
get
Test access to managed account
post
Get assignees for access policy
get
Address Groups
Get address groups for organization ID
get
Get address groups
get
Create address group
post
Get address group by ID
get
Update address group
put
Delete address group
del
Get address by ID
get
Update address
put
Delete address by ID
del
Get all addresses in address group
get
Create address within address group
post
Delete address by group ID
del
Aliases
Get requestable managed account aliases
get
Get a requestable managed account alias
get
API Registration
Get API registration by ID
get
Update API registration
put
Delete API registration
del
Get all API registrations
get
Create API registration
post
Rotate API key by ID
post
Get API key by ID
get
Applications
Get all applications
get
Get application by ID
get
Get applications by managed account ID
get
Remove all applications from managed account
del
Assign application to managed account
post
Remove application from managed account
del
Assets
Search assets
post
Get all assets by workgroup ID
get
Create asset workgroup by ID
post
Get all assets by workgroup name
get
Create asset workgroup by name
post
Delete by workgroup and asset name
del
Get all assets by Smart Rule ID
get
Get by ID
get
Update asset
put
Delete by ID
del
Attribute Types
Get all attribute types
get
Create attribute type
post
Get attribute type by ID
get
Delete attribute type
del
Attributes
Get attributes by type
get
Create attribute
post
Get attribute by ID
get
Delete attribute
del
Get all attributes for asset
get
Delete all attributes for asset
del
Assign attribute to asset
post
Delete attribute from asset
del
Get attributes for managed account
get
Delete all attributes from managed account
del
Assign attribute to managed account
post
Delete attribute from managed account
del
Get attributes for managed system
get
Delete all attributes from managed system
del
Assign attribute to managed system
post
Delete attribute from managed system
del
Auth
Sign in
post
Sign out
post
Configuration
Get current system version
get
Credentials
Get credentials by Request ID
get
Get Credentials by Alias and Request ID
get
Update managed account credentials by ID
put
Get credentials by Managed Account ID
get
Update managed account credentials by Workgroup Name, Asset Name, and Account Name
put
Test managed account credentials
post
Change managed account credentials
post
Update all managed account credentials by Managed System ID
post
Custom Platforms
Get all custom platform configurations
get
Get custom platform configuration by ID
get
Import custom platform configuration
post
Export custom platform configuration
get
Databases
Get all databases
get
Get database by ID
get
Delete database by ID
del
Update database by ID
put
Get all databases by asset ID
get
Create database for asset
post
Directories
Get all directories
get
Get directory by ID
get
Update directory by ID
put
Delete directory by ID
del
Create directory in workgroup
post
DSS Key Rules
Get all DSS key rules
get
Get DSS key rule by ID
get
Entitlements
Get user entitlements
get
Entity Types
Get all entity types
get
Epm Policy
Add Application to EPM policy group
post
Functional Accounts
Get all functional accounts
get
Create functional account
post
Get functional account by ID
get
Delete functional account
del
ISA Requests
Create ISA request
post
ISA Sessions
Create ISA session
post
Keystrokes
Get all keystrokes for session
get
Get keystroke by ID
get
Searches keystroke records by condition and type (deprecated endpoint).
get
Search keystrokes
post
Linked Accounts
Get Linked Accounts by Managed System
get
Remove all Linked Accounts by Managed System
del
Create Linked Account
post
Remove Linked Account
del
Managed Accounts
Get Requestable Managed Account(s)
get
Get Managed Account
get
Update Managed Account
put
Delete Managed Account
del
Get Managed Account(s) by Managed System
get
Create Managed Account in Managed System
post
Delete all Managed Accounts by Managed System
del
Delete Managed Account by Managed System ID and Managed Account name
del
Get Managed Accounts by Smart Rule
get
Get Managed Accounts by Quick Rule
get
Update Quick Rule Managed Accounts
put
Add Managed Account to Quick Rule
post
Remove Managed Account from Quick Rule
del
Managed Systems
Get Managed Systems
get
Get Managed System
get
Update Managed System
put
Delete Managed System
del
Get Managed System by Asset
get
Create Asset-based Managed System
post
Get Managed System by Database
get
Get Managed System by Directory
get
Get Managed Systems by Functional Account
get
Get Managed Systems by Workgroup
get
Create Database-based Managed System
post
Get Managed System by Directory
post
Create Managed System in Workgroup
post
Get Managed Systems by Smart Rule
get
Get Managed Systems by Quick Rule
get
Update Quick Rule Managed Systems
put
Add Managed System to Quick Rule
post
Remove Managed System from Quick Rule
del
Nodes
Get all Nodes
get
Operating Systems
Get all operating systems
get
Oracle Internet Directories
Get all Oracle Internet Directories
get
Get Oracle Internet Directories by organization
get
Get an Oracle Internet Directory by ID
get
Test Oracle Internet Directory LDAP connection
post
Query Oracle Internet Directory DB services
post
Organizations
Get organizations
get
Get organization by ID
get
Password Rules
Get all password rules by product
get
Get password rule by ID
get
Password Safe OAuth Proxy
Authenticate
post
Permissions
Get all permissions
get
Assign permissions to user group
post
Get all permissions for user group
get
Delete all permissions for user group
del
Platforms
Get all platforms
get
Get platform by ID
get
Get platforms by entity type ID
get
Propagation Action Types
Get all propagation action types
get
Propagation Actions
Get all propagation actions
get
Get propagation action by ID
get
Get managed account propagation actions
get
Unassign propagation actions from managed account
del
Assign propagation actions to managed account
post
Unassign propagation action from managed account
del
Quick Rules
Get all Quick Rules
get
Create Quick Rule
post
Delete Quick Rule by title
del
Get Quick Rule by ID
get
Delete Quick Rule by ID
del
Get Quick Rule by organization and title
get
Delete Quick Rule by organization and title
del
Replay
Creates a new replay session for a specified session token. The session token can be discovered using the `sessions` endpoints.
post
Displays the replay session details.
get
Controls the replay session status.
put
Terminates the replay session.
del
Request Sets
Create release request set
post
Get request sets
get
Requests
Create release request
post
Get release requests
get
Create release request using an alias
post
Check-in/release request
put
Update request to rotate credentials on check-in/expiry
put
Approve pending request
put
Deny/cancel pending request
put
Terminate requests by managed account ID
post
Terminate requests by managed system ID
post
Terminate requests by requestor user ID
post
Roles
Get all roles
get
Get roles assigned to user group and smart rule
get
Assign role to user group and smart rule
post
Remove role from user group and smart rule
del
Secrets Safe Folders
Get all folders
get
Create folder
post
Get folder by ID
get
Update folder
put
Delete folder by ID
del
Move folder
put
Secrets Safe Safes
Create safe
post
Get all safes accessible to current user
get
Get safe by ID
get
Update safe by ID
put
Delete safe by ID
del
Get all possible safe permissions
get
Get permissions assigned to safe
get
Update safe permissions by ID
put
Revoke safe permissions by ID
del
Secrets Safe Secrets
Create credential secret
post
Get all secrets by folder ID
get
Create file secret
post
Create text secret
post
Get credential secret by ID
get
Update credential secret
put
Delete secret
del
Get text secret by ID
get
Update text secret
put
Get file secret by ID
get
Update file secret
put
Get secret file content by ID
get
Get all secrets
get
Upload secrets to folder by ID
post
Share secret to folder by ID
post
Delete share
del
Get all shares of secret
get
Delete all shares of secret
del
Get secret version history
get
Get historical password value for a specific version
get
Get historical text value for a specific version
get
Get historical file content for a specific version
get
Rollback secret to a previous version
post
Move secrets and shares to folder
put
Sessions
Get Sessions
get
Get Session
get
Create Session by Request
post
Create Admin Session
post
Lock active Session
post
Lock active Sessions by Managed Account
post
Lock active Sessions by Managed System
post
Terminate active Session
post
Terminate active Sessions by Managed Account
post
Terminate active Sessions by Managed System
post
Smart Rules
Get Smart Rules
get
Delete Smart Rule by title
del
Get Smart Rule by ID
get
Delete Smart Rule by ID
del
Get Smart Rule by organization ID and title
get
Delete Smart Rule by organization ID and title
del
Get all Smart Rules for user group and access level
get
Process Smart Rule
post
Create asset filtering Smart Rule
post
Create Managed Account Smart Rule from Assigned Attributes and an optional Smart Group
post
Subscription Delivery
Get subscription delivery identifiers
get
Download subscription delivery
post
Synced Accounts
Get Synced Accounts by Managed Account
get
Remove all Synced Accounts by Managed Account
del
Create Synced Account
post
Remove Synced Account
del
Ticket Systems
Get all configured ticket systems
get
User Audits
Get user audits
get
Get user audit by ID
get
User Groups
Get user groups
get
Create new user group
post
Delete user group by name
del
Get user group
get
Delete user group by ID
del
Get user groups for user
get
Add user to user group
post
Remove user from user group
del
Users
Get User
get
Update user
put
Delete user
del
Get users
get
Create user account
post
Get all users in group.
get
Create user in group
post
Quarantine user
post
Generate OAuth client secret for user
post
Workgroups
Get workgroups by name
get
Create workgroup
post
Get workgroup by ID
get
Invoices API V2
Invoices
Create Buyer Invoice Lines
post
Update Buyer Invoice Lines
patch
Update Buyer Invoice Header
patch
Onboarding
New Hires
Search Canceled New Hires
get
Search Completed New Hires
get
Search In-Progress New Hires
get
Create a New Hire
post
Get a New Hire
get
Delete a New Hire
del
Updates Platform Configuration Fields on a New Hire
patch
Settlements Webhooks
Settlements
Settlement Created
post
Powered by
New Page
Updated 6 months ago
Summary content
accountTypes
Did this page help you?
Yes
No
Updated 6 months ago
Summary content
accountTypes
Did this page help you?
Yes
No
