Skip to navigation

Account Access

View as Markdown

tool.access-account

Forgot-password settings and connector bidding are NOT exposed by this API.

  • Endpoint: /tool/access-account | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/tool/access-accountGet account access
PATCH/tool/access-accountUpdate account access

Fields

FieldTypeRequiredNotes
account_unlock_optionsAccountUnlockOptionsSettings for the account unlock skill.
mfa_reset_optionsMFAResetOptionsSettings for the MFA reset skill.
change_password_optionsChangePasswordOptionsSettings for proactive password expiry notifications.
password_lifespan_secondsanyHow 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_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"account_unlock_options": {
"proactive_reachout_filter_dsl": "true",
"proactive_reachout_query_enabled_dsl": "true"
},
"mfa_reset_options": {
"reset_mode": "MFA_RESET_MODE_UNSPECIFIED"
},
"change_password_options": {
"change_passwords_reminder_enabled": true,
"proactive_reachout_filter_dsl": "true",
"start_notifications_before_seconds": 0
},
"password_lifespan_seconds": 0
}