5.4.5 IM Client secret issue

Description

Issue IM client secret.

When linking a manager host with a user-specific OSS, or a CloudWatch Logs/AzureMonitor provided by JP1/IM - Manager or lower manager, use IM client secret to perform authentication by communicating with the intelligent integrated management infrastructure and the partner.

Execution permissions

Following permissions are required:

JP1 resource group: *
JP1 permission level: JP1_Console_Admin

API version

Format

Request line

POST /application/component/apiVersion/secret/client/generateInfo httpVersion

Request message body

{
    "clientId": IM-client-ID
}

Response message body

{
  "clientSecret": IM-client-secret-for-authentication,
  "lastUpdateTime": IM-client-secret-issue-date/time
}

Here are the parameters that you specify for message body of the request:

Member name	Data type	Optional	Description
`clientId`	`string`	No	Specifies the listing of ID of IM client secret that you want to issue. When working with JP1/IM, the elements of a listing can be any text. However, the following character strings cannot be specified: String beginning with "`AGENT_`" String beginning with "`MANAGER_`" The number of characters that can be specified is 1~280, and the characters that can be specified are ASCII codes (0x20~0x7e (excluding ":").

Member name

Data type

Optional

Description

clientId

string

Specifies the listing of ID of IM client secret that you want to issue.

When working with JP1/IM, the elements of a listing can be any text.

However, the following character strings cannot be specified:

String beginning with "AGENT_"
String beginning with "MANAGER_"

The number of characters that can be specified is 1~280, and the characters that can be specified are ASCII codes (0x20~0x7e (excluding ":").

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.
`400`	`KAJY68002-E`	The request parameter is invalid.
`400`	`KAJY68004-E`	The same IM client ID has been added.
`403`	`KAJY01000-E`	Insufficient privilege for the user used for authentication.
`500`	`KAJY68008-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
`clientSecret`	`string`	Issued IM client secret
`lastUpdateTime`	`string`	IM client secret publishing date/time The format is UTC time of day "`YYYY-MM-DDThh:mm:ssZ`" in ISO8601 extended format.

Member name

Data type

Description

clientSecret

string

Issued IM client secret

lastUpdateTime

string

IM client 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/client/generateInfo
{
    "clientId": "clientSecret1"
}

Manager host name: immhost01

Response:

< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "clientSecret": "Issued-IM-client-secret",
   "lastUpdateTime": "2022-10-20T12:25:45Z"
}

To Page Top