User management API design

Ops Center Analyzer Detail View REST API Reference Guide

Part Number

The user management APIs follow the same high-level design concepts used in the database API:

  • The request URLs of the database API and user API have a common endpoint. However, these URLs are identified by the functions. For example, the general URL format is https://localhost:8443/, where XXX is the API function.
  • API functionality is supported only through two HTTP methods: GET and POST. DELETE, PUT, or other HTTP methods are not considered.
  • The GET method is not supported for functions causing side effects on the server.
  • The API platform is reused. Therefore, the API reuses the partial completion and status API.
  • The API also uses HTTP basic authentication.
  • Response codes and error object structure are same as the database API.
  • The API is supported only over HTTPS.