Secrets Manager

manage password policies

Download Spec

get/secrets-manager/api/v1/password-policies

get all policies

OAuth2 oauth

Required Scopes:

adminhostsViewservice

get all policies

All Scopes

admin · Admin scope - used for built-in PrivX admin account
hostsManage · Clients with hosts-manage scope
hostsProvisioning · Deploy script users
hostsView · Clients with hosts-view scope
service · Microservice scope - used for communication between PrivX microservices
targetDomainsManage · Clients with target-domains-manage scope
targetDomainsView · Clients with target-domains-view scope
user · Normal users

Flow Type:: authorization_code

Auth URL:: https://api.x.com/v1/auth/auth

Token URL:: https://api.x.com/v1/auth/auth

Responses

Response examples

policies array

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "rotation_interval": "P30D",
      "password_min_length": 123,
      "password_max_length": 123,
      "use_special_characters": true,
      "use_lower_case": true,
      "use_upper_case": true,
      "use_numbers": true,
      "max_versions": 123,
      "number_of_retries": 123,
      "retry_interval": "PT5M",
      "max_concurrent_checkouts": 123,
      "max_checkout_duration": "PT3M",
      "rotate_on_release": true,
      "verify_after_rotation": true,
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "created_by": "string",
      "updated_by": "string"
    }
  ]
}

post/secrets-manager/api/v1/password-policy

insert a new policy to db

idstring

Format: uuid

namestring

required

rotation_intervalstring

interval after which to rotate password

Example: "P30D"

password_min_lengthint

password_max_lengthint

use_special_charactersboolean

use_lower_caseboolean

use_upper_caseboolean

use_numbersboolean

max_versionsint

required

store N last passwords

number_of_retriesint

how many time try recovery before mark account as failed

retry_intervalstring

interval between retries

Example: "PT5M"

max_concurrent_checkoutsint

maximum number of concurrent secret checkouts

max_checkout_durationstring

maximum duration of secret checkouts

Example: "PT3M"

rotate_on_releaseboolean

verify_after_rotationboolean

createdstring

When the object was created. Added by backend

Format: date-time
Example: "2017-01-01T15:05:05Z"

updatedstring

When the object was updated. Added by backend

Format: date-time
Example: "2017-01-01T15:05:05Z"

created_bystring

added by backend

updated_bystring

added by backend

Responses

Request examples

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "rotation_interval": "P30D",
  "password_min_length": 123,
  "password_max_length": 123,
  "use_special_characters": true,
  "use_lower_case": true,
  "use_upper_case": true,
  "use_numbers": true,
  "max_versions": 123,
  "number_of_retries": 123,
  "retry_interval": "PT5M",
  "max_concurrent_checkouts": 123,
  "max_checkout_duration": "PT3M",
  "rotate_on_release": true,
  "verify_after_rotation": true,
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "created_by": "string",
  "updated_by": "string"
}

Response examples

inserted

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}

get/secrets-manager/api/v1/password-policy/{id}

get a policy

idstring

required

Responses

Response examples

policies array

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "rotation_interval": "P30D",
  "password_min_length": 123,
  "password_max_length": 123,
  "use_special_characters": true,
  "use_lower_case": true,
  "use_upper_case": true,
  "use_numbers": true,
  "max_versions": 123,
  "number_of_retries": 123,
  "retry_interval": "PT5M",
  "max_concurrent_checkouts": 123,
  "max_checkout_duration": "PT3M",
  "rotate_on_release": true,
  "verify_after_rotation": true,
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "created_by": "string",
  "updated_by": "string"
}

put/secrets-manager/api/v1/password-policy/{id}

update a policy

idstring

Format: uuid

namestring

required

rotation_intervalstring

interval after which to rotate password

Example: "P30D"

password_min_lengthint

password_max_lengthint

use_special_charactersboolean

use_lower_caseboolean

use_upper_caseboolean

use_numbersboolean

max_versionsint

required

store N last passwords

number_of_retriesint

how many time try recovery before mark account as failed

retry_intervalstring

interval between retries

Example: "PT5M"

max_concurrent_checkoutsint

maximum number of concurrent secret checkouts

max_checkout_durationstring

maximum duration of secret checkouts

Example: "PT3M"

rotate_on_releaseboolean

verify_after_rotationboolean

createdstring

When the object was created. Added by backend

Format: date-time
Example: "2017-01-01T15:05:05Z"

updatedstring

When the object was updated. Added by backend

Format: date-time
Example: "2017-01-01T15:05:05Z"

created_bystring

added by backend

updated_bystring

added by backend

Responses

Request examples

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "rotation_interval": "P30D",
  "password_min_length": 123,
  "password_max_length": 123,
  "use_special_characters": true,
  "use_lower_case": true,
  "use_upper_case": true,
  "use_numbers": true,
  "max_versions": 123,
  "number_of_retries": 123,
  "retry_interval": "PT5M",
  "max_concurrent_checkouts": 123,
  "max_checkout_duration": "PT3M",
  "rotate_on_release": true,
  "verify_after_rotation": true,
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "created_by": "string",
  "updated_by": "string"
}

Response examples

inserted

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "rotation_interval": "P30D",
  "password_min_length": 123,
  "password_max_length": 123,
  "use_special_characters": true,
  "use_lower_case": true,
  "use_upper_case": true,
  "use_numbers": true,
  "max_versions": 123,
  "number_of_retries": 123,
  "retry_interval": "PT5M",
  "max_concurrent_checkouts": 123,
  "max_checkout_duration": "PT3M",
  "rotate_on_release": true,
  "verify_after_rotation": true,
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "created_by": "string",
  "updated_by": "string"
}

delete/secrets-manager/api/v1/password-policy/{id}

delete a policy

idstring

required

Responses

Response examples

deleted

Empty response

Was this page helpful?