GET /Api/Read/Acl
Authorization key & Authorization date & Authorization hmac

This process returns the endpoints that your acl allows you to call. Note that API Access Control Lists are always manually created by a WRTM system administrator. Secret Hmac Required. Cache Time 1 Hour. Reset if key edited.

Responses

  • 200 application/json

    ACL list successfully returned

    Hide response attributes Show response attributes object
    • Path string

      The path that is allowed (* = wildcard from that level on)

    • Display_Name string

      A text representation of what the endpoints can do.

    • Id number

      database id for this ACL (useful for reviewing logs)

    • Is_Public number

      1 if this is publicly available, 0 if not

    • Require_Https number

      1 if requires https, 0 if http is allowed.

    • Require_Hash number

      0 for no date checksum required. 1=md5, 2=sha1, 3=sha256, 4=sha384, 5=sha512 hash of the date is required. The encryption method can be overridden by the api key.
GET /Api/Read/Acl 
curl \
 --request GET 'https://api.wereadthemanual.com/v1.0/Api/Read/Acl' \
 --header "X-ApiKey: $API_KEY" \
 --header "X-ApiDate: $API_KEY" \
 --header "X-ApiHmac: $API_KEY"
Response examples (200) 
[
  {
    "Id": 1,
    "Path": "api/Read/*",
    "Is_Public": 1,
    "Display_Name": "Read API access information",
    "Require_Hash": "None",
    "Require_Https": true
  },
  {
    "Id": 100,
    "Path": "people/Read/*",
    "Is_Public": 0,
    "Display_Name": "Allows access to read people endpoints",
    "Require_Hash": "Sha256",
    "Require_Https": 1
  }
]