Managed Account Credentials

Quick Navigation

PUT ManagedAccounts/{managedAccountID}/Credentials

Updates the credentials for a managed account, optionally applying the change to the managed system.

Requires one of the following:

  • Password Safe Account Management (Read/Write).
  • ISA Role or Credentials Manager Role on a Smart Rule referencing the account.

managedAccountID: ID 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 content in body.

For more information, please see Common Response Codes.

PUT Credentials?workgroupName={workgroupName}&assetName={assetName}&accountName={accountName}

Updates the credentials for a managed account by Workgroup name, asset name, and managed account name, optionally applying the change to the managed system.

Requires one of the following:

  • Password Safe Account Management (Read/Write).
  • 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.

POST ManagedAccounts/{managedAccountID}/Credentials/Test

Tests the current credentials of a managed account.

Password Safe Account Management (Read/Write).

managedAccountID: ID of the managed account.

None.

Content-Type: application/json

{
    Success : bool
}

Success: True if the credential test succeeded, otherwise false.

200 - Request Successful.

For more information, please see Common Response Codes.

POST ManagedAccounts/{managedAccountID}/Credentials/Change

Changes the current credentials of a managed account.

Password Safe Account Management (Read/Write).

managedAccountID: ID of the managed account.

Content-Type: application/json

{
    Queue : bool
}

Queue: (default: false) True to queue the change for background processing, otherwise false. When Queue is false the credentials change is immediate.

None.

204 - Request successful. No content in body.

For more information, please see Common Response Codes.

POST ManagedSystems/{systemId}/ManagedAccounts/Credentials/Change

Queues credentials' changes for all active managed accounts for a managed system.

Password Safe API Global Quarantine (Read/Write).

systemId: ID of the managed system.

None.

None.

204 - Request successful. No content in body.

For more information, please see Common Response Codes.