Skip to main content

Get Password Age Settings

GET 
/policies/password/age

Returns the password age settings configured on the organization. The settings specify the expiry of password, after which a user is forced to change it on the next login.

Request​

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Responses​

A successful response.

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 (string)
    maxAgeDays uint64

    Amount of days after which a password will expire. The user will be forced to change the password on the following authentication.

    expireWarnDays uint64

    Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user.

    isDefault boolean

    If true, the returned values represent the instance settings, e.g. by an organization without custom settings.

    isDefault deprecated: is_default is also defined in zitadel.policy.v1.PasswordAgePolicy (boolean)
Loading...