> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eorion.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取密码策略

> A password policy consists of a list of rules that new passwords must follow to be
policy compliant. This end point returns a JSON representation of the
list of policy rules. More information on password policies in Camunda can be found in the password policy
[user guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/password-policy/) and in
the [security instructions](https://docs.camunda.org/manual/7.22/user-guide/security/).



## OpenAPI

````yaml GET /identity/password-policy
openapi: 3.0.2
info:
  title: ORION Platform REST API
  description: OpenApi Spec for ORION Camunda Platform REST API.
  version: 7.22.6-ee
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ORION Rest API
  url: https://docs.eorion.com
paths:
  /identity/password-policy:
    get:
      tags:
        - Identity
      summary: Get Password Policy
      description: >-
        A password policy consists of a list of rules that new passwords must
        follow to be

        policy compliant. This end point returns a JSON representation of the

        list of policy rules. More information on password policies in Camunda
        can be found in the password policy

        [user
        guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/password-policy/)
        and in

        the [security
        instructions](https://docs.camunda.org/manual/7.22/user-guide/security/).
      operationId: getPasswordPolicy
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicyDto'
              examples:
                example-1:
                  description: GET `/identity/password-policy`
                  value:
                    rules:
                      - placeholder: PASSWORD_POLICY_USER_DATA
                        parameter: null
                      - placeholder: PASSWORD_POLICY_LENGTH
                        parameter:
                          minLength: '10'
                      - placeholder: PASSWORD_POLICY_LOWERCASE
                        parameter:
                          minLowerCase: '1'
                      - placeholder: PASSWORD_POLICY_UPPERCASE
                        parameter:
                          minUpperCase: '1'
                      - placeholder: PASSWORD_POLICY_DIGIT
                        parameter:
                          minDigit: '1'
                      - placeholder: PASSWORD_POLICY_SPECIAL
                        parameter:
                          minSpecial: '1'
          description: >-
            Request successful. This example uses the built-in password policy
            that enforces a minimum password length,

            and some complexity rules.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: No password policy was found.
components:
  schemas:
    PasswordPolicyDto:
      type: object
      properties:
        rules:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/PasswordPolicyRuleDto'
          description: >-
            An array of password policy rules. Each element of the array is
            representing one rule of the policy.
    ExceptionDto:
      title: ExceptionDto
      type: object
      properties:
        type:
          type: string
          nullable: true
          description: An exception class indicating the occurred error.
        message:
          type: string
          nullable: true
          description: A detailed message of the error.
        code:
          type: number
          description: >-
            The code allows your client application to identify the error in an
            automated fashion.

            You can look up the meaning of all built-in codes and learn how to
            add custom codes

            in the [User
            Guide](https://docs.camunda.org/manual/7.22/user-guide/process-engine/error-handling/#exception-codes).
    PasswordPolicyRuleDto:
      type: object
      description: Describes a rule of a password policy.
      properties:
        placeholder:
          type: string
          nullable: true
          description: >-
            A placeholder string that contains the name of a password policy
            rule.
        parameter:
          type: object
          additionalProperties:
            type: string
          description: >-
            A map that describes the characteristics of a password policy rule,
            such as the minimum number of digits.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````