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": "{THVDb3JlQ3J5cHQuVjEuU2NvcGVkLgeyJpdiI6Ink0RG5Tc3EvVENVY09rOU11TlQxT2c9PSIsInZhbHVlIjoiTEZGR1ZsdkRza1hzTGNDcVF1V0NxSzFHd2NlM2cxc09mdXo0b200b1p2cWZUOEM1K2ZvbGtYUDN4K3dDd3RxOC9uSk42bVR2Z3dFeERuRDRSa1pjQ1l6QkNvMmo5bHdPVHRIRUJCTUVqY2krNVI3Y0RJK1E5UUtQMU1ZSjBBbWVqSGc0KzZqN1phbzVmNW1TeE0rZHdaWlFlVzJRNHphbWxlQ20xWStEY0tMbHIxUVVvbjh2bzZZZDZabmxRelZ3OG0yNFhoOFZJdklNNmVFeFo5MkZUdm5PenJIREpzdHlIZ3VwTkxabmZSbHd4bnNEb3p1dFh0TnBHTXVaYmZQalFUYXQ1YTdveDh0cWY2WTh5MzBXc0wyb3p2MFE3TkVxYU9XZ2F5b3BrUUJseEdXSVFjak9Ld0Rjd2tCS2ROVEJTYVlvTldBTEUwSE9xNmMweVpMQitSMWowZkRHcGJHbkQ2cGJjTldQM3NRRGlWMmVkeDZxWW5wZzduUHRJQkFrazlGN1JIc2NYNTFaZVNNL1pzQngzZz09IiwibWFjIjoiNTU1NWQyNjBkMWJjMjg4NTg3MzM0NDAyMGZiNzZkZGRiYWExNmEzZThjZjc5ZmJmOWRlZTdmNTJhMzRkNGRjYSIsInRhZyI6IiJ9}"
}
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": "{THVDb3JlQ3J5cHQuVjEuU2NvcGVkLgeyJpdiI6Ink0RG5Tc3EvVENVY09rOU11TlQxT2c9PSIsInZhbHVlIjoiTEZGR1ZsdkRza1hzTGNDcVF1V0NxSzFHd2NlM2cxc09mdXo0b200b1p2cWZUOEM1K2ZvbGtYUDN4K3dDd3RxOC9uSk42bVR2Z3dFeERuRDRSa1pjQ1l6QkNvMmo5bHdPVHRIRUJCTUVqY2krNVI3Y0RJK1E5UUtQMU1ZSjBBbWVqSGc0KzZqN1phbzVmNW1TeE0rZHdaWlFlVzJRNHphbWxlQ20xWStEY0tMbHIxUVVvbjh2bzZZZDZabmxRelZ3OG0yNFhoOFZJdklNNmVFeFo5MkZUdm5PenJIREpzdHlIZ3VwTkxabmZSbHd4bnNEb3p1dFh0TnBHTXVaYmZQalFUYXQ1YTdveDh0cWY2WTh5MzBXc0wyb3p2MFE3TkVxYU9XZ2F5b3BrUUJseEdXSVFjak9Ld0Rjd2tCS2ROVEJTYVlvTldBTEUwSE9xNmMweVpMQitSMWowZkRHcGJHbkQ2cGJjTldQM3NRRGlWMmVkeDZxWW5wZzduUHRJQkFrazlGN1JIc2NYNTFaZVNNL1pzQngzZz09IiwibWFjIjoiNTU1NWQyNjBkMWJjMjg4NTg3MzM0NDAyMGZiNzZkZGRiYWExNmEzZThjZjc5ZmJmOWRlZTdmNTJhMzRkNGRjYSIsInRhZyI6IiJ9}"
}