5.4.4 IM Client secret delete

Description

Delete IM client secret that was added to the database.

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/deleteInfo httpVersion

Request message body

{
    "clientIds": [ IM-client-ID, .... ]
}

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

Member name	Data type	Optional	Description
`clientIds`	`string[]`	No	Specifies the listing of ID of IM client secret that you want to delete. 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_`" Strings beginning with "`MANAGER_`" other than "`MANAGER__INTEGRATED_ host name`" 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

clientIds

string[]

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

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_"
Strings beginning with "MANAGER_" other than "MANAGER__INTEGRATED_ host name"

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.
`403`	`KAJY01000-E`	Insufficient privilege for the user used for authentication.
`500`	`KAJY68007-E`	DB accessible error The specified IM client ID is not added on DB.

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/deleteInfo
 
{
    "clientIds": [ "clientId1", "clientId2" ]
}

Manager host name: immhost01

Response:

< HTTP/1.1 500 Internal Server Error
< Content-Type: application/json
{
    "timestamp": 1585561108345,
    "status": 500,
    "error": "Internal Server Error",
    "exception":"XXXXXXXXXXXXXXXXXXXXXXX",
    "message": "Failed to delete an IM client secret.",
    "path": "/im/api/v1/secret/client/deleteInfo ",
    "messageId": " KAJY68007-E"
}

To Page Top