Save the authorization keys
POST /api/2.0/settings/authservice
Request
Saves the authorization keys.
Authorization
An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key
.
Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
,text/json
,text/plain
.- Content-Type
enum of string
Can be one of:
application/json
,application/*+json
,text/json
.
Body
Request parameters for authorization service
- name
string
Name
- title
string
Title
- description
string
Description
- instruction
string
Instruction
- canSet
boolean
Specifies if the authentication service can be set or not
- props
array of object
List of authorization keys
- name
string
Name
- value
string
Value
- title
string
Title
Examples
POST /api/2.0/settings/authservice HTTP/1.1
Accept: application/json
Content-Length: 322
Content-Type: application/json
Host: example.com
{
"name": "Alexander West",
"title": "unbranded_metal_chair_usb_soft",
"description": "some text",
"instruction": "some text",
"canSet": true,
"props": [
{
"value": {
"name": "Cristian Osinski",
"value": "some text",
"title": "open_source_kids_handcrafted"
}
}
]
}
curl --request POST \
--url https://example.com/api/2.0/settings/authservice \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Alexander West",
"title": "unbranded_metal_chair_usb_soft",
"description": "some text",
"instruction": "some text",
"canSet": true,
"props": [
{
"value": {
"name": "Cristian Osinski",
"value": "some text",
"title": "open_source_kids_handcrafted"
}
}
]
}'
Responses
200
Boolean value: true if the authorization keys are changed
400
Bad keys
401
Unauthorized
402
Your pricing plan does not support this option