GET
/
v1
/
settings
{
  "settings": [
    {
      "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>"
          }
        },
        "agentPluginSettingValue": {
          "url": "<string>",
          "token": "<string>"
        },
        "workspaceProfileSettingValue": {
          "externalUrl": "<string>",
          "disallowSignup": true,
          "require2fa": true,
          "outboundIpList": [
            "<string>"
          ],
          "tokenDuration": "<string>",
          "announcement": {
            "level": "ALERT_LEVEL_UNSPECIFIED",
            "text": "<string>",
            "link": "<string>"
          },
          "maximumRoleExpiration": "<string>",
          "domains": [
            "<string>"
          ],
          "enforceIdentityDomain": true,
          "databaseChangeMode": "DATABASE_CHANGE_MODE_UNSPECIFIED",
          "disallowPasswordSignin": 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": [
                    {}
                  ]
                },
                "listExpr": {
                  "elements": [
                    {}
                  ],
                  "optionalIndices": [
                    123
                  ]
                },
                "structExpr": {
                  "messageName": "<string>",
                  "entries": [
                    {
                      "id": "<string>",
                      "fieldKey": "<string>",
                      "mapKey": {},
                      "value": {},
                      "optionalEntry": true
                    }
                  ]
                },
                "comprehensionExpr": {
                  "iterVar": "<string>",
                  "iterRange": {},
                  "accuVar": "<string>",
                  "accuInit": {},
                  "loopCondition": {},
                  "loopStep": {},
                  "result": {}
                }
              },
              "template": {
                "flow": {
                  "steps": [
                    {
                      "type": "TYPE_UNSPECIFIED",
                      "nodes": [
                        {
                          "type": "TYPE_UNSPECIFIED",
                          "role": "<string>"
                        }
                      ]
                    }
                  ]
                },
                "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": [
                    {}
                  ]
                },
                "listExpr": {
                  "elements": [
                    {}
                  ],
                  "optionalIndices": [
                    123
                  ]
                },
                "structExpr": {
                  "messageName": "<string>",
                  "entries": [
                    {
                      "id": "<string>",
                      "fieldKey": "<string>",
                      "mapKey": {},
                      "value": {},
                      "optionalEntry": true
                    }
                  ]
                },
                "comprehensionExpr": {
                  "iterVar": "<string>",
                  "iterRange": {},
                  "accuVar": "<string>",
                  "accuInit": {},
                  "loopCondition": {},
                  "loopStep": {},
                  "result": {}
                }
              }
            }
          ]
        },
        "schemaTemplateSettingValue": {
          "fieldTemplates": [
            {
              "id": "<string>",
              "engine": "ENGINE_UNSPECIFIED",
              "category": "<string>",
              "column": {
                "name": "<string>",
                "position": 123,
                "hasDefault": true,
                "defaultNull": true,
                "defaultString": "<string>",
                "defaultExpression": "<string>",
                "defaultOnNull": true,
                "onUpdate": "<string>",
                "nullable": true,
                "type": "<string>",
                "characterSet": "<string>",
                "collation": "<string>",
                "comment": "<string>",
                "userComment": "<string>",
                "generation": {
                  "type": "TYPE_UNSPECIFIED",
                  "expression": "<string>"
                },
                "isIdentity": true,
                "identityGeneration": "IDENTITY_GENERATION_UNSPECIFIED",
                "identitySeed": "<string>",
                "identityIncrement": "<string>"
              },
              "catalog": {
                "name": "<string>",
                "semanticType": "<string>",
                "labels": {},
                "classification": "<string>",
                "objectSchema": {
                  "type": "TYPE_UNSPECIFIED",
                  "structKind": {
                    "properties": {}
                  },
                  "arrayKind": {
                    "kind": {}
                  },
                  "semanticType": "<string>"
                }
              }
            }
          ],
          "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,
                    "defaultNull": true,
                    "defaultString": "<string>",
                    "defaultExpression": "<string>",
                    "defaultOnNull": true,
                    "onUpdate": "<string>",
                    "nullable": true,
                    "type": "<string>",
                    "characterSet": "<string>",
                    "collation": "<string>",
                    "comment": "<string>",
                    "userComment": "<string>",
                    "generation": {
                      "type": "TYPE_UNSPECIFIED",
                      "expression": "<string>"
                    },
                    "isIdentity": true,
                    "identityGeneration": "IDENTITY_GENERATION_UNSPECIFIED",
                    "identitySeed": "<string>",
                    "identityIncrement": "<string>"
                  }
                ],
                "indexes": [
                  {
                    "name": "<string>",
                    "expressions": [
                      "<string>"
                    ],
                    "keyLength": [
                      "<string>"
                    ],
                    "descending": [
                      true
                    ],
                    "type": "<string>",
                    "unique": true,
                    "primary": true,
                    "visible": true,
                    "comment": "<string>",
                    "definition": "<string>",
                    "parentIndexSchema": "<string>",
                    "parentIndexName": "<string>",
                    "granularity": "<string>",
                    "isConstraint": true
                  }
                ],
                "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": "<string>",
                        "expressions": [
                          "<string>"
                        ],
                        "keyLength": [
                          "<string>"
                        ],
                        "descending": [
                          true
                        ],
                        "type": "<string>",
                        "unique": true,
                        "primary": true,
                        "visible": true,
                        "comment": "<string>",
                        "definition": "<string>",
                        "parentIndexSchema": "<string>",
                        "parentIndexName": "<string>",
                        "granularity": "<string>",
                        "isConstraint": true
                      }
                    ],
                    "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": {
                        "type": "TYPE_UNSPECIFIED",
                        "structKind": {
                          "properties": {}
                        },
                        "arrayKind": {
                          "kind": {}
                        },
                        "semanticType": "<string>"
                      }
                    }
                  ]
                },
                "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>"
                }
              }
            }
          ]
        },
        "maximumSqlResultSizeSetting": {
          "limit": "<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>"
            }
          ]
        }
      }
    }
  ],
  "nextPageToken": "<string>"
}

Query Parameters

​
pageSize
integer

Not used. The maximum number of settings to return. The service may return fewer than this value. If unspecified, at most 10 settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

Not used. A page token, received from a previous ListSettings call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSettings must match the call that provided the page token.

Response

200
application/json

OK

The response is of type object.