Get the password complexity settings

Return the password complexity settings for the requested context

Query Parameters

ctx.orgId string
ctx.instance boolean

Responses

200
403
404
default

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

Schema

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
changeDate date-time
on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
settings object
minLength uint64
Defines the minimum length of a password.
requiresUppercase boolean
defines if the password MUST contain an upper case letter
requiresLowercase boolean
defines if the password MUST contain a lowercase letter
requiresNumber boolean
defines if the password MUST contain a number
requiresSymbol boolean
defines if the password MUST contain a symbol. E.g. "$"
resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instance
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the settings is managed on the organization or on the instance

{
  "details": {
    "sequence": "2",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "settings": {
    "minLength": "8",
    "requiresUppercase": true,
    "requiresLowercase": true,
    "requiresNumber": true,
    "requiresSymbol": true,
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
  }
}

Schema
Example (from schema)

Schema

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
changeDate date-time
on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
settings object
minLength uint64
Defines the minimum length of a password.
requiresUppercase boolean
defines if the password MUST contain an upper case letter
requiresLowercase boolean
defines if the password MUST contain a lowercase letter
requiresNumber boolean
defines if the password MUST contain a number
requiresSymbol boolean
defines if the password MUST contain a symbol. E.g. "$"
resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instance
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the settings is managed on the organization or on the instance

{
  "details": {
    "sequence": "2",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "settings": {
    "minLength": "8",
    "requiresUppercase": true,
    "requiresLowercase": true,
    "requiresNumber": true,
    "requiresSymbol": true,
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
  }
}

Schema
Example (from schema)

Schema

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
changeDate date-time
on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to
settings object
minLength uint64
Defines the minimum length of a password.
requiresUppercase boolean
defines if the password MUST contain an upper case letter
requiresLowercase boolean
defines if the password MUST contain a lowercase letter
requiresNumber boolean
defines if the password MUST contain a number
requiresSymbol boolean
defines if the password MUST contain a symbol. E.g. "$"
resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instance
Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]
Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED
resource_owner_type returns if the settings is managed on the organization or on the instance

{
  "details": {
    "sequence": "2",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  },
  "settings": {
    "minLength": "8",
    "requiresUppercase": true,
    "requiresLowercase": true,
    "requiresNumber": true,
    "requiresSymbol": true,
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
  }
}

Returned when the user does not have permission to access the resource.

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

GET /v2alpha/settings/password/complexity

Request

Base URL

https://$ZITADEL_DOMAIN

ctx.orgId — query

ctx.instance — query

Accept

curl -L -X GET 'https://$ZITADEL_DOMAIN/v2alpha/settings/password/complexity' \
-H 'Accept: application/json'

curl -L -X GET 'https://$ZITADEL_DOMAIN/v2alpha/settings/password/complexity' \
-H 'Accept: application/json'

curl -L -X GET 'https://$ZITADEL_DOMAIN/v2alpha/settings/password/complexity' \
-H 'Accept: application/json'

curl -L -X GET 'https://$ZITADEL_DOMAIN/v2alpha/settings/password/complexity' \
-H 'Accept: application/json'

curl -L -X GET 'https://$ZITADEL_DOMAIN/v2alpha/settings/password/complexity' \
-H 'Accept: application/json'

curl -L -X GET 'https://$ZITADEL_DOMAIN/v2alpha/settings/password/complexity' \
-H 'Accept: application/json'

curl -L -X GET 'https://$ZITADEL_DOMAIN/v2alpha/settings/password/complexity' \
-H 'Accept: application/json'

Get the password complexity settings​

Request

Get the password complexity settings