Docusign AccountPasswordRules API

openapi: 3.2.0
info:
  title: Docusign Account Password Rules API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged AccountPasswordRules across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: AccountPasswordRules
  description: The AccountPasswordRules resource provides methods that allow you to obtain and update account password rules, as well as membership and account rules.
paths:
  /v2/accounts/{accountId}/settings/password_rules:
    get:
      tags:
      - AccountPasswordRules
      summary: Docusign Get the password rules
      operationId: AccountPasswordRules_GetAccountPasswordRules
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/accountPasswordRules'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getAccountPasswordRules
      x-ds-method: get
      x-ds-service: Accounts
      x-ds-in-sdk: true
    put:
      tags:
      - AccountPasswordRules
      summary: Docusign Update the password rules
      operationId: AccountPasswordRules_PutAccountPasswordRules
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accountPasswordRules'
          application/xml:
            schema:
              $ref: '#/components/schemas/accountPasswordRules'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/accountPasswordRules'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateAccountPasswordRules
      x-ds-method: update
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-codegen-request-body-name: accountPasswordRules
    servers:
    - url: https://www.docusign.net/restapi
  /v2/current_user/password_rules:
    get:
      tags:
      - AccountPasswordRules
      summary: Docusign Get membership account password rules
      operationId: PasswordRules_GetPasswordRules
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/userPasswordRules'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getPasswordRules
      x-ds-method: getForUser
      x-ds-service: Accounts
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/settings/password_rules:
    parameters: []
    get:
      tags:
      - AccountPasswordRules
      summary: Gets the password rules for an account
      operationId: getV21AccountsByAccountIdSettingsPasswordRules
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountPasswordRules_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getAccountPasswordRules
      description: This method retrieves the password rules for an account.
      x-ds-method: get
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: AccountPasswordRules_GetAccountPasswordRules
    put:
      tags:
      - AccountPasswordRules
      summary: Updates the password rules for an account
      operationId: putV21AccountsByAccountIdSettingsPasswordRules
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountPasswordRules_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateAccountPasswordRules
      description: 'This method updates the password rules for an account.


        **Note:** To update the password rules for an account, you must be an account administrator.'
      x-ds-method: update
      x-ds-service: Accounts
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accountPasswordRules_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/accountPasswordRules_2'
      x-operation-id-source: normalized
      x-operation-id-original: AccountPasswordRules_PutAccountPasswordRules
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/current_user/password_rules:
    parameters: []
    get:
      tags:
      - AccountPasswordRules
      summary: Gets membership account password rules
      operationId: getV21CurrentUserPasswordRules
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/userPasswordRules_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getPasswordRules
      description: ''
      x-ds-method: getForUser
      x-ds-service: Accounts
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: PasswordRules_GetPasswordRules
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    accountMinimumPasswordLength:
      type: object
      properties:
        maximumLength:
          type: string
          description: ''
        minimumLength:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: accountMinimumPasswordLength
      x-ms-summary: ''
    accountPasswordExpirePasswordDays:
      type: object
      properties:
        maximumDays:
          type: string
          description: ''
        minimumDays:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: accountPasswordExpirePasswordDays
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    accountPasswordMinimumPasswordAgeDays:
      type: object
      properties:
        maximumAge:
          type: string
          description: ''
        minimumAge:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: accountPasswordMinimumPasswordAgeDays
      x-ms-summary: ''
    accountPasswordQuestionsRequired:
      type: object
      properties:
        maximumQuestions:
          type: string
          description: The maximum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or greater than `minimumQuestions`.
        minimumQuestions:
          type: string
          description: The minimum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or less than `maximumQuestions`.
      description: Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.
      x-ds-definition-name: accountPasswordQuestionsRequired
      x-ms-summary: Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.
    accountPasswordLockoutDurationMinutes:
      type: object
      properties:
        maximumMinutes:
          type: string
          description: ''
        minimumMinutes:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: accountPasswordLockoutDurationMinutes
      x-ms-summary: ''
    accountPasswordLockoutDurationType:
      type: object
      properties:
        options:
          type: array
          description: ''
          items:
            type: string
      description: ''
      x-ds-definition-name: accountPasswordLockoutDurationType
      x-ms-summary: ''
    accountPasswordRules:
      type: object
      properties:
        expirePassword:
          type: string
          description: ''
        expirePasswordDays:
          type: string
          description: ''
        expirePasswordDaysMetadata:
          $ref: '#/components/schemas/accountPasswordExpirePasswordDays'
        lockoutDurationMinutes:
          type: string
          description: ''
        lockoutDurationMinutesMetadata:
          $ref: '#/components/schemas/accountPasswordLockoutDurationMinutes'
        lockoutDurationType:
          type: string
          description: ''
        lockoutDurationTypeMetadata:
          $ref: '#/components/schemas/accountPasswordLockoutDurationType'
        minimumPasswordAgeDays:
          type: string
          description: ''
        minimumPasswordAgeDaysMetadata:
          $ref: '#/components/schemas/accountPasswordMinimumPasswordAgeDays'
        minimumPasswordLength:
          type: string
          description: ''
        minimumPasswordLengthMetadata:
          $ref: '#/components/schemas/accountMinimumPasswordLength'
        passwordIncludeDigit:
          type: string
          description: ''
        passwordIncludeDigitOrSpecialCharacter:
          type: string
          description: ''
        passwordIncludeLowerCase:
          type: string
          description: ''
        passwordIncludeSpecialCharacter:
          type: string
          description: ''
        passwordIncludeUpperCase:
          type: string
          description: ''
        passwordStrengthType:
          type: string
          description: ''
        passwordStrengthTypeMetadata:
          $ref: '#/components/schemas/accountPasswordStrengthType'
        questionsRequired:
          type: string
          description: ''
        questionsRequiredMetadata:
          $ref: '#/components/schemas/accountPasswordQuestionsRequired'
      description: ''
      x-ds-definition-name: accountPasswordRules
      x-ms-summary: ''
    userPasswordRules:
      type: object
      properties:
        passwordRules:
          $ref: '#/components/schemas/accountPasswordRules'
        userId:
          type: string
          description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.'
      description: ''
      x-ds-definition-name: userPasswordRules
      x-ms-summary: ''
    accountPasswordStrengthTypeOption:
      type: object
      properties:
        minimumLength:
          type: string
          description: ''
        name:
          type: string
          description: ''
        passwordIncludeDigit:
          type: string
          description: ''
        passwordIncludeDigitOrSpecialCharacter:
          type: string
          description: ''
        passwordIncludeLowerCase:
          type: string
          description: ''
        passwordIncludeSpecialCharacter:
          type: string
          description: ''
        passwordIncludeUpperCase:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: accountPasswordStrengthTypeOption
      x-ms-summary: ''
    accountPasswordStrengthType:
      type: object
      properties:
        options:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/accountPasswordStrengthTypeOption'
      description: ''
      x-ds-definition-name: accountPasswordStrengthType
      x-ms-summary: ''
    accountMinimumPasswordLength_2:
      type: object
      properties:
        maximumLength:
          description: The maximum number of entry characters supported by the custom tab.
          type: string
        minimumLength:
          description: Minimum length of the access code string.
          type: string
      x-ds-definition-name: accountMinimumPasswordLength
      description: ''
      x-ms-summary: ''
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    accountPasswordLockoutDurationType_2:
      type: object
      properties:
        options:
          description: An array of option strings supported by this setting.
          type: array
          items:
            type: string
      x-ds-definition-name: accountPasswordLockoutDurationType
      description: ''
      x-ms-summary: ''
    accountPasswordRules_2:
      type: object
      properties:
        expirePassword:
          description: When **true,** passwords expire. The default value is `false`.
          type: string
        expirePasswordDays:
          description: The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**
          type: string
        expirePasswordDaysMetadata:
          $ref: '#/components/schemas/accountPasswordExpirePasswordDays'
          description: 'Metadata that indicates whether the `expirePasswordDays` property is editable.

            '
        lockoutDurationMinutes:
          description: The number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`.
          type: string
        lockoutDurationMinutesMetadata:
          $ref: '#/components/schemas/accountPasswordLockoutDurationMinutes'
          description: 'Metadata that indicates whether the `lockoutDurationMinutes` property is editable.

            '
        lockoutDurationType:
          description: 'The interval associated with the user lockout after a failed login attempt.


            Possible values are:


            - `minutes` (default)

            - `hours`

            - `days`'
          type: string
        lockoutDurationTypeMetadata:
          $ref: '#/components/schemas/accountPasswordLockoutDurationType_2'
          description: 'Metadata that indicates whether the `lockoutDurationType` property is editable.

            '
        minimumPasswordAgeDays:
          description: The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`.
          type: string
        minimumPasswordAgeDaysMetadata:
          $ref: '#/components/schemas/accountPasswordMinimumPasswordAgeDays'
          description: 'Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.

            '
        minimumPasswordLength:
          description: The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`.
          type: string
        minimumPasswordLengthMetadata:
          $ref: '#/components/schemas/accountMinimumPasswordLength_2'
          description: 'Metadata that indicates whether the `minimumPasswordLength` property is editable.

            '
        passwordIncludeDigit:
          description: When **true,** passwords must include a digit. The default value is `false`.
          type: string
        passwordIncludeDigitOrSpecialCharacter:
          description: 'When **true,** passwords must include either a digit or a special character. The default value is `false`.


            **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.'
          type: string
        passwordIncludeLowerCase:
          description: When **true,** passwords must include a lowercase letter. The default value is `false`.
          type: string
        passwordIncludeSpecialCharacter:
          description: 'When **true,** passwords must include a special character. The default value is `false`.


            **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.'
          type: string
        passwordIncludeUpperCase:
          description: When **true,** passwords must include an uppercase letter. The default value is `false`.
          type: string
        passwordStrengthType:
          description: "The type of password strength. Possible values are:\n\n- `basic`: The minimum password length is 6 characters with no other password requirements.\n- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.\n- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.\n- `custom`: This option enables you to customize password requirements, including the following properties:\n\n   - `minimumPasswordLength`\n   - `minimumPasswordAgeDays`\n   - `passwordIncludeDigit`\n   - `passwordIncludeDigitOrSpecialCharacter`\n   - `passwordIncludeLowerCase`\n   - `passwordIncludeSpecialCharacter`\n   - `passwordIncludeUpperCase`\n   - `questionsRequired`"
          type: string
        passwordStrengthTypeMetadata:
          $ref: '#/components/schemas/accountPasswordStrengthType_2'
          description: 'Metadata that indicates whether the `passwordStrengthType` property is editable.

            '
        questionsRequired:
          description: The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`.
          type: string
        questionsRequiredMetadata:
          $ref: '#/components/schemas/accountPasswordQuestionsRequired'
          description: 'Metadata that indicates whether the `questionsRequired` property is editable.

            '
      x-ds-definition-name: accountPasswordRules
      description: ''
      x-ms-summary: ''
    userPasswordRules_2:
      type: object
      properties:
        passwordRules:
          $ref: '#/components/schemas/accountPasswordRules_2'
          description: Contains details about the password rules for the user.
        userId:
          description: 'The ID of the user to access.


            **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user''s settings.'
          type: string
      description: Contains details about the password rules for a user.
      x-ds-definition-name: userPasswordRules
      x-ms-summary: Contains details about the password rules for a user.
    accountPasswordStrengthTypeOption_2:
      type: object
      properties:
        minimumLength:
          description: Minimum length of the access code string.
          type: string
        name:
          description: ''
          type: string
        passwordIncludeDigit:
          description: When **true,** passwords must include a digit. The default value is `false`.
          type: string
        passwordIncludeDigitOrSpecialCharacter:
          description: 'When **true,** passwords must include either a digit or a special character. The default value is `false`.


            **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.'
          type: string
        passwordIncludeLowerCase:
          description: When **true,** passwords must include a lowercase letter. The default value is `false`.
          type: string
        passwordIncludeSpecialCharacter:
          description: 'When **true,** passwords must include a special character. The default value is `false`.


            **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.'
          type: string
        passwordIncludeUpperCase:
          description: When **true,** passwords must include an uppercase letter. The default value is `false`.
          type: string
      x-ds-definition-name: accountPasswordStrengthTypeOption
      description: ''
      x-ms-summary: ''
    accountPasswordStrengthType_2:
      type: object
      properties:
        options:
          description: An array of option strings supported by this setting.
          type: array
          items:
            $ref: '#/components/schemas/accountPasswordStrengthTypeOption_2'
      x-ds-definition-name: accountPasswordStrengthType
      description: ''
      x-ms-summary: ''
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'