• Identity and Access Management

iam
  1. Help Center
  2. Identity and Access Management
  3. API Reference
  4. Tenant Management
  5. Querying the Password Strength Policy by Option

Querying the Password Strength Policy by Option

Function Description

This interface is used to query the password strength policy by option. The option can be the regular expression and description of the password strength policy.

URI

  • URI format

    GET /v3/domains/{domain_id}/config/security_compliance/{option}

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    domain_id

    Yes

    String

    Domain ID to be queried.

    option

    Yes

    String

    Query option, which can be password_regex or password_regex_description.

Request

  • Request header parameter description

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    Fill application/json;charset=utf8 in this field.

    X-Auth-Token

    Yes

    String

    Authenticated token of a user.

  • Sample request
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://172.30.48.86:31943//v3/domains/{domain_id}/config/security_compliance/password_regex

Response

  • Response body parameter description

    Parameter

    Mandatory

    Type

    Description

    config

    Yes

    JSON

    Password strength policy of a domain.

  • Description for the config format

    Parameter

    Mandatory

    Type

    Description

    password_regex

    No

    String

    Regular expression of the password strength policy (When option is set to password_regex).

    password_regex_description

    No

    String

    Description of the password strength policy (When option is set to password_regex_description).

  • Sample response
    When option is set to password_regex:
    {
      "config": {
        "password_regex": "^(?=.*\\d)(?=.*[a-zA-Z]).{7,}$"
      }
    }
    When option is set to password_regex_description:
    {
      "config": {
        "password_regex_description": "Passwords must contain at least 1 letter, 1 digit, and be a minimum length of 7 characters."
      }
    }

Status Code

Status Code

Description

200

The request is successful.

400

The server failed to process the request.

401

You must enter a username and password to access the requested page.

403

You are forbidden to access the requested page.

404

The server could not find the requested page.

405

You are not allowed to use the method specified in the request.

413

The request entity is too large.

500

Failed to complete the request because of an internal service error.

503

Failed to complete the request because the service is unavailable.