POST /api/v3/secrets/encrypt¶
Summary¶
POST /secrets/encrypt
Description¶
Encrypt a string
Encrypts a string, scoped to the current application.
These strings can only be decrypted by users with the application.decryptScopedString permission
Tags: secrets
Parameters¶
Header Parameters¶
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
Authorization |
string |
✓ Yes | Bearer {AuthToken} |
|
Content-Type |
string |
✓ Yes | application/json |
|
Accept |
string |
✓ Yes | application/json |
|
AppIdV3 |
string |
✓ Yes | LCUID-LAP-********-****-****-****-************ |
Request Body¶
Required: Yes
Content Type: application/json¶
Schema¶
Type: object
Required fields: value
Properties:
value(string) (required)
Responses¶
Response: 200¶
Content Type: application/json¶
Schema¶
Type: object
Properties:
success(boolean)secret(string)
Example Response¶
{
"success": true,
"secret": "{THVDb3JlQ3J5cHQuVjEuU2NvcGVkLgeyJpdiI6IlNkTVdGT2V4WW10RlhocGZuQyt0SWc9PSIsInZhbHVlIjoiMjRWZE5VY09VK1RYTllNSXR5YWFDb2VWZkRGZXN4RysrbHVtTjdxRWVDMXRxbVBjb01ZRThvWE12K1UwaXVDWVFMRElRQ1NTcVBzNXhXQXR1RUsrOGsxMm1ieVBFakozMFpIQ0Ywb2NsQXA2RlYvSWlWaFVLSS9QZEk0RkhQOVhCajc5cTUyZ2J5dmYvN3pvVGlCOW5Ob2RTYUFZK01tMVBON1ZJQVp6UjZ4VWpFWGlyY05McTJJMDJTUkxteWljM1llc0xKM2RjZFpvcTFpbTlFMzZpK3c3ODJkYVVnWFVHeWlwNU4zVXdVTjRFZ0JLYUFRVmw2Vk9BbVRMSmlYc3VFV0JHc3Ewbmdyb3N3eS9DSUxBdThNVkhMYVY5dVFMUVFyaUtXbUVIYysvcVJBbk1DYVBkYzhhSEJuVm9XMG9IM1hlbDVSQWF2VU5BZUd5MDljOERHaFNVWlozSEhEdEdYRHhzWlRYK1dQYTZKci9TNmdRVytoRGw5cGF3TWc3RHRGZjZxTDlkKzNXT2NsMVRrQjQzdz09IiwibWFjIjoiNmMzYzQyM2E1YWU0NTdjNGMxZTE0Mzg1MzVjNTQ0N2NiYjUwYmQ3NWVhNzBhMjJmMjlmOGE3MTVhZmRkY2MzYyIsInRhZyI6IiJ9}"
}
Example Implementations¶
Bash (cURL)¶
curl --request POST \
"https://api.lucit.app/api/v3/secrets/encrypt" \
--header "Authorization: Bearer {AuthToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "AppIdV3: LCUID-LAP-********-****-****-****-************" \
--data "{
\"value\": \"aliquid\"
}"
JavaScript (Fetch API)¶
const url = new URL(
"https://api.lucit.app/api/v3/secrets/encrypt"
);
const headers = {
"Authorization": "Bearer {AuthToken}",
"Content-Type": "application/json",
"Accept": "application/json",
"AppIdV3": "LCUID-LAP-********-****-****-****-************",
};
let body = {
"value": "aliquid"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
PHP (Guzzle)¶
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.lucit.app/api/v3/secrets/encrypt',
[
'headers' => [
'Authorization' => 'Bearer {AuthToken}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
],
'json' => [
'value' => 'aliquid',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
Python (Requests)¶
import requests
import json
url = 'https://api.lucit.app/api/v3/secrets/encrypt'
payload = {
"value": "aliquid"
}
headers = {
'Authorization': 'Bearer {AuthToken}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
Example Responses¶
200 Response¶
{
"success": true,
"secret": "{THVDb3JlQ3J5cHQuVjEuU2NvcGVkLgeyJpdiI6IlNkTVdGT2V4WW10RlhocGZuQyt0SWc9PSIsInZhbHVlIjoiMjRWZE5VY09VK1RYTllNSXR5YWFDb2VWZkRGZXN4RysrbHVtTjdxRWVDMXRxbVBjb01ZRThvWE12K1UwaXVDWVFMRElRQ1NTcVBzNXhXQXR1RUsrOGsxMm1ieVBFakozMFpIQ0Ywb2NsQXA2RlYvSWlWaFVLSS9QZEk0RkhQOVhCajc5cTUyZ2J5dmYvN3pvVGlCOW5Ob2RTYUFZK01tMVBON1ZJQVp6UjZ4VWpFWGlyY05McTJJMDJTUkxteWljM1llc0xKM2RjZFpvcTFpbTlFMzZpK3c3ODJkYVVnWFVHeWlwNU4zVXdVTjRFZ0JLYUFRVmw2Vk9BbVRMSmlYc3VFV0JHc3Ewbmdyb3N3eS9DSUxBdThNVkhMYVY5dVFMUVFyaUtXbUVIYysvcVJBbk1DYVBkYzhhSEJuVm9XMG9IM1hlbDVSQWF2VU5BZUd5MDljOERHaFNVWlozSEhEdEdYRHhzWlRYK1dQYTZKci9TNmdRVytoRGw5cGF3TWc3RHRGZjZxTDlkKzNXT2NsMVRrQjQzdz09IiwibWFjIjoiNmMzYzQyM2E1YWU0NTdjNGMxZTE0Mzg1MzVjNTQ0N2NiYjUwYmQ3NWVhNzBhMjJmMjlmOGE3MTVhZmRkY2MzYyIsInRhZyI6IiJ9}"
}