Skip to main content

Get the password expiry settings

GET 
/v2/settings/password/expiry

Return the password expiry settings for the requested context

Request​

Query Parameters

    ctx.orgId string
    ctx.instance boolean

Responses​

OK

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

    settings

    object

    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.

    resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instance (string)

    Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]

    Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED

Loading...