Managed Account Credentials

Quick Navigation

PUT ManagedAccounts/{managedAccountID}/Credentials

Purpose

Updates the credentials for a Managed Account, optionally applying the change to the Managed System.

Required Permissions

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

URL Parameters

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

For more information, please see Common Response Codes.

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

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

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

Query 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.

POST ManagedAccounts/{managedAccountID}/Credentials/Test

Purpose

Tests the current credentials of a Managed Account.

Required Permissions

Password Safe Account Management (Read/Write)

URL Parameters

managedAccountID: ID of the Managed Account.

Request Body

None

Response Body

Content-Type: application/json

{
    Success : bool
}

Response Body Details

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

Response Codes

200 - Request Successful.

For more information, please see Common Response Codes.

POST ManagedAccounts/{managedAccountID}/Credentials/Change

Purpose

Changes the current Credentials of a Managed Account.

Required Permissions

Password Safe Account Management (Read/Write)

URL Parameters

managedAccountID: ID of the Managed Account.

Request Body (optional)

Content-Type: application/json

{
    Queue : bool
}

Request Body Details

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

Response Body

None

Response Codes

204 - Request successful. No content in body.

For more information, please see Common Response Codes.

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

Purpose

Queues Credentials' changes for all active Managed Accounts for a Managed System.

Required Permissions

Password Safe API Global Quarantine (Read/Write)

URL Parameters

systemId: ID of the Managed System.

Request Body

None

Response Body

None

Response Codes

204 - Request successful. No content in body.

For more information, please see Common Response Codes.