Skip to navigation

Update account access

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
account_unlock_optionsobjectOptional
Settings for the account unlock skill.
mfa_reset_optionsobjectOptional
Settings for the MFA reset skill.
change_password_optionsobjectOptional
Settings for proactive password expiry notifications.
password_lifespan_secondsinteger or string or any or enumOptional

How long, in seconds, a password lasts before it expires and must be changed. Used to compute expiry dates for proactive notifications. Minimum 86400 (1 day); omit for no expiry policy.

Response

The updated account access, at its new version
account_unlock_optionsobjectOptional
Settings for the account unlock skill.
mfa_reset_optionsobjectOptional
Settings for the MFA reset skill.
change_password_optionsobjectOptional
Settings for proactive password expiry notifications.
password_lifespan_secondsinteger or string or any or enumOptional

How long, in seconds, a password lasts before it expires and must be changed. Used to compute expiry dates for proactive notifications. Minimum 86400 (1 day); omit for no expiry policy.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error