Sign in
LDAP Auth

Update LDAP Auth configuration on machine identity

patch/api/v1/auth/ldap-auth/identities/{identityId}

Path parameters

identityIdstring required

The ID of the machine identity to update the configuration for.

Request body

urlstring

The new URL of the LDAP server.

bindDNstring

The new DN of the user to bind to the LDAP server.

bindPassstring

The new password of the user to bind to the LDAP server.

searchBasestring

The new base DN to search for the LDAP user.

templateIdstring

The ID of the identity auth template to update the configuration to.

searchFilterstring

The new filter to use to search for the LDAP user.

accessTokenTTLinteger

The new lifetime for an access token in seconds.

accessTokenNumUsesLimitinteger

The new maximum number of times that an access token can be used.

accessTokenMaxTTLinteger

The new maximum lifetime for an access token in seconds.

lockoutEnabledboolean

Whether the lockout feature is enabled.

lockoutThresholdnumber

The amount of times login must fail before locking the identity auth method.

lockoutDurationSecondsnumber

How long an identity auth method lockout lasts.

lockoutCounterResetSecondsnumber

How long to wait from the most recent failed login until resetting the lockout counter.

Response

Default Response

Changes

No recorded changes to this endpoint across all 19 revisions of this API.