datamask info

Displays data mask information.

Syntax

CLI

Use the maprcli security datamask info command to view the details of a data mask or the mask information for a table or array.

maprcli security datamask info 
     -name <mask-name>  
     [ -cluster <cluster-name> ]  
     [ -output terse | verbose ] 
     [ -columns <comma-separated list of column names> ] 
REST
Request Type GET
Request URL
http[s]://<host>:<port>/rest/security/datamask/info?<parameters>

Parameters

Parameter Description
name Name of the data mask.
cluster The cluster on which to run the command. The default cluster is the local cluster.
output Specifies whether the output should be terse or verbose. Default: verbose.
columns A comma-separated list of columns to return in the query.

By default, all columns are displayed.

Supported column names are as follows:
name
The name of the dynamic data mask. All predefined dynamic data mask names are prefixed with mrddm_.
description
The description of the dynamic data mask.
applicability
A comma-separated list of data types for which the data mask is applicable. The JSON document data types are listed in JSON Document Types.

Example

  1. Display the information for a particluar mask:
    CLI
    maprcli security datamask info -name mrddm_hash -json 
    { 
    
    	"timestamp":1625172427915, 
    
    	"timeofday":"2021-07-01 01:47:07.915 GMT-0700 PM", 
    
    	"status":"OK", 
    
    	"total":1, 
    
    	"data":[ 
    
    		{ 
    
    			"id":5, 
    
    			"name":"mrddm_hash", 
    
    			"description":"Show the hash of the data", 
    
    			"applicability":"[String]" 
    
    		} 
    
    	] 
    
    } 
    REST
    curl -k -X POST \
      'https://r1n1.sj.us:8443/rest/security/datamask/info?name=mrddm_hash' \
      -u <username>:<password>
  2. Display mask information for a table:
    CLI
    maprcli table info -path /table1 -json 
    
    { 
    
      "timestamp":1612218564113, 
    
      "timeofday":"2021-02-01 02:29:24.113 GMT-0800 PM", 
    
      "status":"OK", 
    
      "total":1, 
    
      "data":[ 
    
        { 
    
          "path":"/table1", 
    
          ...  
    
          "defaultreadperm":"u:mapr", 
    
          "defaultunmaskedreadperm": "u:mapr", 
    
          ... 
    
        } 
    
      ] 
    
    } 
REST
curl -k -X POST \
  'https://r1n1.sj.us:8443/rest/security/datamask/info?path="/table1"' \
  -u <username>:<password>