Response
OK
The settings from the specified request.
{
"settings": [
{
"name": "<string>",
"value": {
"stringValue": "<string>",
"appImSettingValue": {
"settings": [
{
"type": "TYPE_UNSPECIFIED",
"slack": {},
"feishu": {},
"wecom": {},
"lark": {},
"dingtalk": {}
}
]
},
"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,
"inactiveSessionTimeout": "<string>",
"enableAuditLogStdout": true
},
"workspaceApprovalSettingValue": {
"rules": [
{
"template": {
"id": "<string>",
"flow": {
"roles": [
"<any>"
]
},
"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": "<any>",
"field": "<string>",
"testOnly": true
},
"callExpr": {
"target": "<any>",
"function": "<string>",
"args": [
"<any>"
]
},
"listExpr": {
"elements": [
"<any>"
],
"optionalIndices": [
"<any>"
]
},
"structExpr": {
"messageName": "<string>",
"entries": [
"<any>"
]
},
"comprehensionExpr": {
"iterVar": "<string>",
"iterVar2": "<string>",
"iterRange": "<any>",
"accuVar": "<string>",
"accuInit": "<any>",
"loopCondition": "<any>",
"loopStep": "<any>",
"result": "<any>"
}
}
}
]
},
"schemaTemplateSettingValue": {
"fieldTemplates": [
{
"id": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"category": "<string>",
"column": {
"name": "<any>",
"position": "<any>",
"hasDefault": "<any>",
"default": "<any>",
"defaultOnNull": "<any>",
"onUpdate": "<any>",
"nullable": "<any>",
"type": "<any>",
"characterSet": "<any>",
"collation": "<any>",
"comment": "<any>",
"userComment": "<any>",
"generation": "<any>",
"isIdentity": "<any>",
"identityGeneration": "<any>",
"identitySeed": "<any>",
"identityIncrement": "<any>",
"defaultConstraintName": "<any>"
},
"catalog": {
"name": "<string>",
"semanticType": "<string>",
"labels": {},
"classification": "<string>",
"objectSchema": {
"type": "TYPE_UNSPECIFIED",
"structKind": "<any>",
"arrayKind": "<any>",
"semanticType": "<string>"
}
}
}
],
"columnTypes": [
{
"engine": "ENGINE_UNSPECIFIED",
"enabled": true,
"types": [
"<string>"
]
}
],
"tableTemplates": [
{
"id": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"category": "<string>",
"table": {
"name": "<string>",
"columns": [
{
"name": "<any>",
"position": "<any>",
"hasDefault": "<any>",
"default": "<any>",
"defaultOnNull": "<any>",
"onUpdate": "<any>",
"nullable": "<any>",
"type": "<any>",
"characterSet": "<any>",
"collation": "<any>",
"comment": "<any>",
"userComment": "<any>",
"generation": "<any>",
"isIdentity": "<any>",
"identityGeneration": "<any>",
"identitySeed": "<any>",
"identityIncrement": "<any>",
"defaultConstraintName": "<any>"
}
],
"indexes": [
{
"name": "<string>",
"expressions": [
"<any>"
],
"keyLength": [
"<any>"
],
"descending": [
"<any>"
],
"type": "<string>",
"unique": true,
"primary": true,
"visible": true,
"comment": "<string>",
"definition": "<string>",
"parentIndexSchema": "<string>",
"parentIndexName": "<string>",
"granularity": "<string>",
"isConstraint": true,
"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": [
"<any>"
],
"referencedSchema": "<string>",
"referencedTable": "<string>",
"referencedColumns": [
"<any>"
],
"onDelete": "<string>",
"onUpdate": "<string>",
"matchType": "<string>"
}
],
"partitions": [
{
"name": "<string>",
"type": "TYPE_UNSPECIFIED",
"expression": "<string>",
"value": "<string>",
"useDefault": "<string>",
"subpartitions": [
"<any>"
],
"indexes": [
"<any>"
],
"checkConstraints": [
"<any>"
]
}
],
"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": [
"<any>"
]
},
"objectSchema": {
"type": "<any>",
"structKind": "<any>",
"arrayKind": "<any>",
"semanticType": "<any>"
},
"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": [
{}
]
},
"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>"
}
]
}
}
}
]
}Lists all workspace settings. Permissions required: bb.settings.list
{
"settings": [
{
"name": "<string>",
"value": {
"stringValue": "<string>",
"appImSettingValue": {
"settings": [
{
"type": "TYPE_UNSPECIFIED",
"slack": {},
"feishu": {},
"wecom": {},
"lark": {},
"dingtalk": {}
}
]
},
"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,
"inactiveSessionTimeout": "<string>",
"enableAuditLogStdout": true
},
"workspaceApprovalSettingValue": {
"rules": [
{
"template": {
"id": "<string>",
"flow": {
"roles": [
"<any>"
]
},
"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": "<any>",
"field": "<string>",
"testOnly": true
},
"callExpr": {
"target": "<any>",
"function": "<string>",
"args": [
"<any>"
]
},
"listExpr": {
"elements": [
"<any>"
],
"optionalIndices": [
"<any>"
]
},
"structExpr": {
"messageName": "<string>",
"entries": [
"<any>"
]
},
"comprehensionExpr": {
"iterVar": "<string>",
"iterVar2": "<string>",
"iterRange": "<any>",
"accuVar": "<string>",
"accuInit": "<any>",
"loopCondition": "<any>",
"loopStep": "<any>",
"result": "<any>"
}
}
}
]
},
"schemaTemplateSettingValue": {
"fieldTemplates": [
{
"id": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"category": "<string>",
"column": {
"name": "<any>",
"position": "<any>",
"hasDefault": "<any>",
"default": "<any>",
"defaultOnNull": "<any>",
"onUpdate": "<any>",
"nullable": "<any>",
"type": "<any>",
"characterSet": "<any>",
"collation": "<any>",
"comment": "<any>",
"userComment": "<any>",
"generation": "<any>",
"isIdentity": "<any>",
"identityGeneration": "<any>",
"identitySeed": "<any>",
"identityIncrement": "<any>",
"defaultConstraintName": "<any>"
},
"catalog": {
"name": "<string>",
"semanticType": "<string>",
"labels": {},
"classification": "<string>",
"objectSchema": {
"type": "TYPE_UNSPECIFIED",
"structKind": "<any>",
"arrayKind": "<any>",
"semanticType": "<string>"
}
}
}
],
"columnTypes": [
{
"engine": "ENGINE_UNSPECIFIED",
"enabled": true,
"types": [
"<string>"
]
}
],
"tableTemplates": [
{
"id": "<string>",
"engine": "ENGINE_UNSPECIFIED",
"category": "<string>",
"table": {
"name": "<string>",
"columns": [
{
"name": "<any>",
"position": "<any>",
"hasDefault": "<any>",
"default": "<any>",
"defaultOnNull": "<any>",
"onUpdate": "<any>",
"nullable": "<any>",
"type": "<any>",
"characterSet": "<any>",
"collation": "<any>",
"comment": "<any>",
"userComment": "<any>",
"generation": "<any>",
"isIdentity": "<any>",
"identityGeneration": "<any>",
"identitySeed": "<any>",
"identityIncrement": "<any>",
"defaultConstraintName": "<any>"
}
],
"indexes": [
{
"name": "<string>",
"expressions": [
"<any>"
],
"keyLength": [
"<any>"
],
"descending": [
"<any>"
],
"type": "<string>",
"unique": true,
"primary": true,
"visible": true,
"comment": "<string>",
"definition": "<string>",
"parentIndexSchema": "<string>",
"parentIndexName": "<string>",
"granularity": "<string>",
"isConstraint": true,
"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": [
"<any>"
],
"referencedSchema": "<string>",
"referencedTable": "<string>",
"referencedColumns": [
"<any>"
],
"onDelete": "<string>",
"onUpdate": "<string>",
"matchType": "<string>"
}
],
"partitions": [
{
"name": "<string>",
"type": "TYPE_UNSPECIFIED",
"expression": "<string>",
"value": "<string>",
"useDefault": "<string>",
"subpartitions": [
"<any>"
],
"indexes": [
"<any>"
],
"checkConstraints": [
"<any>"
]
}
],
"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": [
"<any>"
]
},
"objectSchema": {
"type": "<any>",
"structKind": "<any>",
"arrayKind": "<any>",
"semanticType": "<any>"
},
"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": [
{}
]
},
"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>"
}
]
}
}
}
]
}OK
The settings from the specified request.
Show child attributes
Was this page helpful?