(Auto-creation of topic Documentation:ServicePattern:user-management-api-specification:GeneralInformation:3.16 via TOC Documentation:ServicePattern:user-management-api-specificationTOC3.16) |
|||
| Line 1: | Line 1: | ||
<translate>= General Information= | <translate>= General Information= | ||
| + | The User Management API is a RESTful API. The HTTP POST method is used for all requests to insert or update information, while the HTTP GET method is used to retrieve information. Request and response bodies are encoded using JSON. | ||
| + | |||
| + | This specification describes only additional or different meanings of standard HTTP response codes. For more information, see [http://www.ietf.org/rfc/rfc2616.txt RFC 2616, Section 10]. | ||
| + | |||
| + | == Request URLs == | ||
| + | The request URL contains information about the required action and the object name. | ||
| + | |||
| + | The base part of the URL is: | ||
| + | http[s]://<host>/configapi/v2 | ||
| + | |||
| + | == Request Body == | ||
| + | The request body carries either the object to be inserted or the unique ID fields of the object to be queried. | ||
| + | |||
| + | == Tenant ID == | ||
| + | In a multi-tenant deployment, the tenant ID is derived from authentication login information. | ||
| + | |||
| + | For more information, see the [[list-management-api-specification/SecurityandAuthentication|Security and Authentication]] section of this specification. | ||
| + | |||
| + | |||
| + | |||
</translate> | </translate> | ||
Latest revision as of 23:56, 13 November 2018
Contents
- Introduction
- API Specification
General Information
The User Management API is a RESTful API. The HTTP POST method is used for all requests to insert or update information, while the HTTP GET method is used to retrieve information. Request and response bodies are encoded using JSON.
This specification describes only additional or different meanings of standard HTTP response codes. For more information, see RFC 2616, Section 10.
Request URLs
The request URL contains information about the required action and the object name.
The base part of the URL is:
http[s]://<host>/configapi/v2
Request Body
The request body carries either the object to be inserted or the unique ID fields of the object to be queried.
Tenant ID
In a multi-tenant deployment, the tenant ID is derived from authentication login information.
For more information, see the Security and Authentication section of this specification.