Workspace Settings API
Manage default access, AI opt-out, and defaults for newly available connectors.
Manage default access, AI opt-out, and defaults for newly available connectors.
Authentication
Admin permissions are required for writes and for reading AI settings. Reading default access and connector settings requires authenticated access. Set GC_API_KEY to an API key with the required permissions and GC_BACKEND_ID to the backend ID. Every example sends both headers. For self-hosted deployments, replace https://api.groundcover.com with your API URL.
Default access
GET / PUT /api/rbac/v2/tenant/settings
GET requires authenticated access. PUT requires Admin permissions.
GET returns the current defaultRole and defaultPolicyUUID. PUT requires at least one. A nonempty defaultPolicyUUID takes precedence over defaultRole and must reference an existing policy. Valid role names are read, write, and admin.
curl --request GET \
--url "https://api.groundcover.com/api/rbac/v2/tenant/settings" \
--header "Authorization: Bearer $GC_API_KEY" \
--header "X-Backend-Id: $GC_BACKEND_ID"curl --request PUT \
--url "https://api.groundcover.com/api/rbac/v2/tenant/settings" \
--header "Authorization: Bearer $GC_API_KEY" \
--header "X-Backend-Id: $GC_BACKEND_ID" \
--header "Content-Type: application/json" \
--data '{
"defaultPolicyUUID": "<POLICY_UUID>"
}'A successful update returns HTTP 200 with the stored settings record. Re-read with GET for the effective default access configuration.
AI settings
GET / PUT /api/rbac/v2/tenant/ai-settings
Both operations require Admin permissions and an explicit backend ID. PUT accepts the required boolean customerAIFeaturesOptOut. Setting it to true opts the backend out; setting it to false removes the customer opt-out but does not override deployment-level availability.
Both return HTTP 200 with backendName, customerAIFeaturesOptOut, allowAIFeatures, and effectiveAIFeaturesEnabled. The effective field reflects all applicable gates. A missing backend ID or missing boolean returns 400.
Defaults for new connectors
GET / PUT /api/rbac/v2/tenant/connector-settings
GET requires authenticated access. PUT requires Admin permissions.
PUT requires the boolean newConnectorsEnabledByDefault. The response is HTTP 200 with that field. This setting applies when connectors first appear on a backend; it does not enable or disable existing connectors.
Last updated
