Sign in

v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
Universal Auth

Attach Universal Auth configuration onto machine identity

post/api/v1/auth/universal-auth/identities/{identityId}

Path parameters

identityIdstring required

The ID of the machine identity to attach the configuration onto.

Request body

accessTokenTTLinteger

The lifetime for an access token in seconds. This value will be referenced at renewal time.

accessTokenMaxTTLinteger

The maximum lifetime for an access token in seconds. This value will be referenced at renewal time.

accessTokenNumUsesLimitinteger

The maximum number of times that an access token can be used; a value of 0 implies infinite number of uses.

accessTokenPeriodinteger

The period for an access token in seconds. This value will be referenced at renewal time. Default value is 0.

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