# TrustLogix API Documentation

This document describes the REST API endpoints available in the "Api Documentation" collection.

## API Endpoints

### api/account

Manages account information.

#### POST

```
/api/account/migrate_access_policies
```

**Description:** Migrates a policy from one TLX account to another based on a list of object names or policy names.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "migrateAccountId": "string",
  "sourceAccountId": "string",
  "sourceAccountObjects": [
    "string",
    "string"
  ],
  "sourceAccountPolicyNames": [
    "string",
    "string"
  ]
}
```

**Responses:**

* 200 OK: Indicates a successful operation.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The policy was migrated.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/account/promote_access_policies
```

**Description:** Migrates a policy from one TLX account to another based on a list of policy names and versions.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "migrateAccountId": "string",
  "policies": [
    {
      "policyName": "string",
      "policyVersion": 6401
    },
    {
      "policyName": "string",
      "policyVersion": 8092
    }
  ],
  "sourceAccountId": "string"
}
```

**Responses:**

* 200 OK: Indicates a successful operation.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The policy was promoted.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/account/accountStats
```

**Description:** Retrieves account statistics.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of account statistics.
  * **Body:** JSON

```json
{
  "key_0": {},
  "key_1": {},
  "key_2": {},
  "key_3": {}
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/account
```

**Description:** Lists all accounts with optional filtering and pagination.

**Parameters:**

* accessPolicyStatus (string, optional): Filter by access policy status.
* dataRiskCategory (string, optional): Filter by data risk category.
* dataSeverity (string, optional): Filter by data severity.
* dataSourceName (string, optional): Filter by data source name.
* dataSourceType (string, optional): Filter by data source type.
* includeAll (boolean, optional, default: false): Include all accounts.
* includePolicyCount (boolean, optional, default: false): Include the count of policies.
* monitoringPolicyStatus (string, optional): Filter by monitoring policy status.
* page\_no (integer, optional, default: 1): Page number for pagination.
* page\_size (integer, optional, default: 20): Number of items per page.
* sort\_by (string, optional, default: lastModifiedDate): Field to sort by.
* sort\_order (string, optional, default: DESC): Sort order (ASC or DESC).
* status (string, optional): Filter by account status.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A paginated list of accounts.
  * **Body:** JSON

```json
{
  "items": [
    {
      "accountIds": [
        "string",
        "string"
      ],
      "accountStatus": "string",
      "alertCount": 7665,
      "attributeMapping": [
        {
          "accountId": "string",
          "attributeContextValues": "string",
          "attributeKey": "string",
          "attributeValue": "string",
          "domain": "string",
          "entityKey": "string",
          "entityType": "string"
        },
        {
          "accountId": "string",
          "attributeContextValues": "string",
          "attributeKey": "string",
          "attributeValue": "string",
          "domain": "string",
          "entityKey": "string",
          "entityType": "string"
        }
      ],
      "authType": "string",
      "awsAccountId": "string",
      "blobAccountName": "string",
      "blobContainerName": "string",
      "clusterName": "string",
      "configParameters": "string",
      "dataAccessPolicyCount": 2022,
      "dataClassificationScheme": "string",
      "databaseIdentifier": "string",
      "dbName": "string",
      "dbPassword": "string",
      "dbUsername": "string",
      "description": "string",
      "edition": "string",
      "externalCatalog": true,
      "externalId": "string",
      "id": "string",
      "integrationEnabled": true,
      "jdbcConnectionUrl": "string",
      "lastModifiedBy": "string",
      "lastModifiedDate": "1981-04-17T06:27:23.090Z",
      "metastoreId": "string",
      "monitoringPolicyCount": 8383,
      "name": "string",
      "notificationErrorsCount": 9907,
      "oauthAuthzEndpoint": "string",
      "oauthClientId": "string",
      "oauthClientSecret": "string",
      "oauthTenantId": "string",
      "oauthTokenEndpoint": "string",
      "passphrase": "string",
      "password": "string",
      "privateKey": "string",
      "privateKeyFileName": "string",
      "region": "string",
      "roleArn": "string",
      "roleName": "string",
      "s3RawDataBucketName": "string",
      "sasToken": "string",
      "scope": "string",
      "serviceAccountId": "string",
      "servicesDeployed": false,
      "siUserName": "string",
      "stageName": "string",
      "storageIntegrationName": "string",
      "subtype": "string",
      "type": "string",
      "userId": "string",
      "username": "string",
      "warehouse": "string",
      "workspace": "string"
    },
    {
      "accountIds": [
        "string",
        "string"
      ],
      "accountStatus": "string",
      "alertCount": 5344,
      "attributeMapping": [
        {
          "accountId": "string",
          "attributeContextValues": "string",
          "attributeKey": "string",
          "attributeValue": "string",
          "domain": "string",
          "entityKey": "string",
          "entityType": "string"
        },
        {
          "accountId": "string",
          "attributeContextValues": "string",
          "attributeKey": "string",
          "attributeValue": "string",
          "domain": "string",
          "entityKey": "string",
          "entityType": "string"
        }
      ],
      "authType": "string",
      "awsAccountId": "string",
      "blobAccountName": "string",
      "blobContainerName": "string",
      "clusterName": "string",
      "configParameters": "string",
      "dataAccessPolicyCount": 9493,
      "dataClassificationScheme": "string",
      "databaseIdentifier": "string",
      "dbName": "string",
      "dbPassword": "string",
      "dbUsername": "string",
      "description": "string",
      "edition": "string",
      "externalCatalog": false,
      "externalId": "string",
      "id": "string",
      "integrationEnabled": false,
      "jdbcConnectionUrl": "string",
      "lastModifiedBy": "string",
      "lastModifiedDate": "1976-04-04T16:22:31.689Z",
      "metastoreId": "string",
      "monitoringPolicyCount": 8417,
      "name": "string",
      "notificationErrorsCount": 1561,
      "oauthAuthzEndpoint": "string",
      "oauthClientId": "string",
      "oauthClientSecret": "string",
      "oauthTenantId": "string",
      "oauthTokenEndpoint": "string",
      "passphrase": "string",
      "password": "string",
      "privateKey": "string",
      "privateKeyFileName": "string",
      "region": "string",
      "roleArn": "string",
      "roleName": "string",
      "s3RawDataBucketName": "string",
      "sasToken": "string",
      "scope": "string",
      "serviceAccountId": "string",
      "servicesDeployed": true,
      "siUserName": "string",
      "stageName": "string",
      "storageIntegrationName": "string",
      "subtype": "string",
      "type": "string",
      "userId": "string",
      "username": "string",
      "warehouse": "string",
      "workspace": "string"
    }
  ],
  "pageNo": 232,
  "pageSize": 2652,
  "total": 6012
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: No accounts found matching the criteria.

#### GET

```
/api/account/:accountId
```

**Description:** Retrieves a single account record by its ID.

**Parameters:**

* accountId (string, required): The ID of the account to retrieve.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: The requested account record.
  * **Body:** JSON

```json
{
  "accountIds": [
    "string",
    "string"
  ],
  "accountStatus": "string",
  "authType": "string",
  "awsAccountId": "string",
  "blobAccountName": "string",
  "blobContainerName": "string",
  "clusterName": "string",
  "configParameters": "string",
  "createdBy": "string",
  "createdDate": "1990-09-05T05:27:22.653Z",
  "dataClassificationScheme": "string",
  "databaseIdentifier": "string",
  "dbName": "string",
  "dbPassword": "string",
  "dbUsername": "string",
  "deleted": true,
  "description": "string",
  "edition": "string",
  "externalCatalog": true,
  "externalId": "string",
  "id": "string",
  "jdbcConnectionUrl": "string",
  "lastModifiedBy": "string",
  "lastModifiedDate": "1999-11-02T09:43:39.950Z",
  "mappingAttributes": [
    {
      "accountId": "string",
      "attributeType": "string",
      "attributeValue": "string",
      "domainId": "string",
      "entityId": "string",
      "entityType": "string",
      "id": "string",
      "tenantId": "string"
    },
    {
      "accountId": "string",
      "attributeType": "string",
      "attributeValue": "string",
      "domainId": "string",
      "entityId": "string",
      "entityType": "string",
      "id": "string",
      "tenantId": "string"
    }
  ],
  "metastoreId": "string",
  "name": "string",
  "oauthAuthzEndpoint": "string",
  "oauthClientId": "string",
  "oauthRedirectEndpoint": "string",
  "oauthTenantId": "string",
  "oauthTokenEndpoint": "string",
  "privateKeyFileName": "string",
  "region": "string",
  "roleArn": "string",
  "roleName": "string",
  "s3RawDataBucketName": "string",
  "sasToken": "string",
  "scope": "string",
  "serviceAccountId": "string",
  "servicesDeployed": false,
  "siUserName": "string",
  "stageName": "string",
  "storageIntegrationName": "string",
  "subtype": "string",
  "tenantId": "string",
  "userId": "string",
  "username": "string",
  "warehouse": "string",
  "workspace": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### Access Policies

#### listAccessPolicies

Retrieves a list of access policies for a given account.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies?page\_no=1\&page\_size=20\&sort\_by=lastModifiedDate\&sort\_order=DESC
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
* **Query Parameters:**
  * page\_no (integer): Page number for pagination.
  * page\_size (integer): Number of items per page.
  * sort\_by (string): Field to sort by.
  * sort\_order (string): Sort order.
  * ... (other optional filters)
* **Example Response (200 OK):** JSON

```json
{
  "items": [
    {
      "columnName": "string",
      "createdBy": "string",
      "createdDate": "1976-06-05T23:01:25.066Z",
      "dataSourceName": "string",
      "databaseObjects": [
        {
          "names": "string",
          "type": "string"
        },
        {
          "names": "string",
          "type": "string"
        }
      ],
      "deleted": false,
      "description": "string",
      "draftPolicyId": "string",
      "enableFutureGrants": false,
      "enableRedeployFromDeltaSync": false,
      "enabled": false,
      "entitlements": {
        "columnDetails": [
          {
            "key_0": "string",
            "key_1": "string"
          }
        ],
        "conjunction": "string",
        "description": "string",
        "joinPredicate": "string",
        "name": "string"
      },
      "failMessage": "string",
      "functionName": "string",
      "groupUserMappingTableName": "string",
      "id": "string",
      "includeViewAccessGrants": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "1980-02-15T01:41:37.835Z",
      "maskingPatternName": "string",
      "maskingPatternValue": "string",
      "name": "string",
      "objectNameList": [
        "string",
        "string"
      ],
      "objectOwnerList": "string",
      "objectPrivilege": "string",
      "objectType": "string",
      "parentRoleTemplate": {},
      "parentRoleTemplateId": "string",
      "policyActions": [
        {
          "actionDisplayName": "string",
          "actionName": "string",
          "disabled": true,
          "id": "string"
        }
      ],
      "policyDataTypeId": "string",
      "policyDataTypeName": "string",
      "policyOwner": true,
      "policySubtype": "string",
      "prevPolicyId": "string",
      "previousModelJSON": "string",
      "principals": [
        "string",
        "string"
      ],
      "privilegeList": [
        {
          "description": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "redeployRequired": true,
      "redshiftJDBCURL": "string",
      "remediationMsg": "string",
      "roleTemplate": {},
      "roleTemplateId": "string",
      "rootPolicyCreatedBy": "string",
      "rules": [
        {
          "columnGrantSQL": "string",
          "columnGrants": [
            {
              "createdBy": "string",
              "createdDate": "2003-05-27T04:44:22.048Z",
              "deleted": false,
              "description": "string",
              "id": "string",
              "lastModifiedBy": "string",
              "lastModifiedDate": "1951-07-28T10:10:19.435Z",
              "name": "string"
            }
          ],
          "columnRules": [],
          "description": "string",
          "entitlements": {
            "columnDetails": [
              {
                "key_0": "string",
                "key_1": "string"
              }
            ],
            "conjunction": "string",
            "description": "string",
            "joinPredicate": "string",
            "name": "string"
          },
          "futureObjectSchemaGrantSQL": "string",
          "groupUserTableSchemaGrantSQL": "string",
          "name": "string",
          "outputSchemaGrantSQL": "string",
          "queryContextId": "string",
          "queryContextKey": "string",
          "queryContextName": "string",
          "queryContextValue": "string",
          "sourceSchemaGrantSQL": "string",
          "tableGrantSQL": "string"
        }
      ],
      "schemaName": "string",
      "securedObjects": {
        "columnName": "string",
        "databaseName": "string",
        "integration": "string",
        "objectName": [
          "string",
          "string"
        ],
        "resourceMonitor": "string",
        "schemaName": "string",
        "sharedDatabase": "string",
        "tableName": "string",
        "warehouse": "string"
      },
      "status": "string",
      "tableName": "string",
      "version": 3040,
      "viewDescription": "string",
      "viewFilterConditions": "string",
      "viewJoinConditions": "string",
      "viewName": "string",
      "viewTableName": "string",
      "workspace": "string"
    }
  ],
  "pageNo": 2394,
  "pageSize": 1989,
  "total": 9469
}
```

#### createAccessPolicy

Creates a new access policy.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies
* **Method:** POST
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
* **Example Request Body:** JSON

```json
{
  "columnName": "string",
  "dataSourceName": "string",
  "databaseObjects": [
    {
      "names": "string",
      "type": "string"
    }
  ],
  "deleted": false,
  "deployFullGrants": false,
  "description": "string",
  "enableFutureGrants": false,
  "enableRedeployFromDeltaSync": false,
  "enabled": true,
  "entitlements": {
    "columnDetails": [
      {
        "key_0": "string"
      }
    ],
    "conjunction": "string",
    "description": "string",
    "joinPredicate": "string",
    "name": "string"
  },
  "functionName": "string",
  "globalPolicy": true,
  "groupUserMappingTableName": "string",
  "maskingPatternName": "string",
  "maskingPatternValue": "string",
  "name": "USB_1TPxxsWxW_5nbE_HEUgQHQ6L6_T_zWTMZHv_8R7steRd_pDmG_c0x7CQ_QAmXf",
  "objectNameList": [
    "string",
    "string"
  ],
  "objectOwnerList": "string",
  "objectPrivilegeList": [
    "string",
    "string"
  ],
  "objectPrivilegeMapping": [
    {
      "objectPrivilege": "string",
      "objectType": "string"
    }
  ],
  "objectType": "string",
  "parentRoleTemplateId": "string",
  "policyDataTypeId": "string",
  "policySubtype": "OBJECT_NAMES",
  "remediationSource": {
    "id": "string",
    "type": "string"
  },
  "roleTemplateId": "string",
  "rules": [
    {
      "columnGrants": [
        {
          "name": "string",
          "type": "string"
        }
      ],
      "columnRules": [],
      "entitlements": {
        "columnDetails": [
          {
            "key_0": "string",
            "key_1": "string"
          }
        ],
        "conjunction": "string",
        "description": "string",
        "joinPredicate": "string",
        "name": "string"
      },
      "queryContextId": "string",
      "queryContextKey": "string",
      "queryContextValue": "string",
      "selectedPrincipalValue": "string"
    }
  ],
  "schemaName": "string",
  "status": "string",
  "tableName": "string",
  "viewDescription": "string",
  "viewFilterConditions": "string",
  "viewJoinConditions": "string",
  "viewName": "string",
  "viewTableName": "string",
  "workspace": "string"
}
```

**Example Response (200 OK):** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

#### getAccessPolicy

Retrieves a specific access policy by its ID.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/:id
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * id (string, required): The ID of the access policy.
* **Example Response (200 OK):** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

#### updateAccessPolicy

Updates an existing access policy by its ID.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/:id
* **Method:** PUT
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * id (string, required): The ID of the access policy.
* **Example Request Body:** (Same as createAccessPolicy)
* **Example Response (201 Created):** JSON

```json
{}
```

#### deleteAccessPolicy

Deletes a specific access policy by its ID.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/:id?consent=false\&includeViewAccessGrants=false
* **Method:** DELETE
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * id (string, required): The ID of the access policy.
* **Query Parameters:**
  * consent (boolean): Confirmation for deletion.
  * includeViewAccessGrants (boolean): Deletes associated view grants.
* **Example Response (200 OK):** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

#### disableAccessPolicy

Disables a specific access policy by its ID.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/:id/disable?consent=false\&includeViewAccessGrants=false
* **Method:** DELETE
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * id (string, required): The ID of the access policy.
* **Query Parameters:**
  * consent (boolean): Confirmation for disabling.
  * includeViewAccessGrants (boolean): Disables associated view grants.
* **Example Response (200 OK):** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

#### getAccessPolicyByPolicyName

Retrieves a specific access policy by its name.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/name/:policyName
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * policyName (string, required): The name of the access policy.
* **Example Response (200 OK):** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

#### getImpactedObject

Retrieves a list of objects impacted by an access policy.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/impacted\_objects?policyId=string
* **Method:** POST
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
* **Query Parameters:**
  * policyId (string): The ID of the policy to check for impacted objects.
* **Example Request Body:** (Same as createAccessPolicy)
* **Example Response (200 OK):** JSON

```json
{
  "accountName": "string",
  "count": 9593,
  "dapImpactedObjects": [
    {
      "columnName": "string",
      "database": "string",
      "datasourceName": "string",
      "name": "string",
      "objectName": "string",
      "objectType": "string",
      "reason": "string",
      "schema": "string",
      "status": "string"
    }
  ],
  "type": "string"
}
```

#### publishedPolicyList

Lists published policies.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/published\_policy?limit=5
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
* **Query Parameters:**
  * limit (integer): The maximum number of policies to return.
* **Example Response (200 OK):** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

#### getReviewAndPublishablePolicies

Retrieves policies that are ready for review and publishing.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/review\_publish\_policies
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
* **Example Response (200 OK):** JSON

```json
[
  "string",
  "string"
]
```

**publishPolicy**

Publishes a policy.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/:id/publish\_policy?includeViewAccessGrants=false
* **Method:** POST
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * id (string, required): The ID of the policy to publish.
* **Query Parameters:**
  * includeViewAccessGrants (boolean): Includes associated view access grants.
* **Example Request Body:** JSON

```json
{
  "jdbcConnectionURL": "string"
}
```

* **Example Response (200 OK):** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

#### reviewPublishPolicy

Reviews and publishes a policy.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/:id/review\_publish\_policy?includeViewAccessGrants=false
* **Method:** POST
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * id (string, required): The ID of the policy to review and publish.
* **Query Parameters:**
  * includeViewAccessGrants (boolean): Includes associated view access grants.
* **Example Response (200 OK):** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

#### getAccessPolicyHistory

Retrieves the history of a specific access policy.

* **URL:** {{baseUrl}}/api/account/:accountId/access\_policies/:id/view\_history?policy\_status=string
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * id (string, required): The ID of the access policy.
* **Query Parameters:**
  * policy\_status (string): Filters the history by policy status.
* **Example Response (200 OK):** JSON

```json
[
  {
    "accountId": "string",
    "action": "string",
    "cascadedFrom": "string",
    "comments": "string",
    "createdDate": "1996-03-06T19:37:09.137Z",
    "httpMethod": "string",
    "id": "string",
    "resourceId": "string",
    "resourceName": "string",
    "resourceType": "string",
    "result": "string",
    "tenantId": "string",
    "updateOpDetails": "string",
    "userId": "string",
    "userLoginIP": "string"
  }
]
```

#### accountHealthStatus

Retrieves the health status of an account.

* **URL:** {{baseUrl}}/api/account/:accountId/health
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
* **Headers:**
  * tenantId (string, required): The ID of the tenant.
* **Example Response (200 OK):** JSON

```json
{
  "key_0": "string",
  "key_1": "string"
}
```

#### getRoleTemplates

Retrieves role templates associated with an account.

* **URL:** {{baseUrl}}/api/account/:accountId/role\_templates?dataAccessPolicyId=string
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
* **Query Parameters:**
  * dataAccessPolicyId (string): Filters role templates by a specific data access policy ID.
* **Headers:**
  * tenantId (string, required): The ID of the tenant.
* **Example Response (200 OK):** JSON

```json
[
  {
    "accountType": "string",
    "createdBy": "string",
    "createdDate": "2004-01-03T20:15:50.122Z",
    "customObjectTypeSelectionEnabled": true,
    "dataAccessPolicyObjectPrivilegeMappings": [
      {
        "dataAccessPolicyId": "string",
        "dataAccessPolicyRoleTemplateId": "string",
        "id": "string",
        "objectPrivilege": "string",
        "objectType": "string"
      }
    ],
    "dataAccessPolicyRoleTemplateMappings": [
      {
        "dataAccessPolicyRoleTemplateId": "string",
        "grantOption": false,
        "id": "string",
        "objectPrivilege": "string",
        "objectType": "string"
      }
    ],
    "deleted": false,
    "description": "string",
    "domainTemplate": false,
    "id": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "2016-03-06T06:48:01.396Z",
    "name": "string",
    "objectSelection": "string",
    "queryContextKey": "string",
    "subRoleTemplates": [],
    "typeNamesNeeded": false
  }
]
```

#### getUserAttributeValuesHistory

Retrieves the history of user entitlement attribute values.

* **URL:** {{baseUrl}}/api/account/:accountId/user\_entitlement\_attribute/:id/view\_history
* **Method:** GET
* **Path Parameters:**
  * accountId (string, required): The ID of the account.
  * id (string, required): The ID of the user entitlement attribute.
* **Example Response (200 OK):** JSON

```json
[
  {
    "accountId": "string",
    "action": "string",
    "cascadedFrom": "string",
    "comments": "string",
    "createdDate": "1996-03-06T19:37:09.137Z",
    "httpMethod": "string",
    "id": "string",
    "resourceId": "string",
    "resourceName": "string",
    "resourceType": "string",
    "result": "string",
    "tenantId": "string",
    "updateOpDetails": "string",
    "userId": "string",
    "userLoginIP": "string"
  }
]
```

### api/account\_tag

Manages account tags and their associations.

#### PUT

```
/api/account_tag/delete_tag
```

**Description:** Deletes a data source tag.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** PUT
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "description": "string",
  "id": "string",
  "lastModifiedDate": "string",
  "name": "string",
  "tagDatabase": "string",
  "tagOwner": "string",
  "tagSchema": "string",
  "tagValues": "string",
  "workspace": "string"
}
```

**Responses:**

* 200 OK: Indicates a successful operation.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The tag was deleted.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### PUT

```
/api/account_tag/delete_tag_association
```

**Description:** Deletes records matching a combination of filters.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** PUT
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "columnName": "string",
  "domain": "RBAC_TAG_OBJECTS",
  "id": "string",
  "newColumnName": "string",
  "newObjectDatabase": "string",
  "newObjectName": "string",
  "newObjectSchema": "string",
  "newTagDatabase": "string",
  "newTagKey": "string",
  "newTagSchema": "string",
  "newTagValue": "string",
  "objectDatabase": "string",
  "objectName": "string",
  "objectSchema": "string",
  "tagDatabase": "string",
  "tagKey": "string",
  "tagSchema": "string",
  "tagValue": "string",
  "workspace": "string"
}
```

**Responses:**

* 200 OK: Indicates a successful operation.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The tag association was deleted.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/account_tag/object_types
```

**Description:** Get tag association object type names based on the user and tag key name.

**Parameters:**

* accountId (string, required): The ID of the account.
* tagKey (string, optional): The name of the tag key.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of object types.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/account_tag/tag_association
```

**Description:** Creates a new tag association.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** POST
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "columnName": [
    "string",
    "string"
  ],
  "domain": "SCHEMA",
  "objectDatabase": [
    "string",
    "string"
  ],
  "objectName": [
    "string",
    "string"
  ],
  "objectSchema": [
    "string",
    "string"
  ],
  "tagDatabase": "string",
  "tagKey": "string",
  "tagSchema": "string",
  "tagValue": "string",
  "workspace": "string"
}
```

**Responses:**

* 200 OK: Indicates a successful operation.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The tag association was created.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/account_tag/tag_association_metadata
```

**Description:** Retrieves tag association metadata.

**Parameters:**

* accountId (string, required): The ID of the account.
* columnNames (array of strings, optional): Filter by column names.
* objectDatabases (array of strings, optional): Filter by object databases.
* objectNames (array of strings, optional): Filter by object names.
* objectSchemas (array of strings, optional): Filter by object schemas.
* objectTypes (string, optional, default: TABLE): Filter by object types.
* tagDatabases (array of strings, optional): Filter by tag databases.
* tagKeys (array of strings, optional): Filter by tag keys.
* tagSchemas (array of strings, optional): Filter by tag schemas.
* type (string, required, default: TAG\_VALUE): The type of metadata to retrieve.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of tag association metadata.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/account_tag/tag_reference
```

**Description:** Retrieves tag references for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of tag references.
  * **Body:** JSON

```json
[
  {
    "accountTag": {
      "description": "string",
      "id": "string",
      "lastModifiedDate": "string",
      "name": "string",
      "tagDatabase": "string",
      "tagOwner": "string",
      "tagSchema": "string",
      "tagValues": "string",
      "workspace": "string"
    },
    "columnName": "string",
    "domain": "RBAC_TAG_OBJECTS",
    "id": "string",
    "objectDatabase": "string",
    "objectName": "string",
    "objectSchema": "string",
    "tagDatabase": "string",
    "tagKey": "string",
    "tagSchema": "string",
    "tagValue": "string",
    "workspace": "string"
  },
  {
    "accountTag": {
      "description": "string",
      "id": "string",
      "lastModifiedDate": "string",
      "name": "string",
      "tagDatabase": "string",
      "tagOwner": "string",
      "tagSchema": "string",
      "tagValues": "string",
      "workspace": "string"
    },
    "columnName": "string",
    "domain": "TABLE",
    "id": "string",
    "objectDatabase": "string",
    "objectName": "string",
    "objectSchema": "string",
    "tagDatabase": "string",
    "tagKey": "string",
    "tagSchema": "string",
    "tagValue": "string",
    "workspace": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/account_tag/tag_references
```

**Description:** Retrieves data source tag references with pagination and filtering.

**Parameters:**

* accountId (string, required): The ID of the account.
* objectDatabases (array of strings, optional): Filter by object databases.
* objectNames (array of strings, optional): Filter by object names.
* objectSchemas (array of strings, optional): Filter by object schemas.
* objectTypes (array of strings, optional): Filter by object types.
* page\_no (integer, optional, default: 1): Page number for pagination.
* page\_size (integer, optional, default: 10): Number of items per page.
* sort\_by (string, optional): Field to sort by.
* sort\_order (string, optional): Sort order (ASC or DESC).
* tagDatabases (array of strings, optional): Filter by tag databases.
* tagKeys (array of strings, optional): Filter by tag keys.
* tagSchemas (array of strings, optional): Filter by tag schemas.
* tagValues (array of strings, optional): Filter by tag values.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A paginated list of data source tag references.
  * **Body:** JSON

```json
{
  "pageNo": 9155,
  "pageSize": 1219,
  "total": 1276
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: No tag references found matching the criteria.

#### GET

```
/api/account_tag/tags
```

**Description:** Retrieves a list of data source tags with pagination and filtering.

**Parameters:**

* accountId (string, required): The ID of the account.
* page\_no (integer, optional, default: 1): Page number for pagination.
* page\_size (integer, optional, default: 10): Number of items per page.
* sort\_by (string, optional): Field to sort by.
* sort\_order (string, optional): Sort order (ASC or DESC).
* tagDatabases (array of strings, optional): Filter by tag databases.
* tagNames (array of strings, optional): Filter by tag names.
* tagSchemas (array of strings, optional): Filter by tag schemas.
* tagValues (array of strings, optional): Filter by tag values.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A paginated list of data source tags.
  * **Body:** JSON

```json
{
  "pageNo": 9155,
  "pageSize": 1219,
  "total": 1276
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: No tags found matching the criteria.

#### POST

```
/api/account_tag/tags
```

**Description:** Creates new data source tags.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** POST
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
[
  {
    "description": "string",
    "id": "string",
    "lastModifiedDate": "string",
    "name": "string",
    "tagDatabase": "string",
    "tagOwner": "string",
    "tagSchema": "string",
    "tagValues": "string",
    "workspace": "string"
  },
  {
    "description": "string",
    "id": "string",
    "lastModifiedDate": "string",
    "name": "string",
    "tagDatabase": "string",
    "tagOwner": "string",
    "tagSchema": "string",
    "tagValues": "string",
    "workspace": "string"
  }
]
```

**Responses:**

* 200 OK: Indicates a successful operation.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The tags were created.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### PUT

```
/api/account_tag/tags
```

**Description:** Updates existing data source tags.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** PUT
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "newTagName": "string",
  "newTagValues": "string",
  "tagDatabase": "string",
  "tagName": "string",
  "tagSchema": "string",
  "tagValues": "string"
}
```

**Responses:**

* 200 OK: Indicates a successful operation.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The tags were updated.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/account_tag/tags_metadata
```

**Description:** Retrieves tag metadata.

**Parameters:**

* accountId (string, required): The ID of the account.
* tagDatabaseName (string, optional): Filter by tag database name.
* tagKeyName (string, optional): Filter by tag key name.
* tagSchemaName (string, optional): Filter by tag schema name.
* type (string, required, default: TAG\_VALUE): The type of metadata to retrieve.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of tag metadata.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/account_tag/tags_metadata_filter
```

**Description:** Filters tag metadata.

**Parameters:**

* accountId (string, required): The ID of the account.
* tagDatabases (array of strings, optional): Filter by tag databases.
* tagNames (array of strings, optional): Filter by tag names.
* tagSchemas (array of strings, optional): Filter by tag schemas.
* type (string, required, default: TAG\_VALUE): The type of metadata to filter.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of filtered tag metadata.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: No metadata found matching the criteria.

#### POST

```
/api/account_tag/validate_tags
```

**Description:** Validates data source tags.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** POST
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "newTagName": "string",
  "newTagValues": "string",
  "tagDatabase": "string",
  "tagName": "string",
  "tagSchema": "string",
  "tagValues": "string"
}
```

**Responses:**

* 200 OK: Indicates a successful validation.
  * **Body:** JSON

```json
{
  "data": {},
  "message": "string",
  "remediationMsg": "string",
  "success": true,
  "warningMessage": "string"
}
```

* 201 Created: The tags were validated.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/authorized\_system\_entities

Manages authorized system entities.

#### GET

```
/api/authorized_system_entities/groups
```

**Description:** Lists authorized entity groups for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of authorized entity groups.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/authorized_system_entities
```

**Description:** Lists all authorized system entities for a given cloud account.

**Parameters:**

* cloudAccountId (string, required): The ID of the cloud account.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of authorized system entities.
  * **Body:** JSON

```json
[
  {
    "desc": "string",
    "groupName": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  },
  {
    "desc": "string",
    "groupName": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/authorized_system_entities
```

**Description:** Creates new authorized system entities.

**Request:**

* **Method:** POST
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "cloudAccountId": "string",
  "entityList": [
    {
      "desc": "string",
      "groupName": "string",
      "id": "string",
      "name": "string",
      "type": "string"
    },
    {
      "desc": "string",
      "groupName": "string",
      "id": "string",
      "name": "string",
      "type": "string"
    }
  ]
}
```

**Responses:**

* 200 OK: A list of created authorized system entities.
  * **Body:** JSON

```json
[
  {
    "desc": "string",
    "groupName": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  },
  {
    "desc": "string",
    "groupName": "string",
    "id": "string",
    "name": "string",
    "type": "string"
  }
]
```

* 201 Created: The entities were created.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/authorized\_system\_entity

Manages a specific authorized system entity.

#### PUT

```
/api/authorized_system_entity/:id
```

**Description:** Updates an authorized system IP record.

**Parameters:**

* id (string, required): The ID of the record to update.

**Request:**

* **Method:** PUT
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "cloudAccountId": "string",
  "entityList": [
    {
      "desc": "string",
      "groupName": "string",
      "id": "string",
      "name": "string",
      "type": "string"
    },
    {
      "desc": "string",
      "groupName": "string",
      "id": "string",
      "name": "string",
      "type": "string"
    }
  ]
}
```

**Responses:**

* 200 OK: The updated authorized system entity record.
  * **Body:** JSON

```json
{
  "desc": "string",
  "groupName": "string",
  "id": "string",
  "name": "string",
  "type": "string"
}
```

* 201 Created: The record was updated.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### DELETE

```
/api/authorized_system_entity/:id
```

**Description:** Deletes an authorized system user record by ID.

**Parameters:**

* id (string, required): The ID of the record to delete.
* type (string, required): The type of the system entity.

**Request:**

* **Method:** DELETE
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: The deleted authorized system user record.
  * **Body:** JSON

```json
{
  "desc": "string",
  "groupName": "string",
  "id": "string",
  "name": "string",
  "type": "string"
}
```

* 204 No Content: The operation was successful, but there is no response body.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.

### api/authorized\_user\_app\_mapping

Manages authorized user application mappings.

#### DELETE

```
/api/authorized_user_app_mapping/deleteByFilter
```

**Description:** Deletes records matching any combination of filters.

**Parameters:**

* accountId (string, required): The ID of the account.
* allowedIp (string, optional): The allowed IP address.
* appName (string, optional): The name of the application.
* dbType (string, optional): The database type.
* description (string, optional): The description of the mapping.
* serviceUserName (string, optional): The service user name.

**Request:**

* **Method:** DELETE
* **Headers:**
  * accountId: `<string>` (required)
  * tenantId: `<string>` (required)
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: Indicates a successful deletion.
* 204 No Content: The operation was successful, but there is no response body.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.

#### DELETE

```
/api/authorized_user_app_mapping/deleteByKey
```

**Description:** Deletes a record by composite primary key.

**Parameters:**

* accountId (string, required): The ID of the account.
* appName (string, required): The name of the application.
* serviceUserName (string, required): The service user name.
* tenantId (string, required): The ID of the tenant.

**Request:**

* **Method:** DELETE
* **Headers:**
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: Indicates a successful deletion.
* 204 No Content: The operation was successful, but there is no response body.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.

#### GET

```
/api/authorized_user_app_mapping/filter
```

**Description:** Returns records matching any combination of filters.

**Parameters:**

* accountId (string, required): The ID of the account.
* allowedIp (string, optional): The allowed IP address.
* appName (string, optional): The name of the application.
* dbType (string, optional): The database type.
* description (string, optional): The description of the mapping.
* serviceUserName (string, optional): The service user name.

**Request:**

* **Method:** GET
* **Headers:**
  * accountId: `<string>` (required)
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of filtered authorized app access records.
  * **Body:** JSON

```json
[
  {
    "allowedIp": "string",
    "appName": "string",
    "createdBy": "string",
    "createdDate": "2009-09-03T03:37:43.650Z",
    "dbType": "string",
    "deleted": true,
    "description": "string",
    "id": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "1970-08-03T22:46:06.666Z",
    "name": "string",
    "serviceUserName": "string"
  },
  {
    "allowedIp": "string",
    "appName": "string",
    "createdBy": "string",
    "createdDate": "1995-06-18T05:39:31.481Z",
    "dbType": "string",
    "deleted": false,
    "description": "string",
    "id": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "1969-04-17T20:55:18.798Z",
    "name": "string",
    "serviceUserName": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: No records found matching the criteria.

#### GET

```
/api/authorized_user_app_mapping
```

**Description:** Returns all authorized app access records.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of authorized app access records.
  * **Body:** JSON

```json
[
  {
    "allowedIp": "string",
    "appName": "string",
    "createdBy": "string",
    "createdDate": "2009-09-03T03:37:43.650Z",
    "dbType": "string",
    "deleted": true,
    "description": "string",
    "id": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "1970-08-03T22:46:06.666Z",
    "name": "string",
    "serviceUserName": "string"
  },
  {
    "allowedIp": "string",
    "appName": "string",
    "createdBy": "string",
    "createdDate": "1995-06-18T05:39:31.481Z",
    "dbType": "string",
    "deleted": false,
    "description": "string",
    "id": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "1969-04-17T20:55:18.798Z",
    "name": "string",
    "serviceUserName": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/authorized_user_app_mapping
```

**Description:** Creates a new authorized app access record.

**Parameters:**

* accountId (string, required): The ID of the account.
* tenantId (string, required): The ID of the tenant.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "allowedIp": "string",
  "appName": "string",
  "createdBy": "string",
  "createdDate": "1969-08-06T15:57:08.965Z",
  "dbType": "string",
  "deleted": false,
  "description": "string",
  "id": "string",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2022-12-06T17:02:37.024Z",
  "name": "string",
  "serviceUserName": "string"
}
```

**Responses:**

* 200 OK: The created authorized app access record.
  * **Body:** JSON

```json
{
  "allowedIp": "string",
  "appName": "string",
  "createdBy": "string",
  "createdDate": "1969-08-06T15:57:08.965Z",
  "dbType": "string",
  "deleted": false,
  "description": "string",
  "id": "string",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2022-12-06T17:02:37.024Z",
  "name": "string",
  "serviceUserName": "string"
}
```

* 201 Created: The record was created.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/health

Performs a health check of the API.

#### GET

```
/api/health
```

**Description:** Checks the health of the API.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: Indicates the API is healthy.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/login

Handles user login.

#### POST

```
/api/login
```

**Description:** Performs user login with credentials and an optional user type.

**Parameters:**

* userType (string, optional): The type of the user.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "loginId": "string",
  "password": "string",
  "totp": "string"
}
```

**Responses:**

* 200 OK: Indicates a successful login.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The login was successful.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/logout

Handles user logout.

#### POST

```
/api/logout
```

**Description:** Logs out the current user.

**Request:**

* **Method:** POST
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: Indicates a successful logout.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The user was logged out.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/metadata

Retrieves metadata information.

#### GET

```
/api/metadata/data_domain
```

**Description:** Retrieves data domains for the tenant.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of data domains.
  * **Body:** JSON

```json
[
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/display_data_types
```

**Description:** Retrieves display data types.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of display data types.
  * **Body:** JSON

```json
{
  "key_0": "string",
  "key_1": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/applicationRoles
```

**Description:** Retrieves application roles for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* applicationNames (array of strings, required): Filter by application names.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of application roles.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/applications
```

**Description:** Retrieves applications for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of applications.
  * **Body:** JSON

```json
[
  {
    "name": "string",
    "source": "string"
  },
  {
    "name": "string",
    "source": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/column_values
```

**Description:** Retrieves column values for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* columnName (string, required): The name of the column.
* workspace (string, optional): The workspace name.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of column values.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/columns
```

**Description:** Retrieves columns for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* databaseName (string, optional): The name of the database.
* isDataAttribute (boolean, optional, default: false): Filter for data attributes.
* schemaName (string, optional): The name of the schema.
* tableNames (string, required): A comma-separated list of table names.
* workspace (string, optional): The workspace name.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of columns.
  * **Body:** JSON

```json
[
  {
    "check": "string",
    "comment": "string",
    "databaseName": "string",
    "defaultValue": "string",
    "expression": "string",
    "fullDataType": "string",
    "fullyQualifiedName": "string",
    "isNull": "string",
    "isPrimaryKey": "string",
    "isUniqueKey": "string",
    "kind": "string",
    "name": "string",
    "objectNames": [
      "string",
      "string"
    ],
    "policyName": "string",
    "schemaName": "string",
    "tableName": "string",
    "type": "string"
  },
  {
    "check": "string",
    "comment": "string",
    "databaseName": "string",
    "defaultValue": "string",
    "expression": "string",
    "fullDataType": "string",
    "fullyQualifiedName": "string",
    "isNull": "string",
    "isPrimaryKey": "string",
    "isUniqueKey": "string",
    "kind": "string",
    "name": "string",
    "objectNames": [
      "string",
      "string"
    ],
    "policyName": "string",
    "schemaName": "string",
    "tableName": "string",
    "type": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/data_product
```

**Description:** Retrieves data product tags for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of data product tags.
  * **Body:** JSON

```json
[
  {
    "databaseName": "string",
    "fullTagName": "string",
    "id": "string",
    "name": "string",
    "schemaName": "string",
    "values": [
      "string",
      "string"
    ]
  },
  {
    "databaseName": "string",
    "fullTagName": "string",
    "id": "string",
    "name": "string",
    "schemaName": "string",
    "values": [
      "string",
      "string"
    ]
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/databases
```

**Description:** Retrieves databases for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* domain (string, optional): Filter by domain.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of databases.
  * **Body:** JSON

```json
[
  {
    "id": "string",
    "name": "string"
  },
  {
    "id": "string",
    "name": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/describe_function
```

**Description:** Retrieves descriptions of functions for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* functionName (string, required): The name of the function.
* workspace (string, optional): The workspace name.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A function description.
  * **Body:** JSON

```json
{
  "accountId": "string",
  "arguments": [
    {
      "argName": "string",
      "argValue": "string",
      "dataType": "string",
      "defaultValue": "string",
      "elementArguments": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "hideParamInConditionBuilder": false,
      "order": 1704,
      "type": "string",
      "valueArguments": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ]
    },
    {
      "argName": "string",
      "argValue": "string",
      "dataType": "string",
      "defaultValue": "string",
      "elementArguments": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "hideParamInConditionBuilder": true,
      "order": 2677,
      "type": "string",
      "valueArguments": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ]
    }
  ],
  "dataSourceType": "string",
  "databaseName": "string",
  "description": "string",
  "displayName": "string",
  "id": "string",
  "name": "string",
  "returnType": "string",
  "schemaName": "string",
  "tenantId": "string",
  "workspace": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/functions
```

**Description:** Retrieves functions for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* databaseNames (string, optional): Filter by database names.
* isMultiObject (string, optional): Filter by whether the function supports multiple objects.
* schemaNames (string, optional): Filter by schema names.
* type (string, optional, default: NONE): Filter by function type.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of functions.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/principals
```

**Description:** Retrieves principals for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* databaseNames (array of strings, optional): Filter by database names.
* includeDatabaseRoles (boolean, optional, default: true): Include database roles in the results.
* includeSystemRoles (boolean, optional, default: false): Include system roles in the results.
* tagNames (array of strings, optional): Filter by tag names.
* type (string, required, default: SERVICE\_PRINCIPAL): The type of principals to retrieve.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of principals.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/principals_with_type
```

**Description:** Retrieves principals with their types for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* databaseNames (array of strings, optional): Filter by database names.
* includeDatabaseRoles (boolean, optional, default: true): Include database roles in the results.
* includeSystemRoles (boolean, optional, default: false): Include system roles in the results.
* tagNames (array of strings, optional): Filter by tag names.
* type (string, required, default: SERVICE\_PRINCIPAL): The type of principals to retrieve.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of principals with their types.
  * **Body:** JSON

```json
[
  {
    "description": "string",
    "id": "string",
    "name": "string",
    "userType": "string"
  },
  {
    "description": "string",
    "id": "string",
    "name": "string",
    "userType": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/schemas
```

**Description:** Retrieves schemas for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* databaseNames (string, required): A comma-separated list of database names.
* domain (string, optional): Filter by domain.
* enableAllSchemas (boolean, optional, default: false): Include all schemas.
* isMultiDb (boolean, optional, default: false): Indicate if multiple databases are being queried.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of schemas.
  * **Body:** JSON

```json
[
  {
    "databaseName": "string",
    "fullyQualifiedName": "string",
    "id": "string",
    "name": "string"
  },
  {
    "databaseName": "string",
    "fullyQualifiedName": "string",
    "id": "string",
    "name": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/security_role_info
```

**Description:** Retrieves security role information for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* schemaNames (string, required): A comma-separated list of schema names.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of security role information.
  * **Body:** JSON

```json
[
  {
    "description": "string",
    "filterExpression": "string",
    "roleName": "string",
    "tableName": "string"
  },
  {
    "description": "string",
    "filterExpression": "string",
    "roleName": "string",
    "tableName": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/shares
```

**Description:** Retrieves outbound shares for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* databaseName (string, optional): The name of the database.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of outbound shares.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/table_relationships
```

**Description:** Retrieves table relationships for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* schemaNames (string, required): A comma-separated list of schema names.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of table relationships.
  * **Body:** JSON

```json
[
  {
    "active": false,
    "fromCardinality": "string",
    "fromColumn": "string",
    "fromTable": "string",
    "semanticModel": "string",
    "toCardinality": "string",
    "toColumn": "string",
    "toTable": "string",
    "workspace": "string"
  },
  {
    "active": false,
    "fromCardinality": "string",
    "fromColumn": "string",
    "fromTable": "string",
    "semanticModel": "string",
    "toCardinality": "string",
    "toColumn": "string",
    "toTable": "string",
    "workspace": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/tables
```

**Description:** Retrieves tables for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* database (string, optional): The name of the database.
* domain (string, optional): The domain name.
* objectType (string, optional, default: VIEW): The type of the object.
* schemaNames (string, optional): A comma-separated list of schema names.
* search (string, optional): Search for tables by name.
* workspace (string, optional): The workspace name.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of tables.
  * **Body:** JSON

```json
[
  {
    "databaseName": "string",
    "fullyQualifiedName": "string",
    "name": "string",
    "schemaName": "string",
    "semanticModel": [
      "string",
      "string"
    ],
    "serverName": "string",
    "sourceServers": [
      "string",
      "string"
    ],
    "tableOwner": "string",
    "type": "string"
  },
  {
    "databaseName": "string",
    "fullyQualifiedName": "string",
    "name": "string",
    "schemaName": "string",
    "semanticModel": [
      "string",
      "string"
    ],
    "serverName": "string",
    "sourceServers": [
      "string",
      "string"
    ],
    "tableOwner": "string",
    "type": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/tags
```

**Description:** Retrieves tags for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* domain (string, optional, default: COLUMN): Filter by domain.
* includeTagValue (boolean, optional, default: true): Include tag values in the results.
* includeUnclassifiedTag (boolean, optional, default: false): Include unclassified tags.
* policyTypeId (string, optional): Filter by policy type ID.
* tagNames (string, optional): Filter by tag names.
* workspace (string, optional): Filter by workspace.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of tags.
  * **Body:** JSON

```json
[
  {
    "databaseName": "string",
    "fullTagName": "string",
    "id": "string",
    "name": "string",
    "schemaName": "string",
    "values": [
      "string",
      "string"
    ]
  },
  {
    "databaseName": "string",
    "fullTagName": "string",
    "id": "string",
    "name": "string",
    "schemaName": "string",
    "values": [
      "string",
      "string"
    ]
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/metadata/:accountId/workspaces
```

**Description:** Retrieves workspaces for a given account.

**Parameters:**

* accountId (string, required): The ID of the account.
* registered (boolean, optional, default: false): Filter for registered workspaces.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of workspaces.
  * **Body:** JSON

```json
[
  {
    "deploymentName": "string",
    "id": "string",
    "name": "string"
  },
  {
    "deploymentName": "string",
    "id": "string",
    "name": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/monitoring\_policies

Manages monitoring policies.

#### PUT

```
/api/monitoring_policies/:id/activate/:status
```

**Description:** Enables or disables a monitoring policy.

**Parameters:**

* id (string, required): The ID of the policy to activate/deactivate.
* status (boolean, required): The new status of the policy (true for active, false for inactive).

**Request:**

* **Method:** PUT
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: Indicates a successful operation.
  * **Body:** JSON

```json
{
  "key_0": "string",
  "key_1": "string"
}
```

* 201 Created: The policy was enabled/disabled.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/monitoring_policies/:id
```

**Description:** Retrieves a single monitoring policy record by its ID.

**Parameters:**

* id (string, required): The ID of the policy to retrieve.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: The requested monitoring policy record.
  * **Body:** JSON

```json
{
  "dataSourceType": "string",
  "name": "string",
  "accounts": [
    "string",
    "string"
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "alertCount": 7935,
  "alertFrequency": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "alertManagement": "string",
  "complianceTags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "dataClassification": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "dataSize": "string",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isSystemPolicy": false,
  "lastModifiedBy": "string",
  "lastModifiedDate": "2023-07-16T21:05:54.428Z",
  "listType": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "matchingCondition": "string",
  "policyType": "string",
  "principalConditionData": "string",
  "principals": [
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    },
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " '"
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    }
  ],
  "queryText": "string",
  "resourceType": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "riskCategory": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "severity": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "tenantId": "string",
  "ticketDetails": "string",
  "timeThreshold": "string",
  "violationThreshold": 3045,
  "workspace": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### DELETE

```
/api/monitoring_policies/:id
```

**Description:** Deletes a monitoring policy by ID.

**Parameters:**

* id (string, required): The ID of the policy to delete.

**Request:**

* **Method:** DELETE
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: Indicates a successful deletion.
  * **Body:** JSON

```json
{
  "key_0": "string",
  "key_1": "string"
}
```

* 204 No Content: The operation was successful, but there is no response body.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.

#### POST

```
/api/monitoring_policies
```

**Description:** Creates a new monitoring policy.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "accounts": [
    "string",
    "string"
  ],
  "actions": [
    "string",
    "string"
  ],
  "alertCount": 6213,
  "alertFrequency": "string",
  "alertManagement": "string",
  "complianceTags": "string",
  "dataClassification": [
    "string",
    "string"
  ],
  "dataSize": "string",
  "dataSourceType": "string",
  "description": "string",
  "id": "string",
  "isActive": false,
  "isSystemPolicy": false,
  "listType": "string",
  "matchingCondition": "string",
  "name": "string",
  "policyType": "string",
  "principalConditionData": "string",
  "principals": [
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    },
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    }
  ],
  "queryText": "string",
  "resourceType": "string",
  "resourceValue": [
    "string",
    "string"
  ],
  "riskCategory": "string",
  "severity": "string",
  "tenantId": "string",
  "ticketDetails": "string",
  "timeThreshold": "string",
  "violationThreshold": 3640,
  "workspace": "string"
}
```

**Responses:**

* 200 OK: The created monitoring policy.
  * **Body:** JSON

```json
{
  "dataSourceType": "string",
  "name": "string",
  "accounts": [
    "string",
    "string"
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "alertCount": 7935,
  "alertFrequency": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "alertManagement": "string",
  "complianceTags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "dataClassification": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "dataSize": "string",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isSystemPolicy": false,
  "lastModifiedBy": "string",
  "lastModifiedDate": "2023-07-16T21:05:54.428Z",
  "listType": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "matchingCondition": "string",
  "policyType": "string",
  "principalConditionData": "string",
  "principals": [
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    },
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    }
  ],
  "queryText": "string",
  "resourceType": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "riskCategory": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "severity": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "tenantId": "string",
  "ticketDetails": "string",
  "timeThreshold": "string",
  "violationThreshold": 3045,
  "workspace": "string"
}
```

* 201 Created: The policy was created.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### PUT

```
/api/monitoring_policies/:id
```

**Description:** Updates an existing monitoring policy.

**Parameters:**

* id (string, required): The ID of the policy to update.

**Request:**

* **Method:** PUT
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "accounts": [
    "string",
    "string"
  ],
  "actions": [
    "string",
    "string"
  ],
  "alertCount": 6213,
  "alertFrequency": "string",
  "alertManagement": "string",
  "complianceTags": "string",
  "dataClassification": [
    "string",
    "string"
  ],
  "dataSize": "string",
  "dataSourceType": "string",
  "description": "string",
  "id": "string",
  "isActive": false,
  "isSystemPolicy": false,
  "listType": "string",
  "matchingCondition": "string",
  "name": "string",
  "policyType": "string",
  "principalConditionData": "string",
  "principals": [
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    },
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    }
  ],
  "queryText": "string",
  "resourceType": "string",
  "resourceValue": [
    "string",
    "string"
  ],
  "riskCategory": "string",
  "severity": "string",
  "tenantId": "string",
  "ticketDetails": "string",
  "timeThreshold": "string",
  "violationThreshold": 3640,
  "workspace": "string"
}
```

**Responses:**

* 200 OK: The updated monitoring policy.
  * **Body:** JSON

```json
{
  "dataSourceType": "string",
  "name": "string",
  "accounts": [
    "string",
    "string"
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "alertCount": 7935,
  "alertFrequency": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "alertManagement": "string",
  "complianceTags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "dataClassification": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "dataSize": "string",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isSystemPolicy": false,
  "lastModifiedBy": "string",
  "lastModifiedDate": "2023-07-16T21:05:54.428Z",
  "listType": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "matchingCondition": "string",
  "policyType": "string",
  "principalConditionData": "string",
  "principals": [
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    },
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    }
  ],
  "queryText": "string",
  "resourceType": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "riskCategory": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "severity": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "tenantId": "string",
  "ticketDetails": "string",
  "timeThreshold": "string",
  "violationThreshold": 3045,
  "workspace": "string"
}
```

* 201 Created: The policy was updated.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/user

Manages user information.

#### GET

```
/api/user
```

**Description:** Lists all users for a given tenant.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of users.
  * **Body:** JSON

```json
[
  {
    "accessType": "string",
    "accountNonLocked": true,
    "attributeMapping": [
      {
        "accountId": "string",
        "attributeContextValues": "string",
        "attributeKey": "string",
        "attributeValue": "string",
        "domain": "string",
        "entityKey": "string",
        "entityType": "string"
      },
      {
        "accountId": "string",
        "attributeContextValues": "string",
        "attributeKey": "string",
        "attributeValue": "string",
        "domain": "string",
        "entityKey": "string",
        "entityType": "string"
      }
    ],
    "configParameters": "string",
    "createdBy": "string",
    "createdDate": "1970-12-14T09:13:12.725Z",
    "deleted": false,
    "description": "string",
    "email": "string",
    "failedAttempt": 8685,
    "id": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "2013-05-26T10:01:11.667Z",
    "lockTime": "2001-02-03T11:31:28.692Z",
    "loggedIn": false,
    "loginId": "string",
    "mfaEnableDate": "1964-12-23T14:16:56.980Z",
    "mfaEnabled": false,
    "name": "string",
    "phone": "string",
    "roleIds": [
      "string",
      "string"
    ],
    "roles": [
      {
        "createdBy": "string",
        "createdDate": "1996-07-26T20:45:49.814Z",
        "deleted": true,
        "description": "string",
        "id": "string",
        "lastModifiedBy": "string",
        "lastModifiedDate": "1993-12-22T09:28:06.871Z",
        "name": "string",
        "sequence": 9663
      },
      {
        "createdBy": "string",
        "createdDate": "1971-05-10T15:45:24.171Z",
        "deleted": false,
        "description": "string",
        "id": "string",
        "lastModifiedBy": "string",
        "lastModifiedDate": "1974-05-06T16:56:59.506Z",
        "name": "string",
        "sequence": 1388
      }
    ],
    "skipSso": false,
    "tenantId": "string",
    "userType": "string"
  },
  {
    "accessType": "string",
    "accountNonLocked": false,
    "attributeMapping": [
      {
        "accountId": "string",
        "attributeContextValues": "string",
        "attributeKey": "string",
        "attributeValue": "string",
        "domain": "string",
        "entityKey": "string",
        "entityType": "string"
      },
      {
        "accountId": "string",
        "attributeContextValues": "string",
        "attributeKey": "string",
        "attributeValue": "string",
        "domain": "string",
        "entityKey": "string",
        "entityType": "string"
      }
    ],
    "configParameters": "string",
    "createdBy": "string",
    "createdDate": "2011-07-31T20:11:17.764Z",
    "deleted": false,
    "description": "string",
    "email": "string",
    "failedAttempt": 1248,
    "id": "string",
    "lastModifiedBy": "string",
    "lastModifiedDate": "2000-09-17T04:19:02.576Z",
    "lockTime": "2005-10-12T14:21:05.551Z",
    "loggedIn": true,
    "loginId": "string",
    "mfaEnableDate": "2003-03-19T08:57:23.081Z",
    "mfaEnabled": false,
    "name": "string",
    "phone": "string",
    "roleIds": [
      "string",
      "string"
    ],
    "roles": [
      {
        "createdBy": "string",
        "createdDate": "1953-06-28T17:07:26.420Z",
        "deleted": false,
        "description": "string",
        "id": "string",
        "lastModifiedBy": "string",
        "lastModifiedDate": "2007-09-12T03:45:09.154Z",
        "name": "string",
        "sequence": 4803
      },
      {
        "createdBy": "string",
        "createdDate": "1969-02-01T00:55:02.416Z",
        "deleted": false,
        "description": "string",
        "id": "string",
        "lastModifiedBy": "string",
        "lastModifiedDate": "1956-11-23T06:16:10.266Z",
        "name": "string",
        "sequence": 7488
      }
    ],
    "skipSso": false,
    "tenantId": "string",
    "userType": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/userInfo

Retrieves user information.

#### GET

```
/api/userInfo
```

**Description:** Retrieves information about the currently logged-in user.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: The user's information.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/user\_attribute\_configuration

Manages user attribute configurations.

#### POST

```
/api/user_attribute_configuration/import_attributes
```

**Description:** Imports user attributes from an external source.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: */*
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "attributes": [
    {
      "accountId": "string",
      "actualDataType": "string",
      "attributeGroupName": "string",
      "attributeLevelUdf": [
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        },
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        }
      ],
      "configurationValue": "string",
      "createdBy": "string",
      "createdDate": "1985-11-25T15:44:43.240Z",
      "dataProduct": "string",
      "deleted": false,
      "deriveType": "HIERARCHICAL",
      "description": "string",
      "displayName": "string",
      "elementType": "string",
      "failMessage": "string",
      "id": "string",
      "isMultiValue": false,
      "isSessionUser": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "1961-06-18T17:18:29.899Z",
      "name": "string",
      "size": "string",
      "sourceAttributeName": "string",
      "status": "string",
      "tenantId": "string",
      "type": "string",
      "userAttributeConfigurationId": "string"
    },
    {
      "accountId": "string",
      "actualDataType": "string",
      "attributeGroupName": "string",
      "attributeLevelUdf": [
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        },
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        }
      ],
      "configurationValue": "string",
      "createdBy": "string",
      "createdDate": "1970-09-09T05:43:20.724Z",
      "dataProduct": "string",
      "deleted": false,
      "deriveType": "NOT_DERIVE",
      "description": "string",
      "displayName": "string",
      "elementType": "string",
      "failMessage": "string",
      "id": "string",
      "isMultiValue": false,
      "isSessionUser": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "1960-11-28T08:57:46.305Z",
      "name": "string",
      "size": "string",
      "sourceAttributeName": "string",
      "status": "string",
      "tenantId": "string",
      "type": "string",
      "userAttributeConfigurationId": "string"
    }
  ],
  "externalIntegrationId": "string",
  "targetDatasource": [
    {
      "accountId": "string",
      "dataProduct": "string"
    },
    {
      "accountId": "string",
      "dataProduct": "string"
    }
  ]
}
```

**Responses:**

* 200 OK: Indicates a successful import.
  * **Body:** JSON

```json
[
  {
    "accountId": "string",
    "failedMessage": "string",
    "status": "string"
  },
  {
    "accountId": "string",
    "failedMessage": "string",
    "status": "string"
  }
]
```

* 201 Created: The attributes were imported.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/user_attribute_configuration/source
```

**Description:** Retrieves a list of user attribute sources.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of user attribute sources.
  * **Body:** JSON

```json
[
  {
    "id": "string",
    "name": "string",
    "sourceType": "string",
    "type": "string"
  },
  {
    "id": "string",
    "name": "string",
    "sourceType": "string",
    "type": "string"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/user_attribute_configuration/:id/attributes
```

**Description:** Retrieves user attributes from an external source.

**Parameters:**

* id (string, required): The ID of the user attribute configuration.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of user attributes.
  * **Body:** JSON

```json
[
  {
    "availableInPortal": false,
    "description": "string",
    "displayName": "string",
    "multiValue": false,
    "name": "string",
    "type": "string",
    "usedInUserFlows": true
  },
  {
    "availableInPortal": false,
    "description": "string",
    "displayName": "string",
    "multiValue": true,
    "name": "string",
    "type": "string",
    "usedInUserFlows": false
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/user_attribute_configuration/:id/users/import
```

**Description:** Imports users and their attributes from an external source to a data source.

**Parameters:**

* id (string, required): The ID of the user attribute configuration.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: */*
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "attributeAndValue": [
    {
      "key_0": {},
      "key_1": {},
      "key_2": {}
    },
    {
      "key_0": {}
    }
  ],
  "targetDatasource": [
    {
      "accountId": "string",
      "dataProduct": "string"
    },
    {
      "accountId": "string",
      "dataProduct": "string"
    }
  ]
}
```

**Responses:**

* 200 OK: Indicates a successful import.
  * **Body:** JSON

```json
[
  {
    "accountId": "string",
    "failedMessage": "string",
    "status": "string"
  },
  {
    "accountId": "string",
    "failedMessage": "string",
    "status": "string"
  }
]
```

* 201 Created: The users were imported.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/user_attribute_configuration/:id/users
```

**Description:** Retrieves users from an external source.

**Parameters:**

* id (string, required): The ID of the user attribute configuration.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "params": [
    {
      "name": "string",
      "value": "string"
    },
    {
      "name": "string",
      "value": "string"
    }
  ],
  "targetDatasource": [
    {
      "accountId": "string",
      "dataProduct": "string"
    },
    {
      "accountId": "string",
      "dataProduct": "string"
    }
  ]
}
```

**Responses:**

* 200 OK: A list of users from the external source.
  * **Body:** JSON

```json
{
  "columns": [
    {
      "availableInPortal": false,
      "description": "string",
      "displayName": "string",
      "multiValue": false,
      "name": "string",
      "type": "string",
      "usedInUserFlows": false
    },
    {
      "availableInPortal": false,
      "description": "string",
      "displayName": "string",
      "multiValue": false,
      "name": "string",
      "type": "string",
      "usedInUserFlows": true
    }
  ],
  "values": [
    {
      "key_0": {},
      "key_1": {},
      "key_2": {},
      "key_3": {}
    },
    {
      "key_0": {}
    }
  ]
}
```

* 201 Created: The users were retrieved.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### GET

```
/api/user_attribute_configuration/:id
```

**Description:** Retrieves a user attribute configuration by ID.

**Parameters:**

* id (string, required): The ID of the user attribute configuration.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: The user attribute configuration.
  * **Body:** JSON

```json
{
  "configType": "string",
  "configTypeId": "string",
  "configurationName": "string",
  "id": "string",
  "parameters": [
    {
      "displayName": "string",
      "order": 6097,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": false
    },
    {
      "displayName": "string",
      "order": 6470,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": true
    }
  ],
  "status": "SUCCESS"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### PUT

```
/api/user_attribute_configuration/:id
```

**Description:** Updates a user attribute configuration.

**Parameters:**

* id (string, required): The ID of the user attribute configuration to update.

**Request:**

* **Method:** PUT
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "configType": "string",
  "configTypeId": "string",
  "configurationName": "string",
  "id": "string",
  "parameters": [
    {
      "displayName": "string",
      "order": 6097,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": false
    },
    {
      "displayName": "string",
      "order": 6470,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": true
    }
  ],
  "status": "SUCCESS"
}
```

**Responses:**

* 200 OK: Indicates a successful update.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The configuration was updated.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### DELETE

```
/api/user_attribute_configuration/:id
```

**Description:** Deletes a user attribute configuration by ID.

**Parameters:**

* id (string, required): The ID of the user attribute configuration to delete.

**Request:**

* **Method:** DELETE
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: Indicates a successful deletion.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 204 No Content: The operation was successful, but there is no response body.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.

#### GET

```
/api/user_attribute_configuration
```

**Description:** Retrieves user attribute configurations with optional account ID.

**Parameters:**

* accountId (string, optional): The ID of the account.

**Request:**

* **Method:** GET
* **Headers:**
  * tenantId: `<string>` (required)
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of user attribute configurations.
  * **Body:** JSON

```json
[
  {
    "configType": "string",
    "configTypeId": "string",
    "configurationName": "string",
    "id": "string",
    "parameters": [
      {
        "displayName": "string",
        "order": 2850,
        "parameterName": "string",
        "parameterType": "string",
        "parameterValue": "string",
        "required": false
      },
      {
        "displayName": "string",
        "order": 5093,
        "parameterName": "string",
        "parameterType": "string",
        "parameterValue": "string",
        "required": false
      }
    ],
    "status": "FAILED"
  },
  {
    "configType": "string",
    "configTypeId": "string",
    "configurationName": "string",
    "id": "string",
    "parameters": [
      {
        "displayName": "string",
        "order": 716,
        "parameterName": "string",
        "parameterType": "string",
        "parameterValue": "string",
        "required": true
      },
      {
        "displayName": "string",
        "order": 4658,
        "parameterName": "string",
        "parameterType": "string",
        "parameterValue": "string",
        "required": true
      }
    ],
    "status": "SUCCESS"
  }
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/user_attribute_configuration
```

**Description:** Saves a new user attribute configuration.

**Request:**

* **Method:** POST
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "configType": "string",
  "configTypeId": "string",
  "configurationName": "string",
  "id": "string",
  "parameters": [
    {
      "displayName": "string",
      "order": 6097,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": false
    },
    {
      "displayName": "string",
      "order": 6470,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": true
    }
  ],
  "status": "SUCCESS"
}
```

**Responses:**

* 200 OK: Indicates a successful save.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The configuration was saved.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### PUT

```
/api/user_attribute_configuration
```

**Description:** Updates a user attribute configuration.

**Parameters:**

* accountId (string, required): The ID of the account.
* tableId (string, optional): The ID of the table.

**Request:**

* **Method:** PUT
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "entitlementColumns": [
    {
      "accountId": "string",
      "actualDataType": "string",
      "attributeGroupName": "string",
      "attributeLevelUdf": [
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        },
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        }
      ],
      "configurationValue": "string",
      "createdBy": "string",
      "createdDate": "2001-02-05T16:21:22.516Z",
      "dataProduct": "string",
      "deleted": false,
      "deriveType": "HIERARCHICAL",
      "description": "string",
      "displayName": "string",
      "elementType": "string",
      "failMessage": "string",
      "id": "string",
      "isMultiValue": false,
      "isSessionUser": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "2002-12-15T09:33:03.080Z",
      "name": "string",
      "size": "string",
      "sourceAttributeName": "string",
      "status": "string",
      "tenantId": "string",
      "type": "string",
      "userAttributeConfigurationId": "string"
    },
    {
      "accountId": "string",
      "actualDataType": "string",
      "attributeGroupName": "string",
      "attributeLevelUdf": [
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        },
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        }
      ],
      "configurationValue": "string",
      "createdBy": "string",
      "createdDate": "2000-05-03T23:08:44.889Z",
      "dataProduct": "string",
      "deleted": false,
      "deriveType": "HIERARCHICAL_RECURSIVE",
      "description": "string",
      "displayName": "string",
      "elementType": "string",
      "failMessage": "string",
      "id": "string",
      "isMultiValue": false,
      "isSessionUser": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "1948-07-31T17:28:29.056Z",
      "name": "string",
      "size": "string",
      "sourceAttributeName": "string",
      "status": "string",
      "tenantId": "string",
      "type": "string",
      "userAttributeConfigurationId": "string"
    }
  ],
  "entitlementTable": "string",
  "id": "string",
  "status": "string",
  "statusDetails": "string"
}
```

**Responses:**

* 200 OK: The updated user attributes metadata.
  * **Body:** JSON

```json
{
  "entitlementColumns": [
    {
      "accountId": "string",
      "actualDataType": "string",
      "attributeGroupName": "string",
      "attributeLevelUdf": [
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        },
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        }
      ],
      "configurationValue": "string",
      "createdBy": "string",
      "createdDate": "2001-02-05T16:21:22.516Z",
      "dataProduct": "string",
      "deleted": false,
      "deriveType": "HIERARCHICAL",
      "description": "string",
      "displayName": "string",
      "elementType": "string",
      "failMessage": "string",
      "id": "string",
      "isMultiValue": false,
      "isSessionUser": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "2002-12-15T09:33:03.080Z",
      "name": "string",
      "size": "string",
      "sourceAttributeName": "string",
      "status": "string",
      "tenantId": "string",
      "type": "string",
      "userAttributeConfigurationId": "string"
    },
    {
      "accountId": "string",
      "actualDataType": "string",
      "attributeGroupName": "string",
      "attributeLevelUdf": [
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        },
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        }
      ],
      "configurationValue": "string",
      "createdBy": "string",
      "createdDate": "2000-05-03T23:08:44.889Z",
      "dataProduct": "string",
      "deleted": false,
      "deriveType": "HIERARCHICAL_RECURSIVE",
      "description": "string",
      "displayName": "string",
      "elementType": "string",
      "failMessage": "string",
      "id": "string",
      "isMultiValue": false,
      "isSessionUser": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "1948-07-31T17:28:29.056Z",
      "name": "string",
      "size": "string",
      "sourceAttributeName": "string",
      "status": "string",
      "tenantId": "string",
      "type": "string",
      "userAttributeConfigurationId": "string"
    }
  ],
  "entitlementTable": "string",
  "id": "string",
  "status": "string",
  "statusDetails": "string"
}
```

* 201 Created: The configuration was updated.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### PATCH

```
/api/user_entitlement_attribute
```

**Description:** Updates details of a user attributes table metadata.

**Parameters:**

* accountId (string, required): The ID of the account.
* id (string, required): The ID of the user attributes table metadata.

**Request:**

* **Method:** PATCH
* **Headers:**
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "accountId": "string",
  "actualDataType": "string",
  "attributeGroupName": "string",
  "attributeLevelUdf": [
    {
      "arguments": "string",
      "description": "string",
      "failMessage": "string",
      "returnType": "string",
      "sampleUsage": "string",
      "status": "string",
      "udfDefinition": "string",
      "udfName": "string"
    },
    {
      "arguments": "string",
      "description": "string",
      "failMessage": "string",
      "returnType": "string",
      "sampleUsage": "string",
      "status": "string",
      "udfDefinition": "string",
      "udfName": "string"
    }
  ],
  "configurationValue": "string",
  "createdBy": "string",
  "createdDate": "1987-07-22T01:01:02.840Z",
  "dataProduct": "string",
  "deleted": false,
  "deriveType": "HIERARCHICAL_RECURSIVE",
  "description": "string",
  "displayName": "string",
  "elementType": "string",
  "failMessage": "string",
  "id": "string",
  "isMultiValue": false,
  "isSessionUser": false,
  "lastModifiedBy": "string",
  "lastModifiedDate": "1994-04-16T15:34:51.449Z",
  "name": "string",
  "size": "string",
  "sourceAttributeName": "string",
  "status": "string",
  "tenantId": "string",
  "type": "string",
  "userAttributeConfigurationId": "string"
}
```

**Responses:**

* 200 OK: The updated user attributes table metadata.
  * **Body:** JSON

```json
{
  "entitlementColumns": [
    {
      "accountId": "string",
      "actualDataType": "string",
      "attributeGroupName": "string",
      "attributeLevelUdf": [
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        },
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        }
      ],
      "configurationValue": "string",
      "createdBy": "string",
      "createdDate": "2001-02-05T16:21:22.516Z",
      "dataProduct": "string",
      "deleted": false,
      "deriveType": "HIERARCHICAL",
      "description": "string",
      "displayName": "string",
      "elementType": "string",
      "failMessage": "string",
      "id": "string",
      "isMultiValue": false,
      "isSessionUser": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "2002-12-15T09:33:03.080Z",
      "name": "string",
      "size": "string",
      "sourceAttributeName": "string",
      "status": "string",
      "tenantId": "string",
      "type": "string",
      "userAttributeConfigurationId": "string"
    },
    {
      "accountId": "string",
      "actualDataType": "string",
      "attributeGroupName": "string",
      "attributeLevelUdf": [
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        },
        {
          "arguments": "string",
          "description": "string",
          "failMessage": "string",
          "returnType": "string",
          "sampleUsage": "string",
          "status": "string",
          "udfDefinition": "string",
          "udfName": "string"
        }
      ],
      "configurationValue": "string",
      "createdBy": "string",
      "createdDate": "2000-05-03T23:08:44.889Z",
      "dataProduct": "string",
      "deleted": false,
      "deriveType": "HIERARCHICAL_RECURSIVE",
      "description": "string",
      "displayName": "string",
      "elementType": "string",
      "failMessage": "string",
      "id": "string",
      "isMultiValue": false,
      "isSessionUser": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "1948-07-31T17:28:29.056Z",
      "name": "string",
      "size": "string",
      "sourceAttributeName": "string",
      "status": "string",
      "tenantId": "string",
      "type": "string",
      "userAttributeConfigurationId": "string"
    }
  ],
  "entitlementTable": "string",
  "id": "string",
  "status": "string",
  "statusDetails": "string"
}
```

* 204 No Content: The operation was successful, but there is no response body.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/user\_attribute\_configuration\_type

Retrieves user attribute configuration types.

#### GET

```
/api/user_attribute_configuration_type/:id
```

**Description:** Retrieves a user attribute configuration type by ID.

**Parameters:**

* id (string, required): The ID of the user attribute configuration type.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: The user attribute configuration type.
  * **Body:** JSON

```json
{
  "configType": "string",
  "datasourceType": "string",
  "id": "string",
  "name": "string",
  "parameters": [
    {
      "displayName": "string",
      "order": 1963,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": true
    },
    {
      "displayName": "string",
      "order": 2901,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": false
    }
  ],
  "userAttributeColumnConfigurationMetadata": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/user\_attribute\_configuration\_type\_by\_source\_type

Retrieves user attribute configuration types by source type.

#### GET

```
/api/user_attribute_configuration_type_by_source_type/:sourceType
```

**Description:** Retrieves a user attribute configuration type by source type.

**Parameters:**

* sourceType (string, required): The source type of the user attribute configuration.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: The user attribute configuration type.
  * **Body:** JSON

```json
{
  "configType": "string",
  "datasourceType": "string",
  "id": "string",
  "name": "string",
  "parameters": [
    {
      "displayName": "string",
      "order": 1963,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": true
    },
    {
      "displayName": "string",
      "order": 2901,
      "parameterName": "string",
      "parameterType": "string",
      "parameterValue": "string",
      "required": false
    }
  ],
  "userAttributeColumnConfigurationMetadata": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/user\_attribute\_value

Manages user attribute values.

#### GET

```
/api/user_attribute_value
```

**Description:** Retrieves a list of user attribute values.

**Parameters:**

* accountId (string, required): The ID of the account.
* attributeName (string, required): The name of the attribute.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A list of user attribute values.
  * **Body:** JSON

```json
[
  "string",
  "string"
]
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/user_entitlement_attribute/export
```

**Description:** Exports user attributes.

**Request:**

* **Method:** POST
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: application/json
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:** JSON

```json
{
  "accountId": [
    "string",
    "string"
  ],
  "attributeCode": [
    "string",
    "string"
  ],
  "attributeGroupNames": [
    "string",
    "string"
  ],
  "attributeName": [
    "string",
    "string"
  ],
  "dataProduct": [
    "string",
    "string"
  ]
}
```

**Responses:**

* 200 OK: The exported data.
  * **Body:** string
* 201 Created: The export was successful.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

#### POST

```
/api/user_entitlement_attribute/import
```

**Description:** Imports user attributes from a CSV file.

**Request:**

* **Method:** POST
* **Headers:**
  * tenantId: `<string>` (required)
  * Content-Type: multipart/form-data
  * Accept: application/json
  * Authorization: `<API Key>`
* **Body:**
  * accountId (string): The ID of the account.
  * file (file): The CSV file to import.

**Responses:**

* 200 OK: Indicates a successful import.
  * **Body:** JSON

```json
{
  "code": 7647,
  "data": {},
  "message": "string"
}
```

* 201 Created: The import was successful.
* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.

### api/v2/monitoring\_policies

Manages monitoring policies with advanced filtering.

#### GET

```
/api/v2/monitoring_policies
```

**Description:** Retrieves a list of monitoring policies with pagination and filtering.

**Parameters:**

* accountId (string, required): The ID of the account.
* complianceTags (array of strings, optional): Filter by compliance tags.
* page\_no (integer, optional, default: 1): Page number for pagination.
* page\_size (integer, optional, default: 20): Number of items per page.
* policyName (array of strings, optional): Filter by policy names.
* riskCategory (array of strings, optional): Filter by risk categories.
* riskCount (string, optional): Filter by risk count.
* severity (array of strings, optional): Filter by severity levels.
* sort\_by (string, optional, default: lastModifiedDate): Field to sort by.
* sort\_order (string, optional, default: DESC): Sort order (ASC or DESC).
* status (array of strings, optional): Filter by policy status.
* workspace (array of strings, optional): Filter by workspaces.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: A paginated list of monitoring policies.
  * **Body:** JSON

```json
{
  "items": [
    {
      "dataSourceType": "string",
      "name": "string",
      "accounts": [
        "string",
        "string"
      ],
      "actions": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ],
      "alertCount": 9864,
      "alertFrequency": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "alertManagement": "string",
      "complianceTags": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ],
      "dataClassification": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ],
      "dataSize": "string",
      "description": "string",
      "id": "string",
      "isActive": false,
      "isSystemPolicy": false,
      "lastModifiedBy": "string",
      "lastModifiedDate": "1991-03-16T19:32:42.408Z",
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "matchingCondition": "string",
      "policyType": "string",
      "principalConditionData": "string",
      "principals": [
        {
          "conditionType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "listType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "principalType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "principalValue": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "similarActions": [
                {
                  "value": " "
                },
                {
                  "value": " "
                }
              ],
              "supportedFields": "string",
              "value": [
                "string",
                "string"
              ]
            },
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "similarActions": [
                {
                  "value": " "
                },
                {
                  "value": " "
                }
              ],
              "supportedFields": "string",
              "value": [
                "string",
                "string"
              ]
            }
          ]
        },
        {
          "conditionType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "listType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "principalType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "principalValue": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "similarActions": [
                {
                  "value": " "
                },
                {
                  "value": " "
                }
              ],
              "supportedFields": "string",
              "value": [
                "string",
                "string"
              ]
            },
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "similarActions": [
                {
                  "value": " "
                },
                {
                  "value": " "
                }
              ],
              "supportedFields": "string",
              "value": [
                "string",
                "string"
              ]
            }
          ]
        }
      ],
      "queryText": "string",
      "resourceType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "riskCategory": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "severity": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "tenantId": "string",
      "ticketDetails": "string",
      "timeThreshold": "string",
      "violationThreshold": 6213,
      "workspace": "string"
    },
    {
      "dataSourceType": "string",
      "name": "string",
      "accounts": [
        "string",
        "string"
      ],
      "actions": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ],
      "alertCount": 9447,
      "alertFrequency": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "alertManagement": "string",
      "complianceTags": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ],
      "dataClassification": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ],
      "dataSize": "string",
      "description": "string",
      "id": "string",
      "isActive": true,
      "isSystemPolicy": true,
      "lastModifiedBy": "string",
      "lastModifiedDate": "1959-03-14T20:23:22.859Z",
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "matchingCondition": "string",
      "policyType": "string",
      "principalConditionData": "string",
      "principals": [
        {
          "conditionType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "listType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "principalType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "principalValue": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "similarActions": [
                {
                  "value": " "
                },
                {
                  "value": " "
                }
              ],
              "supportedFields": "string",
              "value": [
                "string",
                "string"
              ]
            },
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "similarActions": [
                {
                  "value": " "
                },
                {
                  "value": " "
                }
              ],
              "supportedFields": "string",
              "value": [
                "string",
                "string"
              ]
            }
          ]
        },
        {
          "conditionType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "listType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "principalType": {
            "id": "string",
            "name": "string",
            "description": "string",
            "similarActions": [
              {
                "value": " "
              },
              {
                "value": " "
              }
            ],
            "supportedFields": "string",
            "value": [
              "string",
              "string"
            ]
          },
          "principalValue": [
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "similarActions": [
                {
                  "value": " "
                },
                {
                  "value": " "
                }
              ],
              "supportedFields": "string",
              "value": [
                "string",
                "string"
              ]
            },
            {
              "id": "string",
              "name": "string",
              "description": "string",
              "similarActions": [
                {
                  "value": " "
                },
                {
                  "value": " "
                }
              ],
              "supportedFields": "string",
              "value": [
                "string",
                "string"
              ]
            }
          ]
        }
      ],
      "queryText": "string",
      "resourceType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "riskCategory": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "severity": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "tenantId": "string",
      "ticketDetails": "string",
      "timeThreshold": "string",
      "violationThreshold": 8984,
      "workspace": "string"
    }
  ],
  "pageNo": 8494,
  "pageSize": 5402,
  "total": 2082
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: No policies found matching the criteria.

### api/v2/monitoring\_policies/:id

Manages a specific monitoring policy with advanced features.

#### GET

```
/api/v2/monitoring_policies/:id
```

**Description:** Retrieves a single monitoring policy record by its ID.

**Parameters:**

* id (string, required): The ID of the policy to retrieve.

**Request:**

* **Method:** GET
* **Headers:**
  * Accept: application/json
  * Authorization: `<API Key>`

**Responses:**

* 200 OK: The requested monitoring policy record.
  * **Body:** JSON

```json
{
  "dataSourceType": "string",
  "name": "string",
  "accounts": [
    "string",
    "string"
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "alertCount": 7935,
  "alertFrequency": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "alertManagement": "string",
  "complianceTags": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "dataClassification": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    },
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "similarActions": [
        {
          "value": " "
        },
        {
          "value": " "
        }
      ],
      "supportedFields": "string",
      "value": [
        "string",
        "string"
      ]
    }
  ],
  "dataSize": "string",
  "description": "string",
  "id": "string",
  "isActive": true,
  "isSystemPolicy": false,
  "lastModifiedBy": "string",
  "lastModifiedDate": "2023-07-16T21:05:54.428Z",
  "listType": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "matchingCondition": "string",
  "policyType": "string",
  "principalConditionData": "string",
  "principals": [
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    },
    {
      "conditionType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "listType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalType": {
        "id": "string",
        "name": "string",
        "description": "string",
        "similarActions": [
          {
            "value": " "
          },
          {
            "value": " "
          }
        ],
        "supportedFields": "string",
        "value": [
          "string",
          "string"
        ]
      },
      "principalValue": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        },
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "similarActions": [
            {
              "value": " "
            },
            {
              "value": " "
            }
          ],
          "supportedFields": "string",
          "value": [
            "string",
            "string"
          ]
        }
      ]
    }
  ],
  "queryText": "string",
  "resourceType": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "riskCategory": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "severity": {
    "id": "string",
    "name": "string",
    "description": "string",
    "similarActions": [
      {
        "value": " "
      },
      {
        "value": " "
      }
    ],
    "supportedFields": "string",
    "value": [
      "string",
      "string"
    ]
  },
  "tenantId": "string",
  "ticketDetails": "string",
  "timeThreshold": "string",
  "violationThreshold": 3045,
  "workspace": "string"
}
```

* 401 Unauthorized: Authentication failed.
* 403 Forbidden: Insufficient permissions.
* 404 Not Found: The requested resource was not found.