Semaphor

List definitions

Returns all security definitions in the project. Each definition includes the connection it belongs to and the number of assignments that reference it, plus bounded rlsHealth counts. Detailed diagnostics and legacy recovery data are intentionally omitted from the list.

Any secret CLS parameter values are masked (shown as "***") in the response.

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

Authorization

UnifiedSecurityBearerAuth
AuthorizationBearer <token>

A project-scoped access token generated for an organization Admin. Generate one with the Token API using the Admin's orgUserId. The token project must match the request path, and the user must currently be active and belong to the project organization. Dashboard tokens and tenant-user project tokens are not accepted.

In: header

Path Parameters

projectId*string

Your Semaphor project ID.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X get "https://semaphor.cloud/api/management/v1/projects/string/unified-security/definitions"
{
  "ok": true,
  "data": {
    "definitions": [
      {
        "definition": {
          "id": "string",
          "projectId": "string",
          "connectionId": "string",
          "name": "string",
          "clsConfig": {
            "connectionTemplate": "string",
            "filePathTemplates": {
              "property1": "string",
              "property2": "string"
            },
            "params": {
              "property1": "string",
              "property2": "string"
            }
          },
          "slsConfig": {
            "schemaTemplate": "string",
            "allowedSchemas": [
              "string"
            ],
            "defaultSchema": "string",
            "schema": "string"
          },
          "rlsConfig": null,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z"
        },
        "connection": {
          "id": "string",
          "name": "string",
          "type": "string"
        },
        "assignmentCount": 0,
        "rlsHealth": {
          "status": "NOT_APPLICABLE",
          "errorCount": 0,
          "warningCount": 0,
          "infoCount": 0
        }
      }
    ]
  }
}
{
  "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",
    "requestId": "string",
    "issues": [
      {
        "code": "INVALID_JSON",
        "fieldPath": "string",
        "message": "string"
      }
    ],
    "retryable": true
  }
}