XSPW gate, REGISTER_CERTIFICATE_USER function

The REGISTER_CERTIFICATE_USER function of the XSPW gate associates a user with an X.509 certificate that has been installed into the External Security Manager.

Input Parameters

CERTIFICATE
an X.509 certificate
PASSWORD
is the current password, 1 through 10 alphanumeric characters, for the userid specified by the USERID value.
PASSWORD_LENGTH
is the 8-bit length of the PASSWORD value. This parameter is only valid if PASSWORD is also specified.
USERID
is the identifier of the user (a userid of 1 through 10 alphanumeric characters) to be added to the security domain.
USERID_LENGTH
is the length of the USERID value.

Output Parameters

REASON
The following values are returned when RESPONSE is DISASTER:
  • ABEND
  • ESM_ABENDED
  • ESTAE_FAILURE
  • EXTRACT_FAILURE
  • LOOP
The following values are returned when RESPONSE is EXCEPTION:
  • ESM_INACTIVE
  • FREEMAIN_FAILED
  • GETMAIN_FAILED
  • INVALID_CERTIFICATE
  • NOTAUTH
  • SECURITY_INACTIVE
  • UNKNOWN_CERTIFICATE
  • UNKNOWN_ESM_ERROR
  • UNTRUSTED_CERTIFICATE
The following values are returned when RESPONSE is INVALID:
  • INVALID_FORMAT
  • INVALID_FUNCTION
ESM_REASON
is the optional 32-bit ESM reason returned with ESM_RESPONSE.
ESM_RESPONSE
is the optional 32-bit ESM response code to the call.
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_XSPWregister_certificate_user.html | Timestamp icon Last updated: Monday, 5 June 2017