Authorization

Mon, 01 Jan 0001 00:00:00 +0000

Policy Users

Protegrity Policy roles defines the unique data access privileges for every member. The Protegrity Lambda protects the data with the username sent in either the JWT-formatted authorization header or the request body.

HTTP Status Codes

Mon, 01 Jan 0001 00:00:00 +0000

The following table explains the different HTTP Status Codes with their corresponding response.

Status Codes

Response

Description

200

{"results":["<string>","<string>"],
 "success": true, "encoding":[hex|utf8]}

Success protected data is in results, and success attribute is true

400

{
 "error_msg": "<string>",
 "success": false
}

There was an issue in the request, success is false, check error_msg attribute. For more information check AWS Lambda’s CloudWatch logs.

Payload Encoding

Mon, 01 Jan 0001 00:00:00 +0000

Payload Encoding

The following encoding formats are supported in the REST API.

For every encoding, the resultant protected data is returned in the same encoding. For example, if request is hex-encoded, the response is also hex-encoded.

For more information about the encoding formats, refer to the Protection Methods Reference.

Encoding

Supported by data elements

Notes

utf8

All except binary data elements.

Default encoding if encoding is not specified.

TLS Mutual Authentication

Mon, 01 Jan 0001 00:00:00 +0000

By default, AWS API Gateway supports HTTPS endpoint and doesn’t allow HTTP protocol.

For an additional layer of security, you can configure AWS API Gateway TLS Mutual Authentication.

AWS API Gateway will ensure that the clients with a valid certificate only can call the REST API. Protegrity recommends to setup TLS Mutual Authentication in AWS API Gateway. For more information on how to set AWS API Gateway Mutual TLS go to the following link.

v1 Specification

Mon, 01 Jan 0001 00:00:00 +0000

AWS Lambda service limits maximum size of payload to 6 MB. Client applications of Protegrity Cloud API must ensure their payload size is within this limit. This applies to all types of requests described below.

Request

Legacy Specification

Mon, 01 Jan 0001 00:00:00 +0000

Protegrity has multiple products with REST API capabilities, such as Protection Server (out of support), DSG, and the latest product - IAP REST. Each one has its use case. To help you move to cloud-native implementation, Cloud Product REST API supports legacy payload.

Legacy documentation can be downloaded from AWS console, API, Models, prefix Legacy.

Request

Performs a policy operation such as protect, unprotect, or reprotect.

Method

POST

REST API on

Authorization

Policy Users

HTTP Status Codes

Payload Encoding

Payload Encoding

TLS Mutual Authentication

v1 Specification

Request

Legacy Specification

Request