Organizations

Update an organization

put/organizations/{organizationId}

Request

  • Base URL: https://api.xfa.tech
  • URL: https://api.xfa.tech/organizations/{organizationId}
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

ID of Organization

Request body

namestring required

Name of Organization

notify_discovered_devicesboolean

Notify discovered devices

invite_discovered_devicesboolean

Invite discovered devices

default_language'' | 'en' | 'nl' | 'fr' | 'de' | 'es'

Language for end-user emails when the recipient has not picked one; a user's own choice always wins. The set mirrors the email templates shipped by xfa-notification-service. An empty string is the canonical way to clear the organization default, on both PUT and PATCH, so the whole organization can be saved in one request; xfa-organizations-service stores it as an absent attribute.

self_invite_enabledboolean

Allow verified native app users to request self-invite when eligible

exclude_from_customer_metricsboolean

Keeps this organization out of company-wide customer metrics. Set on XFA's own organizations. Only system administrators may change it; an org admin sending the stored value back is accepted.

notify_unsafe_devicesboolean

Notify unsafe devices

slack_enabledboolean

Enable Slack DMs for device risk notifications

slack_notify_unsafe_devicesboolean

Send Slack DMs to users about unsafe devices

slack_notify_discovered_devicesboolean

Send Slack DMs to users about discovered devices

slack_invite_discovered_devicesboolean

Send invitation Slack DMs to users with discovered devices

manual_invite_send_slackboolean

Last-used Slack toggle state in the manual Invite users popup.

teams_notify_unsafe_devicesboolean

Send Teams DMs to users about unsafe devices

teams_notify_discovered_devicesboolean

Send Teams DMs to users about discovered devices

teams_invite_discovered_devicesboolean

Send invitation Teams DMs to users with discovered devices

manual_invite_send_teamsboolean

Last-used Microsoft Teams toggle state in the manual Invite users popup.

use_user_agent_and_client_hintsboolean

Use user-agent and client hints from browser to complete checks

use_discovery_databoolean

Use Discovery data to complete checks

google_chrome_device_trustboolean

Google Chrome device trust

feature_flagsFeatureFlag[]

Feature flags enabled for this organization

tax_numberstring

Tax Number of Organization

phone_numberstring

Phone Number of Organization

getting_started_statestring

JSON blob owned by the dashboard's Getting Started journey; opaque to the backend.

Example request

{
  "feature_flags": [
    "play_protect"
  ]
}

Response

Organization updated

Changes

No recorded changes to this operation across all 1 revision of this API.