5.9.1 Proxy credential setup
- Description
-
Sets up credentials of the proxy server when a REST API is executed from a user-created plug-in on the Intelligent Integrated Management Base. No setup is needed if proxy authentication is not necessary. The information you specify takes effect immediately in the Intelligent Integrated Management Base.
- Execution permissions
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
- API version
-
v1
- Format
-
- Request line
POST /application/component/apiVersion/proxyUsers httpVersion
- Request message body
{ "op": operation, "id":user-id, "pw": password }
- Response message body#
{ "userIdList": [ "user-id",... ] }
#: If list is specified for the op parameter
- Parameters
-
- op
-
Specifies the operation. This parameter cannot be omitted.
-
list
Returns the proxy server authentication information configured in the Intelligent Integrated Management Base.
-
add
Updates the proxy server authentication information in the Intelligent Integrated Management Base.
-
rm
Removes the proxy server authentication information configured in the Intelligent Integrated Management Base.
-
- id
-
Specifies the user ID for proxy server authentication. You do not have to specify it if list is specified for op parameter.
- pw
-
Specifies the password for the user ID for proxy server authentication.
You do not have to specify it if list or rm is specified for op parameter.
- Status codes
-
The following table describes the status codes that are returned as a response to the request:
Status code
Message
Description
200
None
Processing of the proxy authentication information REST API was successful.
400
KAJY52012-E
The proxy authentication information REST API cannot be executed due to an invalid parameter of the proxy authentication information REST API.
403
KAJY01000-E
There is no permission to run the REST API.
500
KAJY52013-E
The proxy credentials failed to be exclusive.
KAJY52014-E
The proxy credentials failed to be configured.
- Return values
-
The following information is returned in the response body if the status code is 200:
The return value varies depending on what is specified for the op parameter.
-
In list
No.
Member name
Data type
Description
1
userIdList
array
List of proxy authentication user IDs
-
In add or rm
None.
The size of the message body of a response is 0 bytes.
-
Return values |
Description |
---|---|
2 |
Exclusive locked |
3 |
Invalid argument |
7 |
Request processing is underway |
13 |
Update failure error |
255 |
System error |
- Note
-
This API cannot be executed simultaneously. An error occurs if it is executed.
- Examples
-
The following shows a usage example of the proxy credential setup API.
- Request:
POST http://hostname:20703/im/api/v1/proxyUsers { "op":"list" }
- Response:
{ "userIdList": [ "user001","user002",... ] }