latestOpenAPI 3.0.02026-08-0819201.1 MB
411f9f98c01e
tenants
Update the Tenant based on the specified Tenant Id
You need tenants.tenant.edit permission to access this resource
patch/tenants/{tenant_id}
Path parameters
tenant_idstring required
Tenant identifier
Request body
Example request
{
"data": {
"attributes": {
"name": "My New Tenant",
"app_domain": "app.example.com",
"api_domain": "api.example.com",
"webhooks_domain": "in.example.com",
"api_docs_url": "api.example.com/docs/v2/'",
"git_receiver_host": "git.example.com",
"code": "mail_style",
"header_logo_url": "//cdn.example.com/logo-header.png",
"loading_logo_url": "//cdn.example.com/logo-loading.png",
"email_logo_url": "//cdn.example.com/logo-email.png",
"favicon_url": "//cdn.example.com/logo-favicon.png",
"terms_of_usage_url": "https://www.example.com/tou/",
"privacy_policy_url": "https://www.example.com/privacy-policy/",
"imprint_url": "https://www.example.com/legal-disclosure/",
"mandrill_email_from": "foo@foo.bar",
"mandrill_api_key": "lEJsMG0Kpj8b00mEIp1de",
"segment_write_key": "Qtg2Y2i61KpjOSCYFUc9VLJH5UegUZDP",
"google_tag_manager_id": "5b4f337bff4304610483ba67",
"hide_register": true,
"is_default": true,
"powered_by_elasticio": true,
"docs_base_url": "https://docs.example.com/",
"component_docs_base_url": "https://docs.example.com/components/",
"ssl_certificates": {
"app": "5b4f337bff4304610483ba67",
"api": "5b4f337bff4304610483ba67",
"webhooks": "5b4f337bff4304610483ba67"
},
"email_templates": {
"agent-request": true,
"contract-deleted": true,
"contract-invite-empty-contract": true,
"contract-invite-new-user": true,
"contract-suspended": true,
"contract-unsuspended": true,
"password-recovery": true,
"task-error-notification": true,
"task-operational-error": true,
"team-from-contract-invite": true,
"team-removed-member": true,
"user-removed-from-contract": true,
"wiper-exhaustion-quota-notification": true,
"wiper-flow-suspended-due-to-queue-overflow": true,
"wiper-stop-limited-flow": true,
"wiper-suspended-queue-purged": true,
"workspace-invite-empty-workspace": true,
"workspace-invite-new-user": true,
"workspace-removed": true,
"workspace-removed-member": true
},
"suppress_email": [
"repo-new-version",
"repo-new-version-in-workspace-flows"
],
"custom_nav_menu_items": [
{
"title": "Quick Help",
"icon": "help",
"custom_class": "custom_class",
"links": [
{
"url": "https://docs.example.com",
"title": "Documentation",
"icon": "description",
"target": "_blank"
}
]
}
],
"custom_stylesheets": [
{
"href": "http://path-to.css"
}
],
"custom_scripts": [
{
"src": "http://path-to-2.js",
"location": "head"
}
],
"email_domains_blacklist": [
"[\"yahoo.*\",\"hotmail.com\"]\n"
],
"feature_flags": {
"contract_component_whitelist": true,
"enabled_totp": true,
"forced_totp": true,
"email_verification": true,
"sensitive_actions_reauth": true,
"subscribe_to_error_by_default": true,
"shut_down_timeout_enabled": true,
"skip_session_ip_validation": true
},
"signin_v_2": {
"logo_url": "//cdn.example.com/logo.png",
"google_provider_id": "5b4f337bff4304610483ba67"
},
"login_redirect_sso_provider": {
"type": "openid",
"id": "5b4f337bff4304610483ba67"
},
"api_docs_config": {
"top_bar_background_color": "red",
"custom_css_url": "http://host.com/custom.css",
"theme": "outline"
},
"logout_redirect_url": "https://sso.example.com/logout",
"flow_stats_enabled_default": true,
"support_user_id": "5b4f337bff4304610483ba67",
"default_workspace_type": "full",
"ingress_config": {
"annotations": {
"app": {
"nginx/123": "123",
"nginx/456": "456"
},
"api": {
"nginx/123": "123",
"nginx/456": "456"
},
"webhooks": {
"nginx/mtls": "true",
"nginx/456": "456"
},
"apidocs": {
"nginx/mtls": "true",
"nginx/456": "456"
}
}
},
"html_meta": {
"keywords": [
"iPaaS"
],
"description": "Some description",
"author": "John Doe"
}
}
}
}Response
OK
Example response
{
"data": {
"id": "5b4f337bff4304610483ba67",
"links": {
"self": "/v2/tenants/5b4f337bff4304610483ba67"
},
"attributes": {
"name": "My New Tenant",
"app_domain": "app.example.com",
"api_domain": "api.example.com",
"webhooks_domain": "in.example.com",
"api_docs_url": "api.example.com/docs/v2/'",
"git_receiver_host": "git.example.com",
"code": "mail_style",
"header_logo_url": "//cdn.example.com/logo-header.png",
"loading_logo_url": "//cdn.example.com/logo-loading.png",
"email_logo_url": "//cdn.example.com/logo-email.png",
"favicon_url": "//cdn.example.com/logo-favicon.png",
"terms_of_usage_url": "https://www.example.com/tou/",
"privacy_policy_url": "https://www.example.com/privacy-policy/",
"imprint_url": "https://www.example.com/legal-disclosure/",
"mandrill_email_from": "foo@foo.bar",
"mandrill_api_key": "lEJsMG0Kpj8b00mEIp1de",
"segment_write_key": "Qtg2Y2i61KpjOSCYFUc9VLJH5UegUZDP",
"google_tag_manager_id": "5b4f337bff4304610483ba67",
"hide_register": true,
"is_default": true,
"powered_by_elasticio": true,
"docs_base_url": "https://docs.example.com/",
"component_docs_base_url": "https://docs.example.com/components/",
"ssl_certificates": {
"app": "5b4f337bff4304610483ba67",
"api": "5b4f337bff4304610483ba67",
"webhooks": "5b4f337bff4304610483ba67"
},
"email_templates": {
"agent-request": true,
"contract-deleted": true,
"contract-invite-empty-contract": true,
"contract-invite-new-user": true,
"contract-suspended": true,
"contract-unsuspended": true,
"password-recovery": true,
"task-error-notification": true,
"task-operational-error": true,
"team-from-contract-invite": true,
"team-removed-member": true,
"user-removed-from-contract": true,
"wiper-exhaustion-quota-notification": true,
"wiper-flow-suspended-due-to-queue-overflow": true,
"wiper-stop-limited-flow": true,
"wiper-suspended-queue-purged": true,
"workspace-invite-empty-workspace": true,
"workspace-invite-new-user": true,
"workspace-removed": true,
"workspace-removed-member": true
},
"suppress_email": [
"repo-new-version",
"repo-new-version-in-workspace-flows"
],
"custom_nav_menu_items": [
{
"title": "Quick Help",
"icon": "help",
"custom_class": "custom_class",
"links": [
{
"url": "https://docs.example.com",
"title": "Documentation",
"icon": "description",
"target": "_blank"
}
]
}
],
"custom_stylesheets": [
{
"href": "http://path-to.css"
}
],
"custom_scripts": [
{
"src": "http://path-to-2.js",
"location": "head"
}
],
"email_domains_blacklist": [
"[\"yahoo.*\",\"hotmail.com\"]\n"
],
"feature_flags": {
"contract_component_whitelist": true,
"enabled_totp": true,
"forced_totp": true,
"email_verification": true,
"sensitive_actions_reauth": true,
"subscribe_to_error_by_default": true,
"shut_down_timeout_enabled": true,
"skip_session_ip_validation": true
},
"signin_v_2": {
"logo_url": "//cdn.example.com/logo.png",
"google_provider_id": "5b4f337bff4304610483ba67"
},
"login_redirect_sso_provider": {
"type": "openid",
"id": "5b4f337bff4304610483ba67"
},
"api_docs_config": {
"top_bar_background_color": "red",
"custom_css_url": "http://host.com/custom.css",
"theme": "outline"
},
"logout_redirect_url": "https://sso.example.com/logout",
"flow_stats_enabled_default": true,
"support_user_id": "5b4f337bff4304610483ba67",
"default_workspace_type": "full",
"ingress_config": {
"annotations": {
"app": {
"nginx/123": "123",
"nginx/456": "456"
},
"api": {
"nginx/123": "123",
"nginx/456": "456"
},
"webhooks": {
"nginx/mtls": "true",
"nginx/456": "456"
},
"apidocs": {
"nginx/mtls": "true",
"nginx/456": "456"
}
}
},
"html_meta": {
"keywords": [
"iPaaS"
],
"description": "Some description",
"author": "John Doe"
}
}
}
}