Authentication Required

Each request must have authentication information

Purple gradient wave Purple wave used to give a visual break between the header and body of the page.

Summary

Each request to the API must contain authentication information using an API Key defined in the Youmanage application.

curl -i https://api.youmanage.co.uk/companies
HTTP/1.1 401 Unauthorized

{
  "Error": {
    "Code": "YM0100",
    "Reference": "https://developer.youmanage.co.uk/api/errors/ym0100",
    "Target": null,
    "Message": "Authentication is required",
    "Details": null
  }
}

  

Solution

Check that the API key that has been used is still active and has not been revoked by the system administrator. If the API key is still active then it is likely that it may have been mistyped when entering the Authorization header and we would suggest re-entering it and trying again.

curl -H "Authorization: ApiKey {ApiKey}" https://api.youmanage.co.uk/companies
HTTP/1.1 200 OK

[
  {
    "id": 2,
    "name": "Fictional Data Limited",
    "enabled": true
  }
]

If you do not have a safe copy of the key, we would strongly advise recreating the API key through the Youmanage application.

For more information on how to generate API keys and making authenticated requests see our guide on authentication.