Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.28 KB

GET_AdminUsers.md

File metadata and controls

49 lines (35 loc) · 1.28 KB

GET /AdminUsers

Gets a list of admins for the API

Description

  • Requires API Key: No
  • Requires System Administrator: Yes
  • Requires Counterpoint Registration option: No

Sample Request

URI

GET https://localhost:81/AdminUsers

Headers

  • Authorization : Basic UUFUZXN0R29sZi5NR1I6cGFzc3dvcmQx
  • Accept : application/json

Response Codes

  • 200 OK The request was successful, the result of the call will be in the response body.
  • 401 Unauthorized The request could not be fulfilled. Likely due to a missing or invalid authorization header.
  • 500 Internal Server Error The request could not be fulfilled due to an unexpected internal error. This could be caused by a bug in the system, an unavailable database, or any other unexpected internal problem processing the request.

Error Codes

The following error codes may be returned from requests to this endpoint:

  • SUCCESS: The request was successful.

Sample Response Body

{
  "AdminUsers": [
    "admin",
    "admin2",
    "admin3"
  ],
  "ErrorCode": "SUCCESS"
}

Response Body

User List

Element Datatype Description
APIAdmins String List A list of API users who have administrative access to the API.