Deprecated
The content in this section of the guide has been deprecated and is compatible with earlier versions only.
Quick Navigation
- [deprecated] GET Aliases/{name}
- [deprecated] GET Keystrokes/search/{condition}
- [deprecated] GET Keystrokes/search/{condition}/{type:int}
- PUT Workgroups/{workgroupName}/Assets/{assetName}/ManagedSystems/ManagedAccounts/{accountName}/Credentials
Aliases
[deprecated] GET Aliases/{name}
This API has been deprecated and is available for backwards compatibility only. Use GET Aliases?name={name} instead.
Purpose
Returns a requestable managed account alias by name.
Required Roles
Requestor or Requestor/Approver role for the preferred managed account referenced by the alias.
URL Parameters
name: Name of the managed account alias.
Request Body
None.
Response Body
Content-Type: application/json
{ AliasId: int, AliasName: string, SystemId: int, SystemName: string, AccountId: int, AccountName: string, DomainName: string, InstanceName: string, DefaultReleaseDuration: int, MaximumReleaseDuration: int, LastChangeDate: datetime, NextChangeDate: datetime, IsChanging: bool, ChangeState: int, MappedAccounts : [ { AliasID: int, ManagedSystemID: int, ManagedAccountID: int, Status: string }, … ] }
Response Codes
200 - Request successful. Alias in response body.
For more information, please see Common Response Codes.
Keystrokes
[deprecated] GET Keystrokes/search/{condition}
This API has been deprecated and is available for backwards compatibility only. Use POST Keystrokes/Search instead.
Purpose
Search for keystrokes by condition/keyword.
Required Roles
Password Safe Auditor Role, ISA Role, or a member of BeyondInsight Administrators group.
URL Parameters
condition: Keyword to search for.
Response Body
Content-Type: application/json
[ { KeystrokeID: long, SessionID: int, TimeMarker: long, Type: byte, Data: string }, … ]
Response Codes
200 - Request successful. Keystrokes are in response body.
For more information, please see Common Response Codes.
[deprecated] GET Keystrokes/search/{condition}/{type:int}
This API has been deprecated and is available for backwards compatibility only. Use POST Keystrokes/Search instead.
Purpose
Search for keystrokes by condition/keyword and type.
Required Roles
Password Safe Auditor Role, ISA Role, or a member of BeyondInsight Administrators group.
URL Parameters
- condition: Keyword to search for.
- type: Type of keystrokes:
- 0: All
- 1: StdIn
- 2: StdOut
- 4: Window Event
- 5: User Event
Response Body
Content-Type: application/json
[ { KeystrokeID: long, SessionID: int, TimeMarker: long, Type: byte, Data: string }, … ]
Response Codes
200 - Request successful. Keystrokes are in response body.
For more information, please see Common Response Codes.
Managed Account Credentials
PUT Workgroups/{workgroupName}/Assets/{assetName}/ManagedSystems/ManagedAccounts/{accountName}/Credentials
This API has been deprecated and is available for backwards compatibility only. Use PUT Credentials?workgroupName={workgroupName}&assetName={assetName}&accountName={accountName} instead.
Purpose
Updates the credentials for a managed account by Workgroup name, asset name, and managed account name, optionally applying the change to the managed system.
Required Permissions
One of the following is required:
- Password Safe Account Management (Read/Write)
- ISA Role or Credentials Manager Role on a Smart Rule referencing the account
URL Parameters
- workgroupName: Name of the Workgroup.
- assetName: Name of the asset.
- accountName: Name of the managed account for which to set the credentials.
Request Body
Content-Type: application/json
{ Password: string, PublicKey: string, PrivateKey: string, Passphrase: string, UpdateSystem: bool }
Request Body Details
- Password: (optional) The new password to set. If not given, generates a new random password.
- PublicKey: (required if PrivateKey is given and updateSystem=true) The new public key to set on the host.
- PrivateKey: The private key to set (provide passphrase if encrypted).
- Passphrase: (optional) The passphrase to use for an encrypted private key.
- UpdateSystem: (default: true) Whether to update the credentials on the referenced system.
Response Body
None.
Response Codes
204 - Request Successful. No Response Body.
For more information, please see Common Response Codes.