Typical Result Codes for Auth and XAuth

For an Auth or XAuth request, the most common result code triplets are listed in the table below. These will generally be suitable for most ESM Modules. For an explanation of the response classes (Allow, Deny, Fail, and Unknown), see the section ESF API Calls.

rc return reason Meaning
saf78_SAF_RC_SUCCESS (0) saf78_RC_USER_IS_AUTH (0) saf78_RS_NORMAL (0) Authorization is granted, no additional information (this is an Allow result)
saf78_SAF_RC_SUCCESS (0) saf78_RC_ACCESS_INFO (20) saf78_RS_ACCESS_{NONE (0), READ (4), UPDATE (8), CONTROL (12), ALTER (16)} (Auth only) The user has the specified level of access to the resource
saf78_SAF_RC_NOT_COMPLETE (4) saf78_RC_NO_DECISION (0) saf78_RS_ESM_NOT_CALLED (0) The ESM Module does not implement this procedure, or it has decided that this request does not apply to it (this is an Unknown result)
saf78_SAF_RC_NOT_COMPLETE (4) saf78_RC_RESOURCE_NOT_PROT (4) saf78_RS_NO_RESOURCE_PROF (0) The ESM does not have a record for this resource (this is an Unknown result)
saf78_SAF_RC_FAILURE (8) saf78_RC_USER_NOT_AUTH (8) saf78_RS_NORMAL (0) Authorization is denied (this is a Deny result)
saf78_SAF_RC_FAILURE (8) saf78_RC_DATABASE_ERROR (92) saf78_RS_NORMAL (0) Authorization failed because the ESM Module or its associated ESM was unable to process the request (this is a Fail result)