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

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Request parameters for authorization service

namestring

Name

titlestring

Title

descriptionstring

Description

instructionstring

Instruction

canSetboolean

Specifies if the authentication service can be set or not

propsarray of unknown

List of authorization keys

Examples

POST /api/2.0/settings/authservice HTTP/1.1
Accept: application/json
Content-Length: 126
Content-Type: application/json
Host: example.com

{
  "name": "Jean Kassulke",
  "title": "iowa",
  "description": "some text",
  "instruction": "some text",
  "canSet": true
}

curl --request POST \
  --url https://example.com/api/2.0/settings/authservice \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Jean Kassulke",
  "title": "iowa",
  "description": "some text",
  "instruction": "some text",
  "canSet": true
}'

Responses

200

Boolean value: true if the authorization keys are changed

401

Unauthorized

403

Forbidden