Skip to main content

Get the lockout settings

GET 
/v2beta/settings/lockout

Return the lockout settings for the requested context, which define when a user will be locked

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

    maxPasswordAttempts uint64

    Maximum password check attempts before the account gets locked. Attempts are reset as soon as the password is entered correctly or the password is reset. If set to 0 the account will never be locked.

    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

    resource_owner_type returns if the settings is managed on the organization or on the instance

    maxOtpAttempts uint64

    Maximum failed attempts for a single OTP type (TOTP, SMS, Email) before the account gets locked. Attempts are reset as soon as the OTP is entered correctly. If set to 0 the account will never be locked.

Loading...