Support access
Update support access policy
Change how Wordsmith staff may reach your organisation’s data.
PATCH
Changes the settings you send and keeps the rest. An omitted or
null field keeps its value, and at least one field must be set. The change is recorded in your audit log.
This endpoint only tightens the settings. If any field you send would loosen a setting, the whole change is refused with 403 forbidden, and the message names the settings. Loosening needs the web app, under Settings > Support access. A field loosens a setting when it:
- adds a sign-in mode to
allowed_sign_in_modes; - turns
allow_customer_scopeorget_supporton; - adds a role to
support_role_ids; - moves
approvalstowardsrequester(the order isrequester,another_person,data_owner_and_another); - turns
require_ticket,require_justificationorrequire_data_owneroff; - raises
max_grant_minutes, orapproval_window_minutes.
allow_customer_scope is off, it has no end or a longer window than max_grant_minutes, it lacks a ticket, justification or data owner that is now required, or it is still waiting for approval and approvals now asks for more. Removing a role from support_role_ids revokes every open grant that uses it. A grant already approved keeps the approvals it had. A support member whose sign-in mode is no longer allowed gets no new grant.
The Get support default role (get_support_default_role_id) is not changed here. Set it in the web app.
A session in which Wordsmith staff act on behalf of one of your members cannot change the settings.
Authentication
Requires an API key, or an OAuth token withdirectory:admin. directory:admin is never granted by default. The caller must also hold a role with the manage support settings permission; the predefined admin role holds both. The manage support access permission lets a member give access, but not change the settings. A Wordsmith support member is always refused, whatever role it holds. Support access must be turned on for your organisation.
Body parameters
Which kinds of support member you allow: any of
customer_identity and wordsmith_driven. Replaces the current list. It may only remove modes. An empty list allows none.Who must approve a grant:
requester (a member who manages support access gives access at once), another_person (an admin other than the requester), or data_owner_and_another (the data owner and an admin, two different people). It may only move towards data_owner_and_another.The longest window one grant may cover, from 15 to 10,080 minutes (seven days). It may only go down, or be set where there was no limit. Removing the limit needs the web app.
The custom roles a grant may use, by id from List roles. Replaces the current list. It may only remove roles.
How long a request waits for its approvals before it lapses, from 15 to 10,080 minutes. It may only go down.
Response
Returns200 with the updated policy and what the change did to open access:
revoked_grant_count: the open grants this change revoked.still_open_grant_count: the open grants the new settings no longer allow but Wordsmith could not revoke yet. Wordsmith retries each within minutes. Until then the grant still gives access; revoke it yourself if you need it closed at once.withdrawn_request_count: the open Get support requests the new settings no longer allow, which this change withdrew.requests_still_open:truewhen such a request could not be withdrawn. No engineer can claim it; withdraw it in the web app.