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.

Input Parameters

Parameter Description
username The Oracle Account username to use for the session.
password The authentication token to use for the session. See Generating an Authentication Token for more information.

Return Parameters

Parameter Description
sessionKey The session key for the session. All other methods use the session key during the session. This key is active until you call the auth.logout method.

Example Input Parameters

username: example.user@oracle.com
password: MCWvP+0meWmwJmL7esd
            

Example Output Parameters

JyUVNoT74BFaRJ6fRjDIQ5idPmCaj5UJLb76E2f45Gc

auth.logout

The logout method logs out of the ULN session specified by the session key.

Input Parameters

Parameter Description
sessionKey The session key of the session to be terminated. For example: JyUVNoT74BFaRJ6fRjDIQ5idPmCaj5UJLb76E2f45Gc

Return Parameters

Parameter Description
int The method returns an int error code, which indicates whether the session terminated correctly. A value of 1 indicates a successful return.

Example Input Parameters


sessionKey: ebQ3nS8QOmXoDIsXbrZTcD4xDMzsmJUo7yhoSi6VwPT
            

Example Output Parameters


1