Download OpenAPI specification :Download
authentication user if the provided credentials are valid.
| userName |
string
The username of the user. |
| pwd |
string <password
>
The password of the user. |
{
-
"userName":
"admin",
-
"pwd":
"colrows"
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724607686027
},
-
"payload":
{
-
"token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRldGltZS1jbGFpbSI6MTcyNDYwNzY4NiwiaXNzIjoiQ09MUk9XUyIsImV4cCI6MTcyNDYxNDg4NiwidXNlcklkIjoiYWRtaW4iLCJpYXQiOjE3MjQ2MDc2ODYsInVuaXF1ZS1pZCI6IjM2YmZkY2E3LTAzNjgtNDZlNy05ZjFjLTNkNTlmZmNhZjg0NiJ9.LI-43Y72x1Ftcv8XtKpjYdF6xZCAcXO11mBkz9NLriY",
-
"timeToLive":
1724614886016,
-
"authorizedAs":
"ADMIN",
-
"user":
{
-
"name":
"admin",
-
"realm":
"NATIVE",
-
"active":
true,
-
"ctime":
1724176683190,
-
"email":
"admin@colrows.com",
-
"userId":
"admin"
}
}
}Returns a new authentication token if the provided bearer token is valid and not expired.
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724607686027
},
-
"payload":
{
-
"token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRldGltZS1jbGFpbSI6MTcyNDYwNzY4NiwiaXNzIjoiQ09MUk9XUyIsImV4cCI6MTcyNDYxNDg4NiwidXNlcklkIjoiYWRtaW4iLCJpYXQiOjE3MjQ2MDc2ODYsInVuaXF1ZS1pZCI6IjM2YmZkY2E3LTAzNjgtNDZlNy05ZjFjLTNkNTlmZmNhZjg0NiJ9.LI-43Y72x1Ftcv8XtKpjYdF6xZCAcXO11mBkz9NLriY",
-
"timeToLive":
1724614886016,
-
"authorizedAs":
"ADMIN",
-
"user":
{
-
"name":
"admin",
-
"realm":
"NATIVE",
-
"active":
true,
-
"ctime":
1724176683190,
-
"email":
"admin@colrows.com",
-
"userId":
"admin"
}
}
}Create new user in Native realm.
| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
| name
required
|
string
The full name of the new user. |
| username
required
|
string
The username for the new user. |
| secret
required
|
string
The password or secret for the new user. |
| email
required
|
string <email
>
The email address of the new user. |
{
-
"name":
"Test User",
-
"username":
"TestUser",
-
"secret":
"Password",
-
"email":
"test@email.com"
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724608865560
},
-
"payload":
{
-
"id":
"TestUser",
-
"name":
"Test User",
-
"secret":
"e6c83b282aeb2e022844595721cc00bbda47cb24537c1779f9bb84f04039e1676e6ba8573e588da1052510e3aa0a32a9e55879ae22b0c2d62136fc0a3e85f8bb",
-
"realm":
"NATIVE",
-
"active":
true,
-
"ctime":
1724608865499,
-
"email":
"test@email.com"
}
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724609147682
},
-
"payload":
[
-
{
-
"name":
"admin",
-
"realm":
"NATIVE",
-
"active":
true,
-
"ctime":
1724176683190,
-
"email":
"admin@colrows.com",
-
"userId":
"admin"
}
]
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
| name |
string
The updated name of the user. |
| userId
required
|
string
The unique ID of the user to be updated. |
|
string <email
>
The updated email address of the user. |
{
-
"name":
"New User",
-
"userId":
"TestUser",
-
"email":
"test@email.com"
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724609904241
},
-
"payload":
{
-
"code":
"OPERATION_SUCCESSFUL",
-
"message":
"Successful",
-
"trace":
null
}
}| userId
required
|
string
The ID of the user to deactivate |
| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724610385566
},
-
"payload":
"OPERATION_SUCCESSFUL"
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
| groupName |
string
The name of the group to create |
| memberIds |
Array of strings <email
>
List of member email IDs to add to the group |
{
-
"groupName":
"TestGroupLeads",
-
"memberIds":
[
-
"shabby@colrows.com",
-
"satish.dev@colrows.com"
]
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724612634571
},
-
"payload":
{
-
"id":
"84f49c6b-78f4-42e7-b0cb-3cb5a1410518",
-
"name":
"TestGroupLeads",
-
"members":
[
-
{
-
"id":
"admin",
-
"name":
"Shabareesh Developer"
}
],
-
"creator":
{
-
"id":
"admin",
-
"name":
"admin"
},
-
"active":
true
}
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
| groupId |
string
The unique identifier of the group to update |
| groupName |
string
The name of the group to update |
| memberIds |
Array of strings <email
>
List of member email IDs to update the group with |
{
-
"groupId":
"test",
-
"groupName":
"TestGroupLeads",
-
"memberIds":
[
-
"shabby@colrows.com",
-
"satish.dev@colrows.com",
-
"user2@colrows.com"
]
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724612860434
},
-
"payload":
{
-
"id":
"84f49c6b-78f4-42e7-b0cb-3cb5a1410518",
-
"name":
"TestGroupLeads",
-
"members":
[
-
{
-
"id":
"shabby@colrows.com",
-
"name":
"Shabareesh Developer"
}
],
-
"creator":
{
-
"id":
"admin",
-
"name":
"admin"
},
-
"active":
true
}
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724612952103
},
-
"payload":
[
-
{
-
"id":
"87c66c15-725d-4975-88f0-84c1bb13bf6f",
-
"name":
"Prod Support",
-
"members":
[
-
{
-
"id":
"satish.admin@colrows.com",
-
"name":
"Satish Admin"
}
],
-
"creator":
{
-
"id":
"satish.admin@colrows.com",
-
"name":
"Satish Admin"
},
-
"active":
true
}
]
}| userGroupId
required
|
string
|
| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724613111838
},
-
"payload":
{
-
"code":
"OPERATION_SUCCESSFUL",
-
"message":
"Successful",
-
"trace":
null
}
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
| datasourceId |
string <uuid
>
Unique identifier for the data source |
| type |
string
Type of the classification |
| name |
string
Name of the classification |
| schema |
string
Schema of the data source |
|
Array of objects
List of permissions for the data source |
|
|
Array of objects
List of users associated with the data source |
|
|
Array of objects
List of groups associated with the data source |
{
-
"datasourceId":
"b83d0bb2-4166-492d-9217-def7882a514b",
-
"type":
"CLASS",
-
"name":
"class-test",
-
"schema":
"banking_system",
-
"permissions":
[
-
{
-
"sensitivity":
"PUBLIC"
}
],
-
"users":
[
-
{
-
"id":
"admin",
-
"name":
"admin"
}
],
-
"groups":
[
-
{
-
"name":
"ad:bankmanager"
}
]
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724656391122
},
-
"payload":
{
-
"id":
"0e47911b-576b-4221-8079-a230a3060ee5",
-
"name":
"class-test",
-
"active":
true,
-
"version":
0,
-
"schema":
"banking_system",
-
"type":
"CLASS",
-
"permissions":
[
-
{
-
"sensitivity":
"PUBLIC",
-
"exception":
null
}
],
-
"users":
[
-
{
-
"id":
"admin",
-
"name":
"admin"
}
],
-
"groups":
[
-
{
-
"id":
null,
-
"name":
"ad:bankmanager"
}
],
-
"createdBy":
{
-
"id":
"admin",
-
"name":
"admin"
},
-
"mtime":
1724656391090,
-
"datasource":
null
}
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
| id |
string <uuid
>
Unique identifier for the data source classification |
| datasourceId |
string
Identifier for the data source |
| type |
string
Type of the classification |
| name |
string
Name of the classification |
| schema |
string
Schema of the data source |
|
Array of objects
List of permissions for the data source |
|
|
Array of objects
List of users associated with the data source |
|
|
Array of objects
List of groups associated with the data source |
{
-
"id": "0e47911b-576b-4221-8079-a230a3060ee5",
-
"datasourceId":
"test",
-
"type":
"FIXED",
-
"name":
"Banker Fixed Permissions",
-
"schema":
"banking_system",
-
"permissions":
[
-
{
-
"dataset":
"account",
-
"rowPredicates":
[
-
"branch_id=1"
],
-
"columnExclusion":
[
-
"account_balance"
]
}
],
-
"users":
[
-
{
-
"id":
"admin",
-
"name":
"admin"
}
],
-
"groups":
[
-
{
-
"id":
"{{bankerGroup}}",
-
"name":
"Banker"
}
]
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724659888806
},
-
"payload":
{
-
"id":
"0e47911b-576b-4221-8079-a230a3060ee5",
-
"name":
"Banker Fixed Permissions",
-
"active":
true,
-
"version":
1,
-
"schema":
"banking_system",
-
"type":
"FIXED",
-
"permissions":
[
-
{
-
"dataset":
"customer_credit_card",
-
"columnExclusion":
[
-
"account_balance"
],
-
"rowPredicates":
[
-
"branch_id=1"
]
}
],
-
"users":
[
-
{
-
"id":
"admin",
-
"name":
"admin"
}
],
-
"groups":
[
-
{
-
"id":
"{{bankerGroup}}",
-
"name":
"Banker"
}
],
-
"createdBy":
{
-
"id":
"admin",
-
"name":
"admin"
},
-
"mtime":
1724659888758,
-
"datasource":
null
}
}| policyId
required
|
string
The ID of the policy |
| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724661650620
},
-
"payload":
[
-
{
-
"id":
"0e47911b-576b-4221-8079-a230a3060ee5",
-
"name":
"Banker Fixed Permissions",
-
"active":
true,
-
"version":
1,
-
"schema":
"banking_system",
-
"type":
"FIXED",
-
"permissions":
[
-
{
-
"sensitivity":
"PUBLIC",
-
"exception":
null,
-
"dataset":
"account",
-
"columnExclusion":
[
-
"account_balance"
],
-
"rowPredicates":
[
-
"branch_id=1"
]
}
],
-
"users":
[
-
{
-
"id":
"admin",
-
"name":
"admin"
}
],
-
"groups":
[
-
{
-
"id":
"{{bankerGroup}}",
-
"name":
"Banker"
}
],
-
"createdBy":
{
-
"id":
"admin",
-
"name":
"admin"
},
-
"mtime":
1724659888758,
-
"datasource":
null
}
]
}| policyId
required
|
string
The ID of the policy |
| versionId
required
|
string
The ID of the policy |
| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724661893303
},
-
"payload":
[
-
{
-
"id":
"0e47911b-576b-4221-8079-a230a3060ee5",
-
"name":
"Banker Fixed Permissions",
-
"active":
true,
-
"version":
1,
-
"schema":
"banking_system",
-
"type":
"FIXED",
-
"permissions":
[
-
{
-
"dataset":
"account",
-
"columnExclusion":
[
-
"account_balance"
],
-
"rowPredicates":
[
-
"branch_id=1"
]
}
],
-
"users":
[
-
{
-
"id":
"admin",
-
"name":
"admin"
}
],
-
"groups":
[
-
{
-
"id":
"{{bankerGroup}}",
-
"name":
"Banker"
}
],
-
"createdBy":
{
-
"id":
"admin",
-
"name":
"admin"
},
-
"mtime":
1724659888758,
-
"datasource":
null
}
]
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724662064925
},
-
"payload":
[
-
{
-
"id":
"2a802264-f0a2-4ed5-b9f9-91065ead236e",
-
"name":
"tech-leads-fixed-mysql-prod",
-
"active":
true,
-
"version":
0,
-
"schema":
"colrows",
-
"type":
"FIXED",
-
"permissions":
[
-
{
-
"dataset":
"employee",
-
"columnExclusion":
[
-
"salary"
],
-
"rowPredicates":
[
-
"col1='India'",
-
"col2>1000"
],
-
"allButTheseColumns":
null,
-
"onlyTheseColumns":
[
-
"_ids"
],
-
"sensitivity":
"PUBLIC",
-
"exception":
null
}
],
-
"users":
[
-
{
-
"id":
"satish.admin@colrows.com",
-
"name":
"Satish Admin"
}
],
-
"groups":
[
-
{
-
"id":
"3ba4a85c-0f02-4321-bcc4-81995fd4df48",
-
"name":
"Leads"
}
],
-
"createdBy":
{
-
"id":
"satish.dev@colrows.com",
-
"name":
"Satish Developer"
},
-
"mtime":
1724176683499,
-
"datasource":
{
-
"id":
"21a05e72-59e1-4a24-be3d-3172061969dd",
-
"name":
"MySQL Dev"
}
}
]
}| policyId
required
|
string
The ID of the policy |
| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"code":
"UNAUTHORIZED",
-
"message":
"Invalid or expired token"
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
| datasourceId
required
|
string <uuid
>
Unique identifier of the data source |
| name
required
|
string
Name of the classification |
| schema
required
|
string
Schema of the data source |
| type
required
|
string
Type of the classification (e.g., FIXED, REGEX) |
|
required
|
Array of objects
List of models associated with this classification |
|
Array of objects
List of users associated with this classification |
|
|
Array of objects
List of groups associated with this classification |
{
-
"datasourceId":
"datasource-id",
-
"name":
"redaction-fixed-role1",
-
"schema":
"employees",
-
"type":
"FIXED",
-
"models":
[
-
{
-
"dataset":
"salaries",
-
"columns":
[
-
"salary"
],
-
"scheme":
{
-
"type":
"FULL",
-
"unmaskedChars":
5
}
}
],
-
"users":
[
-
{
-
"id":
"admin",
-
"name":
"admin"
}
],
-
"groups":
[
-
{
-
"id":
"userGroupId1",
-
"name":
"Group1"
}
]
}
{
-
"header":
{
-
"stale":
true,
-
"ctime":
0
},
-
"payload":
{
-
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08",
-
"version":
0,
-
"active":
true,
-
"name":
"string",
-
"schema":
"string",
-
"type":
"string",
-
"redactionModels":
[
-
{
-
"dataset":
"string",
-
"columns":
[
-
"string"
],
-
"scheme":
{
-
"type":
"string",
-
"unmaskedChars":
0
}
}
],
-
"users":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"groups":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"createdBy":
{
-
"id":
"string",
-
"name":
"string"
},
-
"mtime":
0,
-
"datasource":
"string"
}
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
| id
required
|
string <uuid
>
Unique identifier of the redaction role. |
| datasourceId
required
|
string <uuid
>
Unique identifier of the associated datasource. |
| name
required
|
string
Name of the redaction role. |
| schema
required
|
string
Schema associated with the redaction role. |
| type
required
|
string
Type of redaction role. |
|
required
|
Array of objects
List of models associated with the redaction role. |
|
required
|
Array of objects
List of users with access to the redaction role. |
|
required
|
Array of objects
List of groups with access to the redaction role. |
{
-
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
-
"datasourceId":
"f54dd925-2599-432c-9567-403230bdafed",
-
"name":
"string",
-
"schema":
"string",
-
"type":
"string",
-
"models":
[
-
{
-
"dataset":
"string",
-
"columns":
[
-
"string"
],
-
"scheme":
{
-
"type":
"string"
}
}
],
-
"users":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"groups":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
]
}
{
-
"header":
{
-
"stale":
true,
-
"ctime":
0
},
-
"payload":
{
-
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08",
-
"version":
0,
-
"active":
true,
-
"name":
"string",
-
"schema":
"string",
-
"type":
"string",
-
"redactionModels":
[
-
{
-
"dataset":
"string",
-
"columns":
[
-
"string"
],
-
"scheme":
{
-
"type":
"string",
-
"unmaskedChars":
0
}
}
],
-
"users":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"groups":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"createdBy":
{
-
"id":
"string",
-
"name":
"string"
},
-
"mtime":
0,
-
"datasource":
"string"
}
}| redactionPolicyId
required
|
string
|
| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
true,
-
"ctime":
0
},
-
"payload":
[
-
{
-
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08",
-
"version":
0,
-
"active":
true,
-
"name":
"string",
-
"schema":
"string",
-
"type":
"string",
-
"redactionModels":
[
-
{
-
"dataset":
"string",
-
"columns":
[
-
"string"
],
-
"scheme":
{
-
"type":
"string",
-
"unmaskedChars":
0
}
}
],
-
"users":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"groups":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"createdBy":
{
-
"id":
"string",
-
"name":
"string"
},
-
"mtime":
0,
-
"datasource":
{
-
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08",
-
"name":
"string"
}
}
]
}| redactionPolicyId
required
|
string
|
| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"code":
"UNAUTHORIZED",
-
"message":
"Invalid or expired token"
}| Authorization |
string
Example: Basic 89de0d91-fdff-40b2-8330-7799d972f9db
|
{
-
"header":
{
-
"stale":
true,
-
"ctime":
0
},
-
"payload":
[
-
{
-
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08",
-
"version":
0,
-
"active":
true,
-
"name":
"string",
-
"schema":
"string",
-
"type":
"string",
-
"redactionModels":
[
-
{
-
"dataset":
"string",
-
"columns":
[
-
"string"
],
-
"scheme":
{
-
"type":
"string",
-
"unmaskedChars":
0
}
}
],
-
"users":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"groups":
[
-
{
-
"id":
"string",
-
"name":
"string"
}
],
-
"createdBy":
{
-
"id":
"string",
-
"name":
"string"
},
-
"mtime":
0,
-
"datasource":
{
-
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08",
-
"name":
"string"
}
}
]
}This endpoint allows you to evaluate if user is allowed to execute given query on given datasource.
| datasourceId
required
|
string <uuid
>
The unique identifier for the datasource. |
| userId
required
|
string
The ID of the user to evaluate the query for. |
| query
required
|
string
The SQL query to be executed. |
{
-
"datasourceId":
"0dfea9a8-035a-4b1d-aec3-88b448694851",
-
"userId":
"user1",
-
"query":
"select * from banking.accounts"
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724823394487
},
-
"payload":
{
-
"permission":
true,
-
"message":
"User admin has sufficient privilege to run the query"
}
}This endpoint allows you to evaluate if user is allowed to access specified column of the given table
| datasourceId
required
|
string <uuid
>
The unique identifier for the datasource. |
| userId
required
|
string
The ID of the user to evaluate the query for. |
| schema
required
|
string
The schema within which the relation exists. |
| relation
required
|
string
The name of the relation (table) to be queried. |
| columns
required
|
Array of strings
A list of columns to be selected from the relation. |
{
-
"datasourceId":
"0dfea9a8-035a-4b1d-aec3-88b448694851",
-
"userId":
"admin",
-
"schema":
"banking",
-
"relation":
"accounts",
-
"columns":
[
-
"account_id",
-
"account_type",
-
"branch_id"
]
}
{
-
"header":
{
-
"stale":
false,
-
"ctime":
1724823394487
},
-
"payload":
{
-
"permission":
true,
-
"message":
"User has access to the relation and given columns"
}
}