z/OS Connect EE endpoint connection messages

BAQR1001E:  The requestBody attribute must be specified when the credentialLocation attribute is set to body.

   Explanation    When a credential is passed in the body of the request to the authorization server, the requestBody attribute must specify the format of the request.
   Action    Specify the requestBody attribute to describe the format of the body.

BAQR1002E:  The tokenPath attribute must be specified on the tokenResponse element because the tokenLocation attribute is set to body and the responseFormat attribute is set to JSON.

   Explanation    z/OS Connect expects the generated token to be returned from the authorization server in a JSON body. You must specify the path to the token so that it can be retrieved and included in the API request from z/OS Connect to the API provider.
   Action    Specify a JSON path in the tokenPath attribute to identify where the token is returned in the body.

BAQR1003E:  The responseFormat attribute must be specified on the tokenResponse element when the tokenLocation attribute is set to body.

   Explanation    z/OS Connect expects the generated token to be returned from the authentication server in the HTTP request body. You must specify the responseFormat attribute so that the returned JWT can be retrieved by z/OS Connect.
   Action    Specify a value for the responseFormat attribute on the tokenResponse element. Acceptable values are Text or JSON.

BAQR1004E:  The tokenEndpoint attribute must be specified on the zosconnect_authorizationServer element.

   Explanation    A token endpoint URL must be specified for the tokenEndpoint attribute so that the request for a JWT can be routed to the authentication server.
   Action    Specify a valid value to the tokenEndpoint attribute on the zosconnect_authorizationServer element.

BAQR1005E:  The header attribute must be specified on the {0} element.

   Explanation    You must specify the header attribute on the specified element.
   Action    Specify a correct value for the header attribute on the specified element.

BAQR1006E:  An error occurred when z/OS Connect EE attempted to access the authentication/authorization server. Error: {0}

   Explanation    z/OS Connect EE failed to access the authentication/authorization server for JWTs/OAuth tokens.
   Action    Check the error message for details, inspect the authentication/authorization server logs and correct the configuration.

BAQR1007E:  An error response with a null body is returned from the authentication server.

   Explanation    An error response is returned from the authentication server. The response body is null.
   Action    Contact the administrator of the authentication server for the detailed error reason.

BAQR1008E:  An error occurred when the z/OS Connect EE server attempted to generate a JWT. Error:{0}

   Explanation    An error occurred when the z/OS Connect EE server attempted to generate a JWT.
   Action    Check the error message for details and correct the configuration in server.xml.

BAQR1010E:  JWT claims configuration error. The value of the claims subelement of the {0} element {1} must be a JSON string.

   Explanation    The value of the specified claims subelement is either not a valid JSON string, or contains XML markup characters.
   Action    Either correct the JSON string, or if the JSON string contains XML markup characters, include the JSON string inside a CDATA section so the characters are treated as literals.

BAQR1011I:  Successfully cleared the token cache.

   Explanation    A request was made to clear the token cache and the request was completed successfully.
   Action    None.

BAQR1012W:  Failed to obtain the token cache.

   Explanation    The token cache could not be obtained. Authorization tokens will not be cached, which may impact performance.
   Action    If problems persist, contact IBM Software Support.

BAQR1013E:  The jwtAuthenticationTokenRef attribute on the zosconnect_oAuthConfig element {0} references an element that is either not defined or invalid.

   Explanation    The jwtAuthenticationTokenRef attribute must specify the id of a zosconnect_oAuthTokenConfig element, and this must define the tokenGeneratorRef and tokenSubject attributes.
   Action    Correct the value of jwtAuthenticationTokenRef attribute or correct the definition of the referenced element.

BAQR1080E:  The value {0} for port attribute of EndpointConnection {1} in server.xml is not a valid port number. Port should be 0 ~ 65535.

   Explanation    The value of port attribute should be 0 ~ 65535.
   Action    Change the port to a valid value.

BAQR1081W:  The basicAuthRef attribute in the zosconnect_endpointConnection element is deprecated.

   Explanation    A new attribute named authenticationConfigRef is added in the endpointConnection element to identify the basic or OAuth authentication data to be used for connecting to a remote REST endpoint. The basicAuthRef attribute is deprecated. If the value of both the attributes are set in the zosconnect_endpointConnection element, only the authenticationConfigRef attribute value is used. It is recommended that you use authenticationConfigRef rather than basicAuthRef.
   Action    Use the authenticationConfigRef attribute instead of the basicAuthRef attribute.

BAQR1082E:  The authorization server returned status code {0} and response JSON: {1}.

   Explanation    The authorization server returned an error status code or did not return a token in the "access_token" parameter.
   Action    Check the reason for the failure, correct the error and retry.

BAQR1083E:  The authorization server used for OAuth authentication does not exist.

   Explanation    The authServerRef attribute in the zosconnect_oAuthConfig element must be associated with an existent zosconnect_authorizationServer element in the server.xml file.
   Action    Ensure the zosconnect_authorizationServer element needed by the OAuth authentication is set and referenced by the authServerRef attribute of the zosconnect_oAuthConfig element correctly.

BAQR1084E:  The authorization server token endpoint has an invalid prefix.

   Explanation    The authorization server token endpoint must have an https prefix because the OAuth 2.0 protocol specifies that an authorization server token endpoint must use TLS.
   Action    Prefix the tokenEndpoint value with https and configure a TLS connection.

BAQR1085E:  Parameter username used to request the OAuth access token is null.

   Explanation    Parameter username contained in an OAuth access token request can not be null.
   Action    Specify a value for the parameter username.

BAQR1086E:  Parameter password used to request the OAuth access token is null.

   Explanation    Parameter password contained in an OAuth access token request can not be null.
   Action    Specify a value for the parameter password.

BAQR1087E:  Parameter client_id used to request the OAuth access token is null.

   Explanation    Parameter client_id contained in an OAuth access token request can not be null.
   Action    Specify a value for the parameter client_id.

BAQR1088E:  Parameter client_secret used to request the OAuth access token is null.

   Explanation    Parameter client_secret contained in an OAuth access token request can not be null.
   Action    Specify a value for the parameter client_secret.

BAQR1089E:  The response body returned from the authorization server is not in the JSON format.

   Explanation    z/OS Connect expects the response body to be returned from the authorization server in a JSON format. A response body that is not in a JSON format returns, probably because of the following reasons:1.The value of the tokenEndpoint attribute on the zosconnect_authorizationServer element is not a token endpoint URL. The token endpoint URL can be obtained form the server discovery endpoint: https://[base-server-url]/token. 2.The client or user credentials used for authentication and authorization are invalid. You can specify the credentials in the z/OS application or in the server.xml file.
   Action    Ensure a correct token endpoint URL is specified for the tokenEndpoint attribute and the client or user credentials are valid.

BAQR1090W:  The expiration time specified with the expires_in parameter for the access token exceeds the maximum value that the cache can support.

   Explanation    The expiration time specified for the access token exceeds the maximum value that the cache can support. The maximum value is 69 years. If a value that is larger than 69 years is set on the expire_in parameter, the maximum value is used by default.
   Action    Ensure the value of the expires_in parameter is equal or smaller than the maximum value.

BAQR1091E:  Unable to find the parameter {0} in the response body that is returned from the authorization server.

   Explanation    The specified parameter is not in the response body that is returned from the authorization server.
   Action    Ensure the response body that is returned from the authorization server follows the OAuth 2.0 specification.

BAQR1092E:  Authentication or authorization failed for the z/OS Connect EE server.

   Explanation    The z/OS Connect server cannot be authenticated as a valid identity or authorized access to the requested resources.
   Action    Ensure the credential information used for authentication or authorization is correct.

BAQR1093E:  Internal server error.

   Explanation    z/OS Connect EE API requester encountered an error while processing a request.
   Action    Contact the z/OS Connect EE system administrator to check messages.log for the cause of the error.

BAQR1094E:  An error response is returned from the authentication server. Error: {0}.

   Explanation    An error response is returned from the authentication server, probably because the request for a JWT is invalid.
   Action    Check the reason for the failure and correct as required.

BAQR1095E:  The user credentials were not supplied to request a token from an authorization server.

   Explanation    z/OS Connect was unable to retrieve the credentials. They were either not supplied by the calling application or were not specified in the zosconnect_authData element.
   Action    Ensure that the communication stub is up to date to pass the credential from the calling application. Check that the user credentials are supplied by the calling application or are specified in the zosconnect_authData element.

BAQR1096E:  The authenticationConfigRef attribute references conflicting authentication elements {0} and {1}, as both elements use the same header {2}.

   Explanation    When the authenticationConfigRef attribute references multiple authentication elements, the referenced elements cannot use the same header.
   Action    Ensure the authentication elements referenced by the authenticationConfigRef attribute on the zosconnect_endpointConnection element use different headers.

BAQR1097E:  The z/OS Connect EE server failed to obtain the JWT from the header {0} that is specified in the tokenResponse element.

   Explanation    The z/OS Connect EE server cannot obtain the JWT from the specified header in the response that is returned from the authentication server.
   Action    Ensure the token location where the generated JWT is returned in the response and the header attribute are correctly specified.

BAQR1098E:  The z/OS Connect EE server failed to obtain the JWT from the response body that is specified in the tokenResponse element.

   Explanation    The z/OS Connect EE server cannot obtain the JWT from the response body in the response that is returned from the authentication server.
   Action    Ensure the token location where the generated JWT is returned in the response body is correctly specified.

BAQR1099E:  The z/OS Connect EE server failed to obtain the JWT from the JSON string that is specified in the tokenResponse element.

   Explanation    The z/OS Connect EE server cannot obtain the JWT from the JSON string in the response that is returned from the authentication server.
   Action    Ensure the token location where the generated JWT is returned in the response and the tokenPath attribute are correctly specified.

BAQR1100E:  The value of the requestBody attribute in the tokenRequest element is invalid.

   Explanation    The value of the requestBody attribute must be a valid JSON string. The JSON string must contain the format for how the credential is contained in the body. The format expects variables for user ID and password. If the ${userid} or ${password} syntax is used the values are replaced at runtime with the credentials provided by the calling application.
   Action    Specify a valid value for the requestBody attribute.