Path Parameters
The setting id.
Query Parameters
validate_only is a flag to indicate whether to validate the setting value, server would not persist the setting value if it is true.
Body
application/json
{ "name": "<string>", "value": { "stringValue": "<string>", "appImSettingValue": { "slack": { "enabled": true, "token": "<string>" }, "feishu": { "enabled": true, "appId": "<string>", "appSecret": "<string>" }, "wecom": { "enabled": true, "corpId": "<string>", "agentId": "<string>", "secret": "<string>" }, "lark": { "enabled": true, "appId": "<string>", "appSecret": "<string>" }, "dingtalk": { "enabled": true, "clientId": "<string>", "clientSecret": "<string>", "robotCode": "<string>" } }, "workspaceProfileSettingValue": { "externalUrl": "<string>", "disallowSignup": true, "require2fa": true, "tokenDuration": "<string>", "announcement": { "level": "ALERT_LEVEL_UNSPECIFIED", "text": "<string>", "link": "<string>" }, "maximumRoleExpiration": "<string>", "domains": [ "<string>" ], "enforceIdentityDomain": true, "databaseChangeMode": "DATABASE_CHANGE_MODE_UNSPECIFIED", "disallowPasswordSignin": true, "enableMetricCollection": true }, "workspaceApprovalSettingValue": { "rules": [ { "expression": { "id": "<string>", "constExpr": { "nullValue": "NULL_VALUE", "boolValue": true, "int64Value": "<string>", "uint64Value": "<string>", "doubleValue": 123, "stringValue": "<string>", "bytesValue": "<string>", "durationValue": "<string>", "timestampValue": "2023-11-07T05:31:56Z" }, "identExpr": { "name": "<string>" }, "selectExpr": { "operand": {}, "field": "<string>", "testOnly": true }, "callExpr": { "target": {}, "function": "<string>", "args": [ "<any>" ] }, "listExpr": { "elements": [ "<any>" ], "optionalIndices": [ "<any>" ] }, "structExpr": { "messageName": "<string>", "entries": [ "<any>" ] }, "comprehensionExpr": { "iterVar": "<string>", "iterVar2": "<string>", "iterRange": {}, "accuVar": "<string>", "accuInit": {}, "loopCondition": {}, "loopStep": {}, "result": {} } }, "template": { "flow": { "steps": [ { "type": "TYPE_UNSPECIFIED", "nodes": [ {} ] } ] }, "title": "<string>", "description": "<string>" }, "condition": { "id": "<string>", "constExpr": { "nullValue": "NULL_VALUE", "boolValue": true, "int64Value": "<string>", "uint64Value": "<string>", "doubleValue": 123, "stringValue": "<string>", "bytesValue": "<string>", "durationValue": "<string>", "timestampValue": "2023-11-07T05:31:56Z" }, "identExpr": { "name": "<string>" }, "selectExpr": { "operand": {}, "field": "<string>", "testOnly": true }, "callExpr": { "target": {}, "function": "<string>", "args": [ "<any>" ] }, "listExpr": { "elements": [ "<any>" ], "optionalIndices": [ "<any>" ] }, "structExpr": { "messageName": "<string>", "entries": [ "<any>" ] }, "comprehensionExpr": { "iterVar": "<string>", "iterVar2": "<string>", "iterRange": {}, "accuVar": "<string>", "accuInit": {}, "loopCondition": {}, "loopStep": {}, "result": {} } } } ] }, "schemaTemplateSettingValue": { "fieldTemplates": [ { "id": "<string>", "engine": "ENGINE_UNSPECIFIED", "category": "<string>", "column": { "name": "<string>", "position": 123, "hasDefault": true, "default": "<string>", "defaultOnNull": true, "onUpdate": "<string>", "nullable": true, "type": "<string>", "characterSet": "<string>", "collation": "<string>", "comment": "<string>", "userComment": "<string>", "generation": { "type": "<any>", "expression": "<any>" }, "isIdentity": true, "identityGeneration": "IDENTITY_GENERATION_UNSPECIFIED", "identitySeed": "<string>", "identityIncrement": "<string>", "defaultConstraintName": "<string>" }, "catalog": { "name": "<string>", "semanticType": "<string>", "labels": {}, "classification": "<string>", "objectSchema": {} } } ], "columnTypes": [ { "engine": "ENGINE_UNSPECIFIED", "enabled": true, "types": [ "<string>" ] } ], "tableTemplates": [ { "id": "<string>", "engine": "ENGINE_UNSPECIFIED", "category": "<string>", "table": { "name": "<string>", "columns": [ { "name": "<string>", "position": 123, "hasDefault": true, "default": "<string>", "defaultOnNull": true, "onUpdate": "<string>", "nullable": true, "type": "<string>", "characterSet": "<string>", "collation": "<string>", "comment": "<string>", "userComment": "<string>", "generation": { "type": "<any>", "expression": "<any>" }, "isIdentity": true, "identityGeneration": "IDENTITY_GENERATION_UNSPECIFIED", "identitySeed": "<string>", "identityIncrement": "<string>", "defaultConstraintName": "<string>" } ], "indexes": [ { "name": "<any>", "expressions": "<any>", "keyLength": "<any>", "descending": "<any>", "type": "<any>", "unique": "<any>", "primary": "<any>", "visible": "<any>", "comment": "<any>", "definition": "<any>", "parentIndexSchema": "<any>", "parentIndexName": "<any>", "granularity": "<any>", "isConstraint": "<any>", "spatialConfig": "<any>", "opclassNames": "<any>", "opclassDefaults": "<any>" } ], "engine": "<string>", "collation": "<string>", "charset": "<string>", "rowCount": "<string>", "dataSize": "<string>", "indexSize": "<string>", "dataFree": "<string>", "createOptions": "<string>", "comment": "<string>", "userComment": "<string>", "foreignKeys": [ { "name": "<string>", "columns": [ "<string>" ], "referencedSchema": "<string>", "referencedTable": "<string>", "referencedColumns": [ "<string>" ], "onDelete": "<string>", "onUpdate": "<string>", "matchType": "<string>" } ], "partitions": [ { "name": "<string>", "type": "TYPE_UNSPECIFIED", "expression": "<string>", "value": "<string>", "useDefault": "<string>", "subpartitions": [ {} ], "indexes": [ { "name": "<any>", "expressions": "<any>", "keyLength": "<any>", "descending": "<any>", "type": "<any>", "unique": "<any>", "primary": "<any>", "visible": "<any>", "comment": "<any>", "definition": "<any>", "parentIndexSchema": "<any>", "parentIndexName": "<any>", "granularity": "<any>", "isConstraint": "<any>", "spatialConfig": "<any>", "opclassNames": "<any>", "opclassDefaults": "<any>" } ], "checkConstraints": [ { "name": "<string>", "expression": "<string>" } ] } ], "checkConstraints": [ { "name": "<string>", "expression": "<string>" } ], "owner": "<string>", "sortingKeys": [ "<string>" ], "triggers": [ { "name": "<string>", "event": "<string>", "timing": "<string>", "body": "<string>", "sqlMode": "<string>", "characterSetClient": "<string>", "collationConnection": "<string>", "comment": "<string>", "skipDump": true } ], "skipDump": true, "shardingInfo": "<string>", "primaryKeyType": "<string>" }, "catalog": { "name": "<string>", "columns": { "columns": [ { "name": "<string>", "semanticType": "<string>", "labels": {}, "classification": "<string>", "objectSchema": {} } ] }, "objectSchema": { "type": "TYPE_UNSPECIFIED", "structKind": { "properties": {} }, "arrayKind": { "kind": {} }, "semanticType": "<string>" }, "classification": "<string>" } } ] }, "dataClassificationSettingValue": { "configs": [ { "id": "<string>", "title": "<string>", "levels": [ { "id": "<string>", "title": "<string>", "description": "<string>" } ], "classification": {}, "classificationFromConfig": true } ] }, "semanticTypeSettingValue": { "types": [ { "id": "<string>", "title": "<string>", "description": "<string>", "algorithm": { "fullMask": { "substitution": "<string>" }, "rangeMask": { "slices": [ { "start": 123, "end": 123, "substitution": "<string>" } ] }, "md5Mask": { "salt": "<string>" }, "innerOuterMask": { "prefixLen": 123, "suffixLen": 123, "type": "MASK_TYPE_UNSPECIFIED", "substitution": "<string>" } }, "icon": "<string>" } ] }, "scimSetting": { "token": "<string>" }, "passwordRestrictionSetting": { "minLength": 123, "requireNumber": true, "requireLetter": true, "requireUppercaseLetter": true, "requireSpecialCharacter": true, "requireResetPasswordForFirstLogin": true, "passwordRotation": "<string>" }, "aiSetting": { "enabled": true, "provider": "PROVIDER_UNSPECIFIED", "endpoint": "<string>", "apiKey": "<string>", "model": "<string>", "version": "<string>" }, "environmentSetting": { "environments": [ { "id": "<string>", "title": "<string>", "tags": {}, "color": "<string>" } ] } } }
Permissions required: bb.settings.set
{ "name": "<string>", "value": { "stringValue": "<string>", "appImSettingValue": { "slack": { "enabled": true, "token": "<string>" }, "feishu": { "enabled": true, "appId": "<string>", "appSecret": "<string>" }, "wecom": { "enabled": true, "corpId": "<string>", "agentId": "<string>", "secret": "<string>" }, "lark": { "enabled": true, "appId": "<string>", "appSecret": "<string>" }, "dingtalk": { "enabled": true, "clientId": "<string>", "clientSecret": "<string>", "robotCode": "<string>" } }, "workspaceProfileSettingValue": { "externalUrl": "<string>", "disallowSignup": true, "require2fa": true, "tokenDuration": "<string>", "announcement": { "level": "ALERT_LEVEL_UNSPECIFIED", "text": "<string>", "link": "<string>" }, "maximumRoleExpiration": "<string>", "domains": [ "<string>" ], "enforceIdentityDomain": true, "databaseChangeMode": "DATABASE_CHANGE_MODE_UNSPECIFIED", "disallowPasswordSignin": true, "enableMetricCollection": true }, "workspaceApprovalSettingValue": { "rules": [ { "expression": { "id": "<string>", "constExpr": { "nullValue": "NULL_VALUE", "boolValue": true, "int64Value": "<string>", "uint64Value": "<string>", "doubleValue": 123, "stringValue": "<string>", "bytesValue": "<string>", "durationValue": "<string>", "timestampValue": "2023-11-07T05:31:56Z" }, "identExpr": { "name": "<string>" }, "selectExpr": { "operand": {}, "field": "<string>", "testOnly": true }, "callExpr": { "target": {}, "function": "<string>", "args": [ "<any>" ] }, "listExpr": { "elements": [ "<any>" ], "optionalIndices": [ "<any>" ] }, "structExpr": { "messageName": "<string>", "entries": [ "<any>" ] }, "comprehensionExpr": { "iterVar": "<string>", "iterVar2": "<string>", "iterRange": {}, "accuVar": "<string>", "accuInit": {}, "loopCondition": {}, "loopStep": {}, "result": {} } }, "template": { "flow": { "steps": [ { "type": "TYPE_UNSPECIFIED", "nodes": [ {} ] } ] }, "title": "<string>", "description": "<string>" }, "condition": { "id": "<string>", "constExpr": { "nullValue": "NULL_VALUE", "boolValue": true, "int64Value": "<string>", "uint64Value": "<string>", "doubleValue": 123, "stringValue": "<string>", "bytesValue": "<string>", "durationValue": "<string>", "timestampValue": "2023-11-07T05:31:56Z" }, "identExpr": { "name": "<string>" }, "selectExpr": { "operand": {}, "field": "<string>", "testOnly": true }, "callExpr": { "target": {}, "function": "<string>", "args": [ "<any>" ] }, "listExpr": { "elements": [ "<any>" ], "optionalIndices": [ "<any>" ] }, "structExpr": { "messageName": "<string>", "entries": [ "<any>" ] }, "comprehensionExpr": { "iterVar": "<string>", "iterVar2": "<string>", "iterRange": {}, "accuVar": "<string>", "accuInit": {}, "loopCondition": {}, "loopStep": {}, "result": {} } } } ] }, "schemaTemplateSettingValue": { "fieldTemplates": [ { "id": "<string>", "engine": "ENGINE_UNSPECIFIED", "category": "<string>", "column": { "name": "<string>", "position": 123, "hasDefault": true, "default": "<string>", "defaultOnNull": true, "onUpdate": "<string>", "nullable": true, "type": "<string>", "characterSet": "<string>", "collation": "<string>", "comment": "<string>", "userComment": "<string>", "generation": { "type": "<any>", "expression": "<any>" }, "isIdentity": true, "identityGeneration": "IDENTITY_GENERATION_UNSPECIFIED", "identitySeed": "<string>", "identityIncrement": "<string>", "defaultConstraintName": "<string>" }, "catalog": { "name": "<string>", "semanticType": "<string>", "labels": {}, "classification": "<string>", "objectSchema": {} } } ], "columnTypes": [ { "engine": "ENGINE_UNSPECIFIED", "enabled": true, "types": [ "<string>" ] } ], "tableTemplates": [ { "id": "<string>", "engine": "ENGINE_UNSPECIFIED", "category": "<string>", "table": { "name": "<string>", "columns": [ { "name": "<string>", "position": 123, "hasDefault": true, "default": "<string>", "defaultOnNull": true, "onUpdate": "<string>", "nullable": true, "type": "<string>", "characterSet": "<string>", "collation": "<string>", "comment": "<string>", "userComment": "<string>", "generation": { "type": "<any>", "expression": "<any>" }, "isIdentity": true, "identityGeneration": "IDENTITY_GENERATION_UNSPECIFIED", "identitySeed": "<string>", "identityIncrement": "<string>", "defaultConstraintName": "<string>" } ], "indexes": [ { "name": "<any>", "expressions": "<any>", "keyLength": "<any>", "descending": "<any>", "type": "<any>", "unique": "<any>", "primary": "<any>", "visible": "<any>", "comment": "<any>", "definition": "<any>", "parentIndexSchema": "<any>", "parentIndexName": "<any>", "granularity": "<any>", "isConstraint": "<any>", "spatialConfig": "<any>", "opclassNames": "<any>", "opclassDefaults": "<any>" } ], "engine": "<string>", "collation": "<string>", "charset": "<string>", "rowCount": "<string>", "dataSize": "<string>", "indexSize": "<string>", "dataFree": "<string>", "createOptions": "<string>", "comment": "<string>", "userComment": "<string>", "foreignKeys": [ { "name": "<string>", "columns": [ "<string>" ], "referencedSchema": "<string>", "referencedTable": "<string>", "referencedColumns": [ "<string>" ], "onDelete": "<string>", "onUpdate": "<string>", "matchType": "<string>" } ], "partitions": [ { "name": "<string>", "type": "TYPE_UNSPECIFIED", "expression": "<string>", "value": "<string>", "useDefault": "<string>", "subpartitions": [ {} ], "indexes": [ { "name": "<any>", "expressions": "<any>", "keyLength": "<any>", "descending": "<any>", "type": "<any>", "unique": "<any>", "primary": "<any>", "visible": "<any>", "comment": "<any>", "definition": "<any>", "parentIndexSchema": "<any>", "parentIndexName": "<any>", "granularity": "<any>", "isConstraint": "<any>", "spatialConfig": "<any>", "opclassNames": "<any>", "opclassDefaults": "<any>" } ], "checkConstraints": [ { "name": "<string>", "expression": "<string>" } ] } ], "checkConstraints": [ { "name": "<string>", "expression": "<string>" } ], "owner": "<string>", "sortingKeys": [ "<string>" ], "triggers": [ { "name": "<string>", "event": "<string>", "timing": "<string>", "body": "<string>", "sqlMode": "<string>", "characterSetClient": "<string>", "collationConnection": "<string>", "comment": "<string>", "skipDump": true } ], "skipDump": true, "shardingInfo": "<string>", "primaryKeyType": "<string>" }, "catalog": { "name": "<string>", "columns": { "columns": [ { "name": "<string>", "semanticType": "<string>", "labels": {}, "classification": "<string>", "objectSchema": {} } ] }, "objectSchema": { "type": "TYPE_UNSPECIFIED", "structKind": { "properties": {} }, "arrayKind": { "kind": {} }, "semanticType": "<string>" }, "classification": "<string>" } } ] }, "dataClassificationSettingValue": { "configs": [ { "id": "<string>", "title": "<string>", "levels": [ { "id": "<string>", "title": "<string>", "description": "<string>" } ], "classification": {}, "classificationFromConfig": true } ] }, "semanticTypeSettingValue": { "types": [ { "id": "<string>", "title": "<string>", "description": "<string>", "algorithm": { "fullMask": { "substitution": "<string>" }, "rangeMask": { "slices": [ { "start": 123, "end": 123, "substitution": "<string>" } ] }, "md5Mask": { "salt": "<string>" }, "innerOuterMask": { "prefixLen": 123, "suffixLen": 123, "type": "MASK_TYPE_UNSPECIFIED", "substitution": "<string>" } }, "icon": "<string>" } ] }, "scimSetting": { "token": "<string>" }, "passwordRestrictionSetting": { "minLength": 123, "requireNumber": true, "requireLetter": true, "requireUppercaseLetter": true, "requireSpecialCharacter": true, "requireResetPasswordForFirstLogin": true, "passwordRotation": "<string>" }, "aiSetting": { "enabled": true, "provider": "PROVIDER_UNSPECIFIED", "endpoint": "<string>", "apiKey": "<string>", "model": "<string>", "version": "<string>" }, "environmentSetting": { "environments": [ { "id": "<string>", "title": "<string>", "tags": {}, "color": "<string>" } ] } } }
The setting id.
validate_only is a flag to indicate whether to validate the setting value, server would not persist the setting value if it is true.
Was this page helpful?