Deprecated

The content in this section of the guide has been deprecated and is compatible with earlier versions only.

Quick Navigation

Aliases

[deprecated] GET Aliases/{name}

This API has been deprecated and is available for backwards compatibility only. Use GET Aliases?name={name} instead.

Returns a requestable Managed Account Alias by name.

Requestor or Requestor/Approver role for the preferred Managed Account referenced by the Alias.

name: Name of the Managed Account Alias

None

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
        },
        …
    ]
}

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.

Search for Keystrokes by condition/keyword.

Password Safe Auditor Role, ISA Role, or a member of BeyondInsight Administrators group.

condition: Keyword to search for.

Content-Type: application/json

[
    {
        KeystrokeID: long, 
        SessionID: int, 
        TimeMarker: long, 
        Type: byte,
        Data: string
    },
    …
]

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.

Search for Keystrokes by condition/keyword and type.

Password Safe Auditor Role, ISA Role, or a member of BeyondInsight Administrators group.

  • condition: Keyword to search for.
  • type: Type of keystrokes: 0 - All, 1 - StdIn, 2 - StdOut, 4 - Window Event, 5 - User Event.

Content-Type: application/json

[
    {
        KeystrokeID: long, 
        SessionID: int, 
        TimeMarker: long, 
        Type: byte,
        Data: string
    },
    …
]

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.

  • Password Safe Account Management (Read/Write) or
  • ISA Role or Credentials Manager Role on a Smart Rule referencing the account.
  • workgroupName: Name of the Workgroup.
  • assetName: Name of the Asset.
  • accountName: Name of the Managed Account for which to set the credentials.

Content-Type: application/json

{
    Password: string,
    PublicKey: string,
    PrivateKey: string,
    Passphrase: string,
    UpdateSystem: bool
}
  • 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

None

204 - Request Successful. No Response Body.

For more information, please see Common Response Codes.