5.4.3 Initial secret issue
- Description
-
Issue initial secret.
To work with the manager, you must allocate client secret for each client that you want to authentication. Working with managers until they get client secret is one that is assigned to the manager and can temporarily use initial secret that is shared by all requestors.
The secret you publish is stored in integrated agent host administration DB.
- Execution permissions
-
Following permissions are required:
-
JP1 resource group: *
-
JP1 permission level: JP1_Console_Admin
-
- API version
-
v1
- Format
-
- Request line
POST /application/component/apiVersion/secret/generateInfo httpVersion
- Request message body
-
None
- Response message body
{ "secret": secret-for-authentication, "lastUpdateTime": generation-date/time-of-secret }
- Parameters
-
None
- Status codes
-
The following table describes the status codes that are returned as a response to the request:
Status code
Message
Description
200
--
API operation was successful.
403
KAJY01000-E
Insufficient privilege for the user used for authentication.
500
KAJY68001-E
DB accessible error
- Return values
-
The following information is returned in the response body if the status code is 200:
Member name
Data type
Description
secret
string
Issued secret
lastUpdateTime
string
Secret publishing date/time
The format is UTC time of day "YYYY-MM-DDThh:mm:ssZ" in ISO8601 extended format.
- Error message output
-
API response, including the content of the error message, is returned to the caller when an Execute of Error occurs. The caller displays Message at the caller, using the information of the received response.
- Examples
-
The example below executes the API:
- Request:
POST http://immhost01:20703/im/api/v1/secret/generateInfo
Manager host name: immhost01
- Response:
< HTTP/1.1 200 OK < Content-Type: application/json { "secret": "Issued-secret", "lastUpdateTime": "2022-10-20T12:25:45Z" }