Skip to main content
PATCH
/
v1
/
settings
/
{setting}
cURL
curl --request PATCH \
  --url https://api.example.com/v1/settings/{setting} \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": {
    "stringValue": "<string>",
    "appIm": {
      "settings": [
        {
          "type": "TYPE_UNSPECIFIED",
          "slack": {
            "token": "<string>"
          },
          "feishu": {
            "appId": "<string>",
            "appSecret": "<string>"
          },
          "wecom": {
            "corpId": "<string>",
            "agentId": "<string>",
            "secret": "<string>"
          },
          "lark": {
            "appId": "<string>",
            "appSecret": "<string>"
          },
          "dingtalk": {
            "clientId": "<string>",
            "clientSecret": "<string>",
            "robotCode": "<string>"
          },
          "teams": {
            "tenantId": "<string>",
            "clientId": "<string>",
            "clientSecret": "<string>"
          }
        }
      ]
    },
    "workspaceProfile": {
      "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,
      "brandingLogo": "<string>",
      "watermark": true
    },
    "workspaceApproval": {
      "rules": [
        {
          "template": {
            "flow": {
              "roles": [
                "<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": "<unknown>",
              "field": "<string>",
              "testOnly": true
            },
            "callExpr": {
              "target": "<unknown>",
              "function": "<string>",
              "args": "<array>"
            },
            "listExpr": {
              "elements": "<array>",
              "optionalIndices": [
                123
              ]
            },
            "structExpr": {
              "messageName": "<string>",
              "entries": [
                {
                  "id": "<string>",
                  "fieldKey": "<string>",
                  "mapKey": "<unknown>",
                  "value": "<unknown>",
                  "optionalEntry": true
                }
              ]
            },
            "comprehensionExpr": {
              "iterVar": "<string>",
              "iterVar2": "<string>",
              "iterRange": "<unknown>",
              "accuVar": "<string>",
              "accuInit": "<unknown>",
              "loopCondition": "<unknown>",
              "loopStep": "<unknown>",
              "result": "<unknown>"
            }
          },
          "source": "SOURCE_UNSPECIFIED"
        }
      ]
    },
    "dataClassification": {
      "configs": [
        {
          "id": "<string>",
          "title": "<string>",
          "levels": [
            {
              "id": "<string>",
              "title": "<string>",
              "description": "<string>"
            }
          ],
          "classification": {}
        }
      ]
    },
    "semanticType": {
      "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>"
        }
      ]
    },
    "scim": {
      "token": "<string>"
    },
    "passwordRestriction": {
      "minLength": 123,
      "requireNumber": true,
      "requireLetter": true,
      "requireUppercaseLetter": true,
      "requireSpecialCharacter": true,
      "requireResetPasswordForFirstLogin": true,
      "passwordRotation": "<string>"
    },
    "ai": {
      "enabled": true,
      "provider": "PROVIDER_UNSPECIFIED",
      "endpoint": "<string>",
      "apiKey": "<string>",
      "model": "<string>",
      "version": "<string>"
    },
    "environment": {
      "environments": [
        {
          "id": "<string>",
          "title": "<string>",
          "tags": {},
          "color": "<string>"
        }
      ]
    }
  },
  "name": "<string>"
}
'
{
  "value": {
    "stringValue": "<string>",
    "appIm": {
      "settings": [
        {
          "type": "TYPE_UNSPECIFIED",
          "slack": {},
          "feishu": {},
          "wecom": {},
          "lark": {},
          "dingtalk": {},
          "teams": {}
        }
      ]
    },
    "workspaceProfile": {
      "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,
      "brandingLogo": "<string>",
      "watermark": true
    },
    "workspaceApproval": {
      "rules": [
        {
          "template": {
            "flow": {
              "roles": [
                "<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": "<unknown>",
              "field": "<string>",
              "testOnly": true
            },
            "callExpr": {
              "target": "<unknown>",
              "function": "<string>",
              "args": "<array>"
            },
            "listExpr": {
              "elements": "<array>",
              "optionalIndices": [
                123
              ]
            },
            "structExpr": {
              "messageName": "<string>",
              "entries": [
                {
                  "id": "<string>",
                  "fieldKey": "<string>",
                  "mapKey": "<unknown>",
                  "value": "<unknown>",
                  "optionalEntry": true
                }
              ]
            },
            "comprehensionExpr": {
              "iterVar": "<string>",
              "iterVar2": "<string>",
              "iterRange": "<unknown>",
              "accuVar": "<string>",
              "accuInit": "<unknown>",
              "loopCondition": "<unknown>",
              "loopStep": "<unknown>",
              "result": "<unknown>"
            }
          },
          "source": "SOURCE_UNSPECIFIED"
        }
      ]
    },
    "dataClassification": {
      "configs": [
        {
          "id": "<string>",
          "title": "<string>",
          "levels": [
            {
              "id": "<string>",
              "title": "<string>",
              "description": "<string>"
            }
          ],
          "classification": {}
        }
      ]
    },
    "semanticType": {
      "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>"
        }
      ]
    },
    "scim": {
      "token": "<string>"
    },
    "passwordRestriction": {
      "minLength": 123,
      "requireNumber": true,
      "requireLetter": true,
      "requireUppercaseLetter": true,
      "requireSpecialCharacter": true,
      "requireResetPasswordForFirstLogin": true,
      "passwordRotation": "<string>"
    },
    "ai": {
      "enabled": true,
      "provider": "PROVIDER_UNSPECIFIED",
      "endpoint": "<string>",
      "apiKey": "<string>",
      "model": "<string>",
      "version": "<string>"
    },
    "environment": {
      "environments": [
        {
          "id": "<string>",
          "title": "<string>",
          "tags": {},
          "color": "<string>"
        }
      ]
    }
  },
  "name": "<string>"
}

Path Parameters

setting
string
required

The setting id.

Query Parameters

validateOnly
boolean

validate_only is a flag to indicate whether to validate the setting value, server would not persist the setting value if it is true.

allowMissing
boolean
updateMask
string<field-mask>

Body

application/json

The schema of setting.

value
object
required

The configuration value of the setting.

name
string

The resource name of the setting. Format: settings/{setting} Example: "settings/SEMANTIC_TYPES"

Response

OK

The schema of setting.

value
object
required

The configuration value of the setting.

name
string

The resource name of the setting. Format: settings/{setting} Example: "settings/SEMANTIC_TYPES"