{
  "openapi": "3.0.1",
  "info": {
    "title": "Password Policies",
    "version": "9.1.20.0",
    "description": "Create and administer possword policies.",
    "x-introduced": "9.1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/rest/admin/v2",
      "variables": {
        "port": {
          "default": "443",
          "enum": [
            "443",
            "8000"
          ]
        },
        "hostname": {
          "default": "localhost",
          "enum": [
            "localhost",
            "test.hcl.com"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Password Policies",
      "description": "Provide RESTful services to manage password policies."
    }
  ],
  "paths": {
    "/password-policies": {
      "get": {
        "tags": [
          "Password Policies"
        ],
        "description": "Get a collection of password policies.",
        "operationId": "getPasswordPolicies",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "The unique numeric ID for identifying a password policy.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "matchUserId",
            "in": "query",
            "description": "Specifies whether the user ID and password can match. A value of 0 indicates that they cannot match. A value of 1 indicates that they can match. Default value is 0.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "maximumConsecutiveType",
            "in": "query",
            "description": "The maximum number of consecutive character type allowed in a password. Default value is 4.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "maximumInstances",
            "in": "query",
            "description": "The maximum number of times a character can occur in a password. Default value is 3.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "maximumLifetime",
            "in": "query",
            "description": "The maximum number of days for which a password is valid, from the last time it is updated. Default value is 90.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "minimumAlphabetic",
            "in": "query",
            "description": "The minimum number of alphabetic characters that should be in a password. Default value is 1.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "minimumNumeric",
            "in": "query",
            "description": "The minimum number of numeric characters that should be in a password. Default value is 1.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "minimumPasswordLength",
            "in": "query",
            "description": "The minimum password length in characters. Default value is 8.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "reusePassword",
            "in": "query",
            "description": "Specifies whether the user's previous password(s) can be reused. A value of 0 indicates that the previous password cannot be reused. A value of 1 or greater indicates that the previous password can be reused. A negative integer, n, indicates that the last n passwords cannot be reused. For example, if the value is set to -4, it means that the last 4 passwords cannot be reused. Note that a value of -1 or 0 both indicate that the previous password cannot be reused. Default value is -1.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of password policies.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PasswordPolicyCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Password Policies"
        ],
        "description": "Create a password policy.",
        "operationId": "createPasswordPolicy",
        "requestBody": {
          "description": "The password policy.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PasswordPolicy.request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "The operation was successful.",
            "content": {},
            "headers": {
              "Location": {
                "description": "The URI of the password-policies.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "links": {
              "GetPasswordPoliciesByPasswordPoliciesId": {
                "operationRef": "#/paths/~1password-policies~1{id}/get",
                "parameters": {
                  "id": "$response.header.Location"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `GET /password-policies/{id}`.\n"
              },
              "DeletePasswordPoliciesByPasswordPoliciesId": {
                "operationRef": "#/paths/~1password-policies~1{id}/delete",
                "parameters": {
                  "id": "$response.header.Location"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `DELETE /password-policies/{id}`.\n"
              },
              "UpdatePasswordPoliciesByPasswordPoliciesId": {
                "operationRef": "#/paths/~1password-policies~1{id}/patch",
                "parameters": {
                  "id": "$response.header.Location"
                },
                "description": "The `id` value used in the request body can be used as the `id` parameter in `PATCH /password-policies/{id}`.\n"
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "PasswordPolicy"
      }
    },
    "/password-policies/{id}": {
      "get": {
        "tags": [
          "Password Policies"
        ],
        "description": "Get a password policy.",
        "operationId": "getPasswordPolicyById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying a password policy.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The password policy.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PasswordPolicy"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Password Policies"
        ],
        "description": "Delete a password policy.",
        "operationId": "deletePasswordPolicyById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying a password policy.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "Password Policies"
        ],
        "description": "Update a password policy.",
        "operationId": "updatePasswordPolicyById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying a password policy.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The password policy.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PasswordPolicy.request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The operation was successful.",
            "content": {}
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "404": {
            "description": "The resource was not found.",
            "content": {}
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "PasswordPolicy"
      }
    },
    "/password-policies/{id}/descriptions": {
      "get": {
        "tags": [
          "Password Policies"
        ],
        "operationId": "getDescriptionsOfPasswordPolicy",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying a password policy.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of password policy descriptions.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PasswordPolicyDescriptionCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    },
    "/password-policies/{id}/user-account-policies": {
      "get": {
        "tags": [
          "Password Policies"
        ],
        "operationId": "getUserAccountPoliciesOfPasswordPolicy",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique numeric ID for identifying a password policy.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "The position within the resulting dataset where the query begins returning item records. If the offset is \"5\", the records that returned begin with the sixth record that matches the query parameters. If the offset is \"0\", the records that are returned begin with the first record that matches the query parameters.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "The maximum number of records to return.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "expand",
            "in": "query",
            "description": "The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A collection of user account policies records.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserAccountPolicyCollection"
                }
              }
            }
          },
          "400": {
            "description": "There was a client error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          },
          "500": {
            "description": "There was a server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseContainer"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "The error message code."
          },
          "errorMessage": {
            "type": "string",
            "description": "The error message."
          },
          "errorKey": {
            "type": "string",
            "description": "The error message key."
          },
          "errorParameters": {
            "type": "array",
            "description": "The arguments used to construct the error message.",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "errorLevel": {
            "type": "string",
            "description": "The error level."
          },
          "errorHref": {
            "type": "string",
            "description": "The error hypertext reference."
          }
        },
        "description": "The error message item model."
      },
      "ErrorResponseContainer": {
        "type": "object",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "The request identifier."
          },
          "errors": {
            "type": "array",
            "description": "The errors.",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        },
        "description": "The error message model."
      },
      "PasswordPolicy": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique numeric ID for identifying a password policy."
          },
          "matchUserId": {
            "type": "integer",
            "description": "Specifies whether the user ID and password can match. A value of 0 indicates that they cannot match. A value of 1 indicates that they can match. Default value is 0.",
            "format": "int32"
          },
          "maximumConsecutiveType": {
            "type": "integer",
            "description": "The maximum number of consecutive character type allowed in a password. Default value is 4.",
            "format": "int32"
          },
          "maximumInstances": {
            "type": "integer",
            "description": "The maximum number of times a character can occur in a password. Default value is 3.",
            "format": "int32"
          },
          "maximumLifetime": {
            "type": "integer",
            "description": "The maximum number of days for which a password is valid, from the last time it is updated. Default value is 90.",
            "format": "int32"
          },
          "minimumAlphabetic": {
            "type": "integer",
            "description": "The minimum number of alphabetic characters that should be in a password. Default value is 1.",
            "format": "int32"
          },
          "minimumNumeric": {
            "type": "integer",
            "description": "The minimum number of numeric characters that should be in a password. Default value is 1.",
            "format": "int32"
          },
          "minimumPasswordLength": {
            "type": "integer",
            "description": "The minimum password length in characters. Default value is 8.",
            "format": "int32"
          },
          "reusePassword": {
            "type": "integer",
            "description": "Specifies whether the user's previous password(s) can be reused. A value of 0 indicates that the previous password cannot be reused. A value of 1 or greater indicates that the previous password can be reused. A negative integer, n, indicates that the last n passwords cannot be reused. For example, if the value is set to -4, it means that the last 4 passwords cannot be reused. Note that a value of -1 or 0 both indicate that the previous password cannot be reused. Default value is -1.",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "descriptions": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "user-account-policies": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The password policy."
      },
      "PasswordPolicy.request": {
        "type": "object",
        "properties": {
          "matchUserId": {
            "type": "integer",
            "description": "Specifies whether the user ID and password can match. A value of 0 indicates that they cannot match. A value of 1 indicates that they can match. Default value is 0.",
            "format": "int32"
          },
          "maximumConsecutiveType": {
            "type": "integer",
            "description": "The maximum number of consecutive character type allowed in a password. Default value is 4.",
            "format": "int32"
          },
          "maximumInstances": {
            "type": "integer",
            "description": "The maximum number of times a character can occur in a password. Default value is 3.",
            "format": "int32"
          },
          "maximumLifetime": {
            "type": "integer",
            "description": "The maximum number of days for which a password is valid, from the last time it is updated. Default value is 90.",
            "format": "int32"
          },
          "minimumAlphabetic": {
            "type": "integer",
            "description": "The minimum number of alphabetic characters that should be in a password. Default value is 1.",
            "format": "int32"
          },
          "minimumNumeric": {
            "type": "integer",
            "description": "The minimum number of numeric characters that should be in a password. Default value is 1.",
            "format": "int32"
          },
          "minimumPasswordLength": {
            "type": "integer",
            "description": "The minimum password length in characters. Default value is 8.",
            "format": "int32"
          },
          "reusePassword": {
            "type": "integer",
            "description": "Specifies whether the user's previous password(s) can be reused. A value of 0 indicates that the previous password cannot be reused. A value of 1 or greater indicates that the previous password can be reused. A negative integer, n, indicates that the last n passwords cannot be reused. For example, if the value is set to -4, it means that the last 4 passwords cannot be reused. Note that a value of -1 or 0 both indicate that the previous password cannot be reused. Default value is -1.",
            "format": "int32"
          }
        },
        "description": "The password policy."
      },
      "PasswordPolicyCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/PasswordPolicy"
            }
          }
        },
        "description": "A collection of password policies."
      },
      "PasswordPolicyDescription": {
        "type": "object",
        "properties": {
          "passwordPolicyId": {
            "type": "string",
            "description": "The unique numeric ID for identifying the password policy."
          },
          "description": {
            "type": "string",
            "description": "The description of the password policy."
          },
          "languageId": {
            "type": "integer",
            "description": "The language of the description. For a list of integer language identifiers, please refer to the Knowledge Center.",
            "format": "int32"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The description of a password policy."
      },
      "PasswordPolicyDescriptionCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/PasswordPolicyDescription"
            }
          }
        },
        "description": "A collection of password policy descriptions."
      },
      "UserAccountPolicy": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique numeric ID for identifying a user account policy.",
            "format": "int32"
          },
          "userAccountLockoutPolicyId": {
            "type": "string",
            "description": "The unique numeric ID for identifying a user account lockout policy."
          },
          "passwordPolicyId": {
            "type": "string",
            "description": "The unique numeric ID for identifying a password policy."
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "descriptions": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "description": "The user account policy."
      },
      "UserAccountPolicyCollection": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "description": "The total number of items.",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "description": "The items.",
            "items": {
              "$ref": "#/components/schemas/UserAccountPolicy"
            }
          }
        },
        "description": "A collection of user account policies records."
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-components": {}
}