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
  • 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

Response

ExamplesSchema

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

id

string

uuid

name

string

required

rotation_interval

string

interval after which to rotate password

Example
"P30D"

password_min_length

int

password_max_length

int

use_special_characters

boolean

use_lower_case

boolean

use_upper_case

boolean

use_numbers

boolean

max_versions

int

required

store N last passwords

number_of_retries

int

how many time try recovery before mark account as failed

retry_interval

string

interval between retries

Example
"PT5M"

max_concurrent_checkouts

int

maximum number of concurrent secret checkouts

max_checkout_duration

string

maximum duration of secret checkouts

Example
"PT3M"

rotate_on_release

boolean

verify_after_rotation

boolean

created

string

date-time

When the object was created. Added by backend

Example
"2017-01-01T15:05:05Z"

updated

string

date-time

When the object was updated. Added by backend

Example
"2017-01-01T15:05:05Z"

created_by

string

added by backend

updated_by

string

added by backend

Request

{
  "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

ExamplesSchema

inserted

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

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

get a policy

id

string

required

Response

ExamplesSchema

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

id

string

uuid

name

string

required

rotation_interval

string

interval after which to rotate password

Example
"P30D"

password_min_length

int

password_max_length

int

use_special_characters

boolean

use_lower_case

boolean

use_upper_case

boolean

use_numbers

boolean

max_versions

int

required

store N last passwords

number_of_retries

int

how many time try recovery before mark account as failed

retry_interval

string

interval between retries

Example
"PT5M"

max_concurrent_checkouts

int

maximum number of concurrent secret checkouts

max_checkout_duration

string

maximum duration of secret checkouts

Example
"PT3M"

rotate_on_release

boolean

verify_after_rotation

boolean

created

string

date-time

When the object was created. Added by backend

Example
"2017-01-01T15:05:05Z"

updated

string

date-time

When the object was updated. Added by backend

Example
"2017-01-01T15:05:05Z"

created_by

string

added by backend

updated_by

string

added by backend

Request

{
  "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

ExamplesSchema

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

id

string

required

Response

ExamplesSchema

deleted

Empty response

Was this page helpful?