Authentication Methods
Authentication methods are provided in the auth
namespace. The following methods are provided for authenticating
with ULN:
auth.login
The login
method signs in to ULN using a specified username and
authentication token.
The input parameters are:
- Input Parameters
string username
-
The Oracle Account username to use for the session. For example:
myuser@example.com
string password
-
The authentication token to use for the session. See Generating an Authentication Token for more information. For example:
V5wNNgnlu1tZ_gx6dg
- Return Parameters
string sessionKey
-
The session key for the session. All other methods use the session key during the session. For example:
JyUVNoT74BFaRJ6fRjDIQ5idPmCaj5UJLb76E2f45Gc
This key is active until you call the
auth.logout
method.
auth.logout
The logout
method logs out of the ULN session
specified by the session key.
- Input Parameters
string sessionKey
-
The session key of the session to be terminated. For example:
JyUVNoT74BFaRJ6fRjDIQ5idPmCaj5UJLb76E2f45Gc
- Return Parameters
int
-
The method returns an
int
error code, which indicates whether the session terminated correctly. A value of1
indicates a successful return.