5.14.1 Single sign-on mapping definition application

Description

Applies the mapping information defined in the single sign-on mapping definition file (imdd_sso_mapping.properties) to the Intelligent Integrated Management Base. The set information is immediately applied to the Intelligent Integrated Management Base.

If the definition is applied when the single sign-on mapping definition file has no valid property at all, the KAJY52031-W message is added to the response and the applied single sign-on mapping definitions are cleared.

For details on the single sign-on mapping definition file (imdd_sso_mapping.properties), see Single sign-on mapping definition file (imdd_sso_mapping.properties) in Chapter 2. Definition Files.

Execution permissions

• JP1_Console_Admin

• JP1_Console_Operator

API version

v1

Format

Request line

POST /application/component/apivVersion/updateSsoMap httpVersion

Request message body

None

Parameters

None

Status codes

The following table describes the status codes that may be returned as a response to a request:

Status code	Return value	Message	Description
200 403	--	None	The single sign-on mapping definition application REST API was successfully processed.
		KAJY52031-W	The single sign-on mapping definition file has no valid definition.
500	7	KAJY01000-E	The logged-in user does not have the permission to execute the REST API.
500	2	KAJY52022-E	Failed to establish exclusive control for single sign-on mapping definitions.
	13	KAJY52023-E	Failed to apply the single sign-on mapping definition.
	14	KAJY52026-E	The single sign-on mapping definition file was not correctly loaded.

Return values

The following table describes the return values:

Return value	Description
2	Failed to establish exclusive control
7	Execution permission error
13	Update error
14	Definition file load error
255	System error

Notes

• Concurrent executions of this API are not allowed. Concurrent executions of this API result in an error.

• When an error occurs during the execution of this API, an error message is output to the integrated trace log. An API error response containing the error message is returned to the caller of the API. Using the information provided in the received response, the caller displays the message. When the REST API is called from the jddupdatessomap command and an error response is subsequently returned, error information is output to the standard error output. For details on the jddupdatessomap command, see jddupdatessomap in Chapter 1. Commands.

Examples

Request:

POST http://hostname:20703/im/api/v1/updateSsoMap HTTP/1.1
Authorization: Bearer xxxx
Accept-Language: ja
Content-Type: application/json
Accept: application/json

Response at the end of the warning:

  {
  "messageList": [
    {
      "messageId": "KAJY52031-W",
      "message": "The Single Sign-on mapping definition file does not contain a valid definition."
    }
  ]
}

To Page Top