PUT /users/user/{userid}/apikey/{apikeyid}¶

Update an API Key object. An API Key which has a status of DISABLED may not be used to authenticate a User.

Resource URL
Parameters
Return
Example Request
- PUT Request
- PUT Response

Resource URL ¶

https://auth.econtext.ai/api//users/user/{userid}/apikey/{apikeyid}

Parameters ¶

Parameter	Type	Description
name	string	A name for the API Key
description	string	A description for the API Key
status	string	The status of the API Key. Available options are `ENABLED` and `DISABLED`

Return ¶

An API Key object

Example Request ¶

PUT Request ¶

curl -X POST \
  -H 'authorization: Basic b3BzQGluZm8uY29tOnAxdjBwcjBzMW0=' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
    "status":"DISABLED"
  }' \
  https://auth.econtext.ai/api/users/user/a3bc334a-f9f2-4797-aaa2-1440811c0ec0/apikey/44A62GBSEB4F3S08VFLWI0YCY

PUT Response ¶

{
  "econtext": {
    "result": {
      "apikey": {
        "status": "DISABLED",
        "description": "An API Key for testing",
        "secret": "ODBkZjZiNzYtMzU1Ny00MDgxLWFiMDYtMWE1OGU5OTIxZGQ0",
        "href": "https://auth.econtext.ai/api/users/user/a3bc334a-f9f2-4797-aaa2-1440811c0ec0/apikey/44A62GBSEB4F3S08VFLWI0YCY",
        "id": "44A62GBSEB4F3S08VFLWI0YCY",
        "name": "Test API Key"
      }
    },
    "elapsed": 0.029818058013916016
  }
}