Semaphor

Get a definition

Returns a single definition with its connection details and the number of assignments that reference it.

GET
/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.

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/string"
{
  "ok": true,
  "data": {
    "definition": {
      "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"
      },
      "connection": {
        "id": "string",
        "name": "string",
        "type": "string"
      },
      "assignmentCount": 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",
    "details": {}
  }
}