Semaphor

Update a definition

Updates a definition's name or security configuration. Send only the fields you want to change — omitted fields are left unchanged.

To remove a security layer, pass null for that config (e.g., "slsConfig": null). At least one field must be provided.

If the definition has existing assignments, updating its configuration may affect how those assignments resolve at query time.

PATCH
/api/management/v1/projects/{projectId}/unified-security/definitions/{definitionId}

Path Parameters

projectId*string

Your Semaphor project ID.

definitionId*string

The ID of the definition to operate on.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X patch "https://semaphor.cloud/api/management/v1/projects/string/unified-security/definitions/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "ok": true,
  "data": {
    "definition": {
      "clsConfig": {
        "connectionTemplate": "string",
        "filePathTemplates": {
          "property1": "string",
          "property2": "string"
        },
        "params": {
          "property1": "string",
          "property2": "string"
        }
      },
      "slsConfig": {
        "schemaTemplate": "string",
        "allowedSchemas": [
          "string"
        ],
        "defaultSchema": "string",
        "schema": "string"
      },
      "rlsConfig": {
        "rules": [
          {
            "matcher": {
              "type": "ALL_TABLES_WITH_COLUMN",
              "column": "string"
            },
            "expression": "string",
            "name": "string",
            "description": "string",
            "params": {
              "property1": "string",
              "property2": "string"
            },
            "enabled": true
          }
        ]
      },
      "id": "string",
      "projectId": "string",
      "connectionId": "string",
      "name": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
}
{
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "string",
    "details": {}
  }
}
{
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "string",
    "details": {}
  }
}
{
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "string",
    "details": {}
  }
}
{
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "string",
    "details": {}
  }
}
{
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "string",
    "details": {}
  }
}
{
  "ok": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "string",
    "details": {}
  }
}