> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/protect-partner/models.md).

# Models

## The Synchronization object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"Synchronization":{"description":"All information needed to perform synchronization","type":"object","properties":{"id":{"description":"Operation id","type":"string"},"dataAccessRuleSet":{"$ref":"#/components/schemas/DataAccessRuleSet"}}},"DataAccessRuleSet":{"description":"All of the data access rules that need to be synchronized.","type":"object","properties":{"databases":{"type":"array","items":{"$ref":"#/components/schemas/Database"}}},"required":["databases"]},"Database":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/Provider"},"providerDetails":{"$ref":"#/components/schemas/ProviderDetails"},"id":{"type":"string","description":"The id of the database"},"name":{"type":"string","description":"The name of the database"},"schemas":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/DatabaseSchema"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTag"}},"customMaskings":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseCustomMasking"}}},"required":["provider","id","name","schema","tags","customMaskings"]},"Provider":{"type":"string","description":"Value must be \"Snowflake\", \"GoogleBigQuery, or \"AWSLakeFormation\""},"ProviderDetails":{"description":"The provider specific details. For example, AWSLakeFormation contains the property awsRegion, which denotes in which region the database is located.","type":"object","additionalProperties":{"type":"string"}},"DatabaseSchema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database schema"},"name":{"type":"string","description":"The name of the database schema"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTable"}}},"required":["id","name","tables"]},"DatabaseTable":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database table"},"name":{"type":"string","description":"The name of the database table"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumn"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTableAccessRule"}}},"required":["id","name","columns","accesses"]},"DatabaseColumn":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database column"},"name":{"type":"string","description":"The name of the database column"},"dataType":{"description":"The data type as it is declared by the provider. For example: String, Integer, Varchar, Blob, Boolean, ...\n","type":"string"},"precision":{"type":"integer","description":"The precision of the column."},"scale":{"type":"integer","description":"The scale of the column."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnTag"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnAccessRule"}}},"required":["id","name","tags","accesses"]},"DatabaseColumnTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database column tag"},"name":{"type":"string","description":"The name of database column tag"}},"required":["id","name"]},"DatabaseColumnAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"},"masking":{"$ref":"#/components/schemas/Masking"},"rowFilter":{"$ref":"#/components/schemas/RowFilter"}},"required":["group","access"]},"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]},"RowFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/RowFilterOperator"},"values":{"type":"array","items":{"type":"string","description":"The value of row filter"},"uniqueItems":true}}},"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."},"DatabaseTableAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"}},"required":["group","access"]},"DatabaseTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database tag"},"name":{"type":"string","description":"The name of database tag"},"maskings":{"type":"array","items":{"$ref":"#/components/schemas/GroupMasking"}}},"required":["id","tag","maskings"]},"GroupMasking":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"masking":{"$ref":"#/components/schemas/Masking"}},"required":["group","masking"]},"DatabaseCustomMasking":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The id of database custom masking"},"name":{"type":"string","description":"The name of database custom masking"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MaskingMappings"}}}},"MaskingMappings":{"description":"a mapping of the data type and function name used to provide the custom mapping.","properties":{"dataType":{"type":"string","description":"The name of the data type (String, Number, Date ...). Data types name depend on the provider, a list of compatible types per provider is available in the documentation."},"functionName":{"type":"string","description":"The name of the function that will be used on the provider to provide the custom masking."}},"required":["dataType","functionName"]}}}}
```

## The Provider object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"Provider":{"type":"string","description":"Value must be \"Snowflake\", \"GoogleBigQuery, or \"AWSLakeFormation\""}}}}
```

## The Access object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."}}}}
```

## The ProviderDetails object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"ProviderDetails":{"description":"The provider specific details. For example, AWSLakeFormation contains the property awsRegion, which denotes in which region the database is located.","type":"object","additionalProperties":{"type":"string"}}}}}
```

## The DataAccessRuleSet object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DataAccessRuleSet":{"description":"All of the data access rules that need to be synchronized.","type":"object","properties":{"databases":{"type":"array","items":{"$ref":"#/components/schemas/Database"}}},"required":["databases"]},"Database":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/Provider"},"providerDetails":{"$ref":"#/components/schemas/ProviderDetails"},"id":{"type":"string","description":"The id of the database"},"name":{"type":"string","description":"The name of the database"},"schemas":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/DatabaseSchema"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTag"}},"customMaskings":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseCustomMasking"}}},"required":["provider","id","name","schema","tags","customMaskings"]},"Provider":{"type":"string","description":"Value must be \"Snowflake\", \"GoogleBigQuery, or \"AWSLakeFormation\""},"ProviderDetails":{"description":"The provider specific details. For example, AWSLakeFormation contains the property awsRegion, which denotes in which region the database is located.","type":"object","additionalProperties":{"type":"string"}},"DatabaseSchema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database schema"},"name":{"type":"string","description":"The name of the database schema"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTable"}}},"required":["id","name","tables"]},"DatabaseTable":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database table"},"name":{"type":"string","description":"The name of the database table"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumn"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTableAccessRule"}}},"required":["id","name","columns","accesses"]},"DatabaseColumn":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database column"},"name":{"type":"string","description":"The name of the database column"},"dataType":{"description":"The data type as it is declared by the provider. For example: String, Integer, Varchar, Blob, Boolean, ...\n","type":"string"},"precision":{"type":"integer","description":"The precision of the column."},"scale":{"type":"integer","description":"The scale of the column."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnTag"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnAccessRule"}}},"required":["id","name","tags","accesses"]},"DatabaseColumnTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database column tag"},"name":{"type":"string","description":"The name of database column tag"}},"required":["id","name"]},"DatabaseColumnAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"},"masking":{"$ref":"#/components/schemas/Masking"},"rowFilter":{"$ref":"#/components/schemas/RowFilter"}},"required":["group","access"]},"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]},"RowFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/RowFilterOperator"},"values":{"type":"array","items":{"type":"string","description":"The value of row filter"},"uniqueItems":true}}},"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."},"DatabaseTableAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"}},"required":["group","access"]},"DatabaseTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database tag"},"name":{"type":"string","description":"The name of database tag"},"maskings":{"type":"array","items":{"$ref":"#/components/schemas/GroupMasking"}}},"required":["id","tag","maskings"]},"GroupMasking":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"masking":{"$ref":"#/components/schemas/Masking"}},"required":["group","masking"]},"DatabaseCustomMasking":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The id of database custom masking"},"name":{"type":"string","description":"The name of database custom masking"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MaskingMappings"}}}},"MaskingMappings":{"description":"a mapping of the data type and function name used to provide the custom mapping.","properties":{"dataType":{"type":"string","description":"The name of the data type (String, Number, Date ...). Data types name depend on the provider, a list of compatible types per provider is available in the documentation."},"functionName":{"type":"string","description":"The name of the function that will be used on the provider to provide the custom masking."}},"required":["dataType","functionName"]}}}}
```

## The Database object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"Database":{"type":"object","properties":{"provider":{"$ref":"#/components/schemas/Provider"},"providerDetails":{"$ref":"#/components/schemas/ProviderDetails"},"id":{"type":"string","description":"The id of the database"},"name":{"type":"string","description":"The name of the database"},"schemas":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/DatabaseSchema"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTag"}},"customMaskings":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseCustomMasking"}}},"required":["provider","id","name","schema","tags","customMaskings"]},"Provider":{"type":"string","description":"Value must be \"Snowflake\", \"GoogleBigQuery, or \"AWSLakeFormation\""},"ProviderDetails":{"description":"The provider specific details. For example, AWSLakeFormation contains the property awsRegion, which denotes in which region the database is located.","type":"object","additionalProperties":{"type":"string"}},"DatabaseSchema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database schema"},"name":{"type":"string","description":"The name of the database schema"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTable"}}},"required":["id","name","tables"]},"DatabaseTable":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database table"},"name":{"type":"string","description":"The name of the database table"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumn"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTableAccessRule"}}},"required":["id","name","columns","accesses"]},"DatabaseColumn":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database column"},"name":{"type":"string","description":"The name of the database column"},"dataType":{"description":"The data type as it is declared by the provider. For example: String, Integer, Varchar, Blob, Boolean, ...\n","type":"string"},"precision":{"type":"integer","description":"The precision of the column."},"scale":{"type":"integer","description":"The scale of the column."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnTag"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnAccessRule"}}},"required":["id","name","tags","accesses"]},"DatabaseColumnTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database column tag"},"name":{"type":"string","description":"The name of database column tag"}},"required":["id","name"]},"DatabaseColumnAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"},"masking":{"$ref":"#/components/schemas/Masking"},"rowFilter":{"$ref":"#/components/schemas/RowFilter"}},"required":["group","access"]},"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]},"RowFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/RowFilterOperator"},"values":{"type":"array","items":{"type":"string","description":"The value of row filter"},"uniqueItems":true}}},"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."},"DatabaseTableAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"}},"required":["group","access"]},"DatabaseTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database tag"},"name":{"type":"string","description":"The name of database tag"},"maskings":{"type":"array","items":{"$ref":"#/components/schemas/GroupMasking"}}},"required":["id","tag","maskings"]},"GroupMasking":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"masking":{"$ref":"#/components/schemas/Masking"}},"required":["group","masking"]},"DatabaseCustomMasking":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The id of database custom masking"},"name":{"type":"string","description":"The name of database custom masking"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MaskingMappings"}}}},"MaskingMappings":{"description":"a mapping of the data type and function name used to provide the custom mapping.","properties":{"dataType":{"type":"string","description":"The name of the data type (String, Number, Date ...). Data types name depend on the provider, a list of compatible types per provider is available in the documentation."},"functionName":{"type":"string","description":"The name of the function that will be used on the provider to provide the custom masking."}},"required":["dataType","functionName"]}}}}
```

## The DatabaseSchema object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DatabaseSchema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database schema"},"name":{"type":"string","description":"The name of the database schema"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTable"}}},"required":["id","name","tables"]},"DatabaseTable":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database table"},"name":{"type":"string","description":"The name of the database table"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumn"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTableAccessRule"}}},"required":["id","name","columns","accesses"]},"DatabaseColumn":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database column"},"name":{"type":"string","description":"The name of the database column"},"dataType":{"description":"The data type as it is declared by the provider. For example: String, Integer, Varchar, Blob, Boolean, ...\n","type":"string"},"precision":{"type":"integer","description":"The precision of the column."},"scale":{"type":"integer","description":"The scale of the column."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnTag"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnAccessRule"}}},"required":["id","name","tags","accesses"]},"DatabaseColumnTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database column tag"},"name":{"type":"string","description":"The name of database column tag"}},"required":["id","name"]},"DatabaseColumnAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"},"masking":{"$ref":"#/components/schemas/Masking"},"rowFilter":{"$ref":"#/components/schemas/RowFilter"}},"required":["group","access"]},"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]},"RowFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/RowFilterOperator"},"values":{"type":"array","items":{"type":"string","description":"The value of row filter"},"uniqueItems":true}}},"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."},"DatabaseTableAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"}},"required":["group","access"]}}}}
```

## The DatabaseTable object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DatabaseTable":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database table"},"name":{"type":"string","description":"The name of the database table"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumn"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseTableAccessRule"}}},"required":["id","name","columns","accesses"]},"DatabaseColumn":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database column"},"name":{"type":"string","description":"The name of the database column"},"dataType":{"description":"The data type as it is declared by the provider. For example: String, Integer, Varchar, Blob, Boolean, ...\n","type":"string"},"precision":{"type":"integer","description":"The precision of the column."},"scale":{"type":"integer","description":"The scale of the column."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnTag"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnAccessRule"}}},"required":["id","name","tags","accesses"]},"DatabaseColumnTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database column tag"},"name":{"type":"string","description":"The name of database column tag"}},"required":["id","name"]},"DatabaseColumnAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"},"masking":{"$ref":"#/components/schemas/Masking"},"rowFilter":{"$ref":"#/components/schemas/RowFilter"}},"required":["group","access"]},"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]},"RowFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/RowFilterOperator"},"values":{"type":"array","items":{"type":"string","description":"The value of row filter"},"uniqueItems":true}}},"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."},"DatabaseTableAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"}},"required":["group","access"]}}}}
```

## The DatabaseColumn object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DatabaseColumn":{"type":"object","properties":{"id":{"type":"string","description":"The id of the database column"},"name":{"type":"string","description":"The name of the database column"},"dataType":{"description":"The data type as it is declared by the provider. For example: String, Integer, Varchar, Blob, Boolean, ...\n","type":"string"},"precision":{"type":"integer","description":"The precision of the column."},"scale":{"type":"integer","description":"The scale of the column."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnTag"}},"accesses":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseColumnAccessRule"}}},"required":["id","name","tags","accesses"]},"DatabaseColumnTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database column tag"},"name":{"type":"string","description":"The name of database column tag"}},"required":["id","name"]},"DatabaseColumnAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"},"masking":{"$ref":"#/components/schemas/Masking"},"rowFilter":{"$ref":"#/components/schemas/RowFilter"}},"required":["group","access"]},"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]},"RowFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/RowFilterOperator"},"values":{"type":"array","items":{"type":"string","description":"The value of row filter"},"uniqueItems":true}}},"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."}}}}
```

## The DatabaseColumnTag object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DatabaseColumnTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database column tag"},"name":{"type":"string","description":"The name of database column tag"}},"required":["id","name"]}}}}
```

## The DatabaseTableAccessRule object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DatabaseTableAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"}},"required":["group","access"]},"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."}}}}
```

## The DatabaseColumnAccessRule object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DatabaseColumnAccessRule":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"access":{"$ref":"#/components/schemas/Access"},"masking":{"$ref":"#/components/schemas/Masking"},"rowFilter":{"$ref":"#/components/schemas/RowFilter"}},"required":["group","access"]},"Access":{"type":"string","description":"Possible values are: `Read` or `NoChange`."},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]},"RowFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/RowFilterOperator"},"values":{"type":"array","items":{"type":"string","description":"The value of row filter"},"uniqueItems":true}}},"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."}}}}
```

## The BaseMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."}}}}
```

## The Masking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]}}}}
```

## The MaskingType object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."}}}}
```

## The NoMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."}}}}
```

## The ConstantMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."}}}}
```

## The DefaultMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."}}}}
```

## The HashMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."}}}}
```

## The ShowLastMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."}}}}
```

## The CustomMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."}}}}
```

## The RowFilter object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"RowFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/RowFilterOperator"},"values":{"type":"array","items":{"type":"string","description":"The value of row filter"},"uniqueItems":true}}},"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."}}}}
```

## The RowFilterOperator object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"RowFilterOperator":{"type":"string","description":"Possible values are: `Equals` or `NotEquals`."}}}}
```

## The DatabaseTag object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DatabaseTag":{"type":"object","properties":{"id":{"type":"string","description":"The id of database tag"},"name":{"type":"string","description":"The name of database tag"},"maskings":{"type":"array","items":{"$ref":"#/components/schemas/GroupMasking"}}},"required":["id","tag","maskings"]},"GroupMasking":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"masking":{"$ref":"#/components/schemas/Masking"}},"required":["group","masking"]},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]}}}}
```

## The GroupMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"GroupMasking":{"type":"object","properties":{"group":{"type":"string","description":"The name of protect group"},"masking":{"$ref":"#/components/schemas/Masking"}},"required":["group","masking"]},"Masking":{"oneOf":[{"$ref":"#/components/schemas/NoMasking"},{"$ref":"#/components/schemas/DefaultMasking"},{"$ref":"#/components/schemas/ConstantMasking"},{"$ref":"#/components/schemas/HashMasking"},{"$ref":"#/components/schemas/ShowLastMasking"},{"$ref":"#/components/schemas/CustomMasking"}],"discriminator":{"propertyName":"type","mapping":{"None":"#/components/schemas/NoMasking","Default":"#/components/schemas/DefaultMasking","Constant":"#/components/schemas/ConstantMasking","Hash":"#/components/schemas/HashMasking","ShowLast":"#/components/schemas/ShowLastMasking","Custom":"#/components/schemas/CustomMasking"}}},"NoMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"BaseMasking":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/MaskingType"}}},"MaskingType":{"type":"string","description":"Possible values are: `None`, `Default`, `Constant`, `Hash` or `ShowLast`."},"DefaultMasking":{"description":"The masked value applied is source dependent and chosen based on the column data type.","allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ConstantMasking":{"description":"This masked strategy is not supported by the Protect application therefore it is deprecated and it will be removed in new versions of the API. Use DefaultMasking instead.","allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"constant":{"type":"string"}}}]},"HashMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"}]},"ShowLastMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"numberOfCharacters":{"type":"integer","description":"The number of characters to display"}}}]},"CustomMasking":{"allOf":[{"$ref":"#/components/schemas/BaseMasking"},{"type":"object","properties":{"customMaskingId":{"type":"string","format":"uuid","description":"The id of custom masking"},"customMaskingName":{"type":"string","description":"The name of custom masking"}}}]}}}}
```

## The DatabaseCustomMasking object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"DatabaseCustomMasking":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The id of database custom masking"},"name":{"type":"string","description":"The name of database custom masking"},"mappings":{"type":"array","items":{"$ref":"#/components/schemas/MaskingMappings"}}}},"MaskingMappings":{"description":"a mapping of the data type and function name used to provide the custom mapping.","properties":{"dataType":{"type":"string","description":"The name of the data type (String, Number, Date ...). Data types name depend on the provider, a list of compatible types per provider is available in the documentation."},"functionName":{"type":"string","description":"The name of the function that will be used on the provider to provide the custom masking."}},"required":["dataType","functionName"]}}}}
```

## The MaskingMappings object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"MaskingMappings":{"description":"a mapping of the data type and function name used to provide the custom mapping.","properties":{"dataType":{"type":"string","description":"The name of the data type (String, Number, Date ...). Data types name depend on the provider, a list of compatible types per provider is available in the documentation."},"functionName":{"type":"string","description":"The name of the function that will be used on the provider to provide the custom masking."}},"required":["dataType","functionName"]}}}}
```

## The StandardErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Collibra Protect API - Partner","version":"1.0.0-beta"},"components":{"schemas":{"StandardErrorResponse":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP response code"},"titleMessage":{"type":"string","description":"The title of the error message."},"helpMessage":{"type":"string","description":"A message containing actions you can take regarding the error."},"userMessage":{"type":"string","description":"A user friendly error message."},"errorCode":{"type":"string","description":"An error code identifier."}}}}}}
```