Authenticate allows you to determine a user’s rights to access an ORS. If the user has the right to access the ORS, the message in the response object is STATUS_GRANTED. Otherwise it is STATUS_DENIED. The response contains a list of the roles assigned to the user and information about the user’s password—if and when it expires and whether it is externally authenticated using a service such as LDAP.
Use Case
This is the common scenario for using the authenticate request:
Determine a user’s access rights to an ORS
—Before using a request that requires specific access privileges, you can use authenticate to determine if the user possesses the required rights.