Get a PasswordPolicy

GET/v2/password-policies/{passwordPolicy}

API-Version

v2

Request-Methode

GET

Operation-ID

password-validation-get-password-policy

Request

• passwordPolicystringrequired

  The name of the PasswordPolicy to be retrieved.

Responses

Format

application/json

Beschreibung

The PasswordPolicy to be retrieved.

• minComplexityintegerrequired
• rulesArray von objectrequired
  • Array[
    • *object
      • ruleTypestringrequired
      • *
    ]

Content-Type: application/json

{
  "minComplexity": 123,
  "rules": [
    {
      "ruleType": "string"
    }
  ]
}

{
  "properties": {
    "minComplexity": {
      "type": "integer"
    },
    "rules": {
      "items": {
        "additionalProperties": true,
        "properties": {
          "ruleType": {
            "type": "string"
          }
        },
        "required": [
          "ruleType"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "minComplexity",
    "rules"
  ],
  "type": "object"
}

Nutzungsbeispiele

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/password-policies/string

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.passwordValidationGetPasswordPolicy({
  "passwordPolicy": "string"
});

assertStatus(response, 200);
  

use \Mittwald\ApiClient\Generated\V2\Clients\User\PasswordValidationGetPasswordPolicy\PasswordValidationGetPasswordPolicyRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new PasswordValidationGetPasswordPolicyRequest(
  passwordPolicy: "string"
));
$response = $client->user()->passwordValidationGetPasswordPolicy($request);

var_dump($response->getBody();