set_session_auth_m Sample Call and Response
This example shows a customer logging into a User Self Service application with a user ID and password, based on the set_session_auth_m method defined in plsql_m_r73.yml.
This example covers a straightforward user ID and password login that starts an Aria session. It does not cover the alt_caller_id field, which a caller can use to record a separate identifier for the party that initiated the session, since that field is optional and not needed to tell this login story.
Sample call
{
"rest_call": "set_session_auth_m",
"output_format": "json",
"client_no": 12345,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"user_id": "jsmith_uss",
"password": "Tr0ub4dor&3"
}
The rest_call and output_format fields are added by the REST layer and are not part of the method's own argument list. Unlike the related set_session_m method, which starts a session for a user ID that Aria has already established as valid within the calling application, set_session_auth_m independently authenticates the user ID and password combination as part of starting the session, making it suited to a direct customer login screen. Both user_id and password are optional per the method definition, but a real login attempt supplies both; this example does so.
Sample response
{
"session_id": "USS-SESSION-91027",
"error_code": 0,
"error_msg": "OK"
}
An error_code value of zero, together with an error_msg value of "OK", indicates that Aria authenticated the user ID and password and started a session, returning the client-assigned session_id for use in subsequent calls within that session. A nonzero error_code, paired with a descriptive error_msg, indicates that authentication failed, for example because the password did not match the user ID. This example leaves out the error_details field, since that field is internal to Aria and is not returned to callers.