• Secrets Manager

managed accounts

get/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts

Get all managed accounts in a target domain

sortkeystring
sortdirstring
Enum
  • asc
  • desc
limitint
offsetint

Responses

Response examples

Success

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "username": "string",
      "email": "string",
      "full_name": "string",
      "sam_account_name": "string",
      "source_id": "string",
      "security_id": "string",
      "additional_data": {},
      "target_domain": {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string",
        "deleted": true
      },
      "password_policy": {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string"
      },
      "enabled": true,
      "rotation_enabled": true,
      "explicit_checkout": true,
      "state": "MANAGED",
      "comment": "string",
      "locked": true,
      "locked_timestamp": "2023-06-07T17:32:28Z",
      "rotation_history": [
        {
          "version": 123,
          "rotated": "2023-06-07T17:32:28Z",
          "trigger": "ONRELEASE",
          "status": "SUCCESS"
        }
      ],
      "checkouts": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "type": "TARGET_DOMAIN_SECRET",
          "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "expires": "2023-06-07T17:32:28Z",
          "created": "2023-06-07T17:32:28Z",
          "explicit_checkout": true,
          "secrets": [
            {
              "version": 123,
              "secret": "string",
              "created": "2023-06-07T17:32:28Z"
            }
          ],
          "username": "string",
          "email": "string",
          "full_name": "string",
          "target_domain_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "managed_account_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "secret_name": "string",
          "meta": {}
        }
      ],
      "created": "2023-06-07T17:32:28Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated_by": "2023-06-07T17:32:28Z",
      "disable_rdp_cert_auth": true
    }
  ]
}
post/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts

Create a managed account

idstring
Format
uuid
usernamestring

Username must be unique with a target domain

emailstring
full_namestring
sam_account_namestring
source_idstring
security_idstring
additional_dataobject
target_domainobject (targetdomain_handle)
idstring
Format
uuid
namestring
deletedboolean
password_policyobject (policy_handle)
idstring
Format
uuid
namestring
enabledboolean

Managed account enabled/disabled in PrivX

rotation_enabledboolean

Password rotation enabled/disabled

explicit_checkoutboolean

Explicit checkout of account password allowed/disallowed

statestring
Enum
  • MANAGED
  • UNMANAGED
  • NEW
  • REMOVED
commentstring
lockedboolean

Account locked in PrivX for ongoing password rotation

locked_timestampstring
Format
date-time
rotation_historyarray
versionint
rotatedstring
Format
date-time
triggerstring
Enum
  • ONRELEASE
  • ONEXPIRY
  • PERIODIC
  • MANUAL
statusstring
Enum
  • SUCCESS
  • ERROR
  • MAX_ROTATION_RETRIES_ERROR
checkoutsarray
idstring
Format
uuid
typestring
Enum
  • TARGET_DOMAIN_SECRET
  • HOST_SECRET
user_idstring
Format
uuid
expiresstring
Format
date-time
createdstring
Format
date-time
explicit_checkoutboolean
secretsarray
usernamestring
emailstring
full_namestring
target_domain_idstring
Format
uuid
managed_account_idstring
Format
uuid
host_idstring
Format
uuid
secret_namestring
metaobject
createdstring
Format
date-time
authorstring
Format
uuid
updatedstring
Format
uuid
updated_bystring
Format
date-time
disable_rdp_cert_authboolean

disable RDP cert authorization for this user

passwordstring

Initial password stored to PrivX vault

rotateboolean

Trigger initial password rotation after create

Responses

Request examples

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "username": "string",
  "email": "string",
  "full_name": "string",
  "sam_account_name": "string",
  "source_id": "string",
  "security_id": "string",
  "additional_data": {},
  "target_domain": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string",
    "deleted": true
  },
  "password_policy": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string"
  },
  "enabled": true,
  "rotation_enabled": true,
  "explicit_checkout": true,
  "state": "MANAGED",
  "comment": "string",
  "locked": true,
  "locked_timestamp": "2023-06-07T17:32:28Z",
  "rotation_history": [
    {
      "version": 123,
      "rotated": "2023-06-07T17:32:28Z",
      "trigger": "ONRELEASE",
      "status": "SUCCESS"
    }
  ],
  "checkouts": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "type": "TARGET_DOMAIN_SECRET",
      "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "expires": "2023-06-07T17:32:28Z",
      "created": "2023-06-07T17:32:28Z",
      "explicit_checkout": true,
      "secrets": [
        {
          "version": 123,
          "secret": "string",
          "created": "2023-06-07T17:32:28Z"
        }
      ],
      "username": "string",
      "email": "string",
      "full_name": "string",
      "target_domain_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "managed_account_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "secret_name": "string",
      "meta": {}
    }
  ],
  "created": "2023-06-07T17:32:28Z",
  "author": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated_by": "2023-06-07T17:32:28Z",
  "disable_rdp_cert_auth": true,
  "password": "string",
  "rotate": true
}

Response examples

Managed account was successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}
post/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/search

Search managed accounts in a target domain

keywordsstring

Space or comma separated list of search keywords

enabledboolean
created_afterstring
Format
date-time
created_beforestring
Format
date-time
updated_afterstring
Format
date-time
updated_beforestring
Format
date-time
statestring
Enum
  • MANAGED
  • UNMANAGED
  • NEW
  • REMOVED
rotation_enabledboolean
explicit_checkoutboolean

Responses

Request examples

{
  "keywords": "string",
  "enabled": true,
  "created_after": "2023-06-07T17:32:28Z",
  "created_before": "2023-06-07T17:32:28Z",
  "updated_after": "2023-06-07T17:32:28Z",
  "updated_before": "2023-06-07T17:32:28Z",
  "state": "MANAGED",
  "rotation_enabled": true,
  "explicit_checkout": true
}

Response examples

Success

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "username": "string",
      "email": "string",
      "full_name": "string",
      "sam_account_name": "string",
      "source_id": "string",
      "security_id": "string",
      "additional_data": {},
      "target_domain": {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string",
        "deleted": true
      },
      "password_policy": {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string"
      },
      "enabled": true,
      "rotation_enabled": true,
      "explicit_checkout": true,
      "state": "MANAGED",
      "comment": "string",
      "locked": true,
      "locked_timestamp": "2023-06-07T17:32:28Z",
      "rotation_history": [
        {
          "version": 123,
          "rotated": "2023-06-07T17:32:28Z",
          "trigger": "ONRELEASE",
          "status": "SUCCESS"
        }
      ],
      "checkouts": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "type": "TARGET_DOMAIN_SECRET",
          "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "expires": "2023-06-07T17:32:28Z",
          "created": "2023-06-07T17:32:28Z",
          "explicit_checkout": true,
          "secrets": [
            {
              "version": 123,
              "secret": "string",
              "created": "2023-06-07T17:32:28Z"
            }
          ],
          "username": "string",
          "email": "string",
          "full_name": "string",
          "target_domain_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "managed_account_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "secret_name": "string",
          "meta": {}
        }
      ],
      "created": "2023-06-07T17:32:28Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated_by": "2023-06-07T17:32:28Z",
      "disable_rdp_cert_auth": true
    }
  ]
}
get/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/{managedAccountID}

Get managed account

targetDomainIDstring

required

Format
uuid
managedAccountIDstring

required

Format
uuid

Responses

Response examples

Success

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "username": "string",
  "email": "string",
  "full_name": "string",
  "sam_account_name": "string",
  "source_id": "string",
  "security_id": "string",
  "additional_data": {},
  "target_domain": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string",
    "deleted": true
  },
  "password_policy": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string"
  },
  "enabled": true,
  "rotation_enabled": true,
  "explicit_checkout": true,
  "state": "MANAGED",
  "comment": "string",
  "locked": true,
  "locked_timestamp": "2023-06-07T17:32:28Z",
  "rotation_history": [
    {
      "version": 123,
      "rotated": "2023-06-07T17:32:28Z",
      "trigger": "ONRELEASE",
      "status": "SUCCESS"
    }
  ],
  "checkouts": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "type": "TARGET_DOMAIN_SECRET",
      "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "expires": "2023-06-07T17:32:28Z",
      "created": "2023-06-07T17:32:28Z",
      "explicit_checkout": true,
      "secrets": [
        {
          "version": 123,
          "secret": "string",
          "created": "2023-06-07T17:32:28Z"
        }
      ],
      "username": "string",
      "email": "string",
      "full_name": "string",
      "target_domain_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "managed_account_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "secret_name": "string",
      "meta": {}
    }
  ],
  "created": "2023-06-07T17:32:28Z",
  "author": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated_by": "2023-06-07T17:32:28Z",
  "disable_rdp_cert_auth": true
}
put/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/{managedAccountID}

Modify a managed account

idstring
Format
uuid
usernamestring

Username must be unique with a target domain

emailstring
full_namestring
sam_account_namestring
source_idstring
security_idstring
additional_dataobject
target_domainobject (targetdomain_handle)
idstring
Format
uuid
namestring
deletedboolean
password_policyobject (policy_handle)
idstring
Format
uuid
namestring
enabledboolean

Managed account enabled/disabled in PrivX

rotation_enabledboolean

Password rotation enabled/disabled

explicit_checkoutboolean

Explicit checkout of account password allowed/disallowed

statestring
Enum
  • MANAGED
  • UNMANAGED
  • NEW
  • REMOVED
commentstring
lockedboolean

Account locked in PrivX for ongoing password rotation

locked_timestampstring
Format
date-time
rotation_historyarray
versionint
rotatedstring
Format
date-time
triggerstring
Enum
  • ONRELEASE
  • ONEXPIRY
  • PERIODIC
  • MANUAL
statusstring
Enum
  • SUCCESS
  • ERROR
  • MAX_ROTATION_RETRIES_ERROR
checkoutsarray
idstring
Format
uuid
typestring
Enum
  • TARGET_DOMAIN_SECRET
  • HOST_SECRET
user_idstring
Format
uuid
expiresstring
Format
date-time
createdstring
Format
date-time
explicit_checkoutboolean
secretsarray
usernamestring
emailstring
full_namestring
target_domain_idstring
Format
uuid
managed_account_idstring
Format
uuid
host_idstring
Format
uuid
secret_namestring
metaobject
createdstring
Format
date-time
authorstring
Format
uuid
updatedstring
Format
uuid
updated_bystring
Format
date-time
disable_rdp_cert_authboolean

disable RDP cert authorization for this user

Responses

Request examples

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "username": "string",
  "email": "string",
  "full_name": "string",
  "sam_account_name": "string",
  "source_id": "string",
  "security_id": "string",
  "additional_data": {},
  "target_domain": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string",
    "deleted": true
  },
  "password_policy": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string"
  },
  "enabled": true,
  "rotation_enabled": true,
  "explicit_checkout": true,
  "state": "MANAGED",
  "comment": "string",
  "locked": true,
  "locked_timestamp": "2023-06-07T17:32:28Z",
  "rotation_history": [
    {
      "version": 123,
      "rotated": "2023-06-07T17:32:28Z",
      "trigger": "ONRELEASE",
      "status": "SUCCESS"
    }
  ],
  "checkouts": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "type": "TARGET_DOMAIN_SECRET",
      "user_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "expires": "2023-06-07T17:32:28Z",
      "created": "2023-06-07T17:32:28Z",
      "explicit_checkout": true,
      "secrets": [
        {
          "version": 123,
          "secret": "string",
          "created": "2023-06-07T17:32:28Z"
        }
      ],
      "username": "string",
      "email": "string",
      "full_name": "string",
      "target_domain_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "managed_account_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "secret_name": "string",
      "meta": {}
    }
  ],
  "created": "2023-06-07T17:32:28Z",
  "author": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated_by": "2023-06-07T17:32:28Z",
  "disable_rdp_cert_auth": true
}

Response examples

Managed account was successfully modified

Empty response

delete/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/{managedAccountID}

Delete a managed account

targetDomainIDstring

required

Format
uuid
managedAccountIDstring

required

Format
uuid

Responses

Response examples

Managed account was successfully deleted

Empty response

post/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/{managedAccountID}/rotate

Trigger managed account password rotation

targetDomainIDstring

required

Format
uuid
managedAccountIDstring

required

Format
uuid

Responses

Response examples

Managed account password rotation was successfully triggered

Empty response

post/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/{managedAccountID}/password

Provide password for managed account

passwordstring

Responses

Request examples

{
  "password": "string"
}

Response examples

Password was stored as new managed account secret version

{
  "version": 123,
  "created": "2023-06-07T17:32:28Z"
}
post/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/batch/create

Create a batch of managed accounts

idsarray
dataobject
enabledboolean
rotation_enabledboolean
rotateboolean

Trigger initial password rotation after create

explicit_checkoutboolean
password_policyobject (policy_handle)
commentstring
disable_rdp_cert_authboolean

disable RDP cert auth for the users

Responses

Request examples

{
  "ids": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ],
  "data": {
    "enabled": true,
    "rotation_enabled": true,
    "rotate": true,
    "explicit_checkout": true,
    "password_policy": {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string"
    },
    "comment": "string",
    "disable_rdp_cert_auth": true
  }
}

Response examples

Managed account batch was successfully created

{
  "ids": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ]
}
post/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/batch/edit

Modify a batch of managed accounts

idsarray
changesobject
enabledboolean
rotation_enabledboolean
explicit_checkoutboolean
password_policyobject (policy_handle)
commentstring
disable_rdp_cert_authboolean

disable RDP cert auth for the users

Responses

Request examples

{
  "ids": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ],
  "changes": {
    "enabled": true,
    "rotation_enabled": true,
    "explicit_checkout": true,
    "password_policy": {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string"
    },
    "comment": "string",
    "disable_rdp_cert_auth": true
  }
}

Response examples

Managed account batch was successfully modified

Empty response

post/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/batch/delete

Delete a batch of managed accounts

idsarray

Responses

Request examples

{
  "ids": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ]
}

Response examples

Managed account batch was successfully deleted

Empty response

post/secrets-manager/api/v1/targetdomains/{targetDomainID}/managedaccounts/batch/rotate

Trigger password rotation for a batch of managed accounts

idsarray

Responses

Request examples

{
  "ids": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ]
}

Response examples

Rotation was successfully triggered for a managed account batch

Empty response

Was this page helpful?