password_policies
Creates, updates, deletes, gets or lists a password_policies resource.
Overview​
| Name | password_policies |
| Type | Resource |
| Id | ovh.dedicated_cloud.password_policies |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
denied_chars | array | List of denied characters in the password (wire: deniedChars) |
digit_mandatory | boolean | Whether or not a digit (0-9) is mandatory in the password (wire: digitMandatory) |
history_check | integer | Number of previous passwords to keep (wire: historyCheck) |
letter_mandatory | boolean | Whether or not a letter (a-z or A-Z) is mandatory in the password (wire: letterMandatory) |
lowercase_letter_mandatory | boolean | Whether or not a lowercase letter (a-z) is mandatory in the password (wire: lowercaseLetterMandatory) |
max_length | integer | Maximum lenght of the password (wire: maxLength) |
min_length | integer | Minimum lenght of the password (wire: minLength) |
special_mandatory | boolean | Whether or not a special character (\W or _) is mandatory in the password (wire: specialMandatory) |
uppercase_letter_mandatory | boolean | Whether or not an uppercase letter (A-Z) is mandatory in the password (wire: uppercaseLetterMandatory) |
validity_period | integer | Password validity period (in days) (wire: validityPeriod) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the password policy. Returns the password rules for users: length, mandatory and denied characters, history and validity period. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
service_name | string | Domain of the service (wire: serviceName) |
SELECT examples​
- get
Get the password policy. Returns the password rules for users: length, mandatory and denied characters, history and validity period.
SELECT
denied_chars,
digit_mandatory,
history_check,
letter_mandatory,
lowercase_letter_mandatory,
max_length,
min_length,
special_mandatory,
uppercase_letter_mandatory,
validity_period
FROM ovh.dedicated_cloud.password_policies
WHERE service_name = '{{ service_name }}' -- required
;