These commands are used for user authentication,
user status query, and verifying that the enrichment information has the same content.
For each command (JSON POST), the UE-MAC is mandatory.
Note: Although the NBI expects to receive an
encrypted UE-MAC address (for example, ENC12bc24c4777703327f2e0aabbf6b9f9e) when
the
request category is User Online Control, unencrypted UE-MAC are also acceptable.
However, the UE-MAC must exactly match the client_mac in the query string that
is sent
to the external subscriber portal.
Request and Re-Authentication
Synchronous Login
RUCKUS One provides a synchronous login
blocking command (RequestType=Login).
Note: The MAC Auth bypass
option helps user skipping reloging in.
During synchronous login, the
external Web portal must wait for the authentication process to complete, which
is
usually processed by the authentication server. This could result in a delayed
response if the controller is unable to get a response from the authentication
server.
The following table lists the
controller responses to the synchronous login command.
Response Type
Possible Responses
Normal response
101, Client
authorized: Response if the user is already authorized.
201, Login
succeeded: Response if the login is accepted.
Service error
300, Not found:
Response if the lookup fails with given UE-MAC address or
UE-IP address.
301, Login failed:
It will be replaced if the authentication reply message is
returned.
400, Internal
server error: Response when a controller internal error
occurs.
401, Authentication
server error: Response when an authentication connection
error occurs or the connection request times out.
General error
302, Bad request:
Response if the JSON request is not well-formed.
303, Version not
supported: Response if there is a version mismatch.
304, Command not
supported: Response if the request type is not supported.
305, Category not
supported: Response if the request category not supported.
306, Wrong request
password: Response if the request password is mismatched.
Note: If an authentication process
has a result (not pending), RUCKUS Cloud responds to it only once. For example,
if RUCKUS Cloud replies 301, login failed, to the web portal server, and the
web
portal server sends the same query, the response will be 100, Unauthorized. If
the controller replies 201, login was successful, and the web portal server
queries again, the response will be 101, Authorized.