Authenticate with a secondary z/OSMF instance

You can use this operation to request that the primary z/OSMF instance submit an HTTPS request to authenticate with a secondary z/OSMF instance.

HTTP method and URI path

POST /zosmf/gateway/logon

where:

zosmf/gateway identifies the multisystem routing services.
logon informs the service that the request is to authenticate with a system.

Standard headers

Use the following standard HTTP header with this request:

Content-Type: application/json

Custom headers

None.

Request content

Your request must include the following JSON object:

{
  "userid":"user-ID",
  "password":"password",
  "systemName":"system-name"
}

where:

user-ID: z/OS user ID that allows the user to access the specified system. The user ID is the same user ID that is specified in your installation's z/OS security management facility (for example, RACF). The user ID is required.
password: Password or pass phrase associated with the z/OS user ID. The password is required.
system-name: Unique name assigned to the system definition.

Usage considerations

See Usage considerations for the z/OSMF REST services.

Required authorizations

See Required authorizations.

Expected response

On completion, the service returns an HTTP response, which includes a status code indicating whether your request completed. Status code 200 indicates success. A status code of 4nn or 5nn indicates that an error has occurred. For more details, see Error handling.

The response also includes a JSON object that indicates whether the request was successful. If the logon request is successful, the timeout for the Lightweight Third Party Authentication (LTPA) token is returned, as depicted in Figure 1.

Figure 1. Successful response when authenticating with a system

{"timeout":7564710}

If the logon request is unsuccessful, the JSON object contains an error message, as depicted in Figure 2.

Figure 2. Response when the authentication request fails

{"error":true,"errMsg":"IZUG410E: The user ID, password, or pass phrase is not valid. 
Enter the correct values for your security management product."}

Example

To authenticate with system sys057, submit the following request:

Figure 3. Sample request to authenticate with a system

POST /zosmf/gateway/logon HTTP/1.1
Host: zosmf1.yourco.com

{"userid":"claire","password":"abc123","systemName":"sys057"}