Skip to main content

Get Password Complexity Settings​

Returns the password complexity settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify how a password should look (characters, length, etc.)

Responses

default password complexity policy


Schema
    policy object
    details object
    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to
    minLength uint64
    hasUppercase boolean

    defines if the password MUST contain an upper case letter

    hasLowercase boolean

    defines if the password MUST contain a lowercase letter

    hasNumber boolean

    defines if the password MUST contain a number

    hasSymbol boolean

    defines if the password MUST contain a symbol. E.g. "$"

    isDefault boolean

    defines if the organization's admin changed the policy

GET /policies/password/complexity

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/admin/v1
Bearer Token
Accept
curl / cURL
curl -L -X GET 'https://$CUSTOM-DOMAIN/admin/v1/policies/password/complexity' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'