Zitadel PHP API

PasswordComplexity
in package

Class for the management of the password complexity settings

Table of Contents

Properties

$minLength  : int|null
$orgId  : string|null
$requiresLowercase  : bool
$requiresNumber  : bool
$requiresSymbol  : bool
$requiresUppercase  : bool
$resourceOwnerType  : string|null
$settings  : array<string|int, mixed>

Methods

__construct()  : mixed
Initialize the password complexity settings class
getminLength()  : int
Get the minimum length of the password
getResourceOwnerType()  : string
Returns the resource owner type.
requiresLowercase()  : bool
Returns true if the password requires a lowercase letter.
requiresNumber()  : bool
Returns true if the password requires a number.
requiresSymbol()  : bool
Returns true if the password requires a symbol.
requiresUppercase()  : bool
Returns true if the password requires an uppercase letter.
sendRequest()  : void
Send a GET request to the ZITADEL API to retrieve the current password complexity settings.
setOrgId()  : void
Set the organization ID.

Properties

Methods

__construct()

Initialize the password complexity settings class

public __construct(array<string|int, mixed> $settings) : mixed
Parameters
$settings : array<string|int, mixed>

The settings array

getminLength()

Get the minimum length of the password

public getminLength() : int
Return values
int

The minimum length of the password

getResourceOwnerType()

Returns the resource owner type.

public getResourceOwnerType() : string
Return values
string

The resource owner type.

requiresLowercase()

Returns true if the password requires a lowercase letter.

public requiresLowercase() : bool
Return values
bool

True if the password requires a lowercase letter, false otherwise.

requiresNumber()

Returns true if the password requires a number.

public requiresNumber() : bool
Return values
bool

True if the password requires a number, false otherwise.

requiresSymbol()

Returns true if the password requires a symbol.

public requiresSymbol() : bool
Return values
bool

True if the password requires a symbol, false otherwise.

requiresUppercase()

Returns true if the password requires an uppercase letter.

public requiresUppercase() : bool
Return values
bool

True if the password requires an uppercase letter, false otherwise.

sendRequest()

Send a GET request to the ZITADEL API to retrieve the current password complexity settings.

public sendRequest() : void
Tags
throws
Exception

If the request fails or the ZITADEL API returns an error.

setOrgId()

Set the organization ID.

public setOrgId(string $orgId) : void
Parameters
$orgId : string

The organization ID to set.


        
On this page

Search results