Skip to main content

Update Auth Org Lockout Configuration

PATCH 

/auth-org/lockout-config

This API updates an existing lockout configuration for an org using PATCH Requires security scope of: 'sp:auth-org:update'

Request

Body

arrayrequired

A list of auth org lockout configuration update operations according to the JSON Patch standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are:

  1. maximumAttempts >= 1 && maximumAttempts <= 15
  2. lockoutDuration >= 5 && lockoutDuration <= 60
  3. lockoutWindow >= 5 && lockoutDuration <= 60
  • Array [
  • op stringrequired

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

    path stringrequired

    A string JSON Pointer representing the target path to an element to be affected by the operation

    value object

    The value to be used for the operation, required for "add" and "replace" operations

    oneOf

    string

  • ]

Responses

Updated Auth Org lockout configuration.

Schema
    maximumAttempts int32

    The maximum attempts allowed before lockout occurs.

    lockoutDuration int32

    The total time in minutes a user will be locked out.

    lockoutWindow int32

    A rolling window where authentication attempts in a series count towards the maximum before lockout occurs.

Loading...