User Authentication

1. Overview

This screen provides authentication and user management functionality for the Service API. It enables operators to log in with their credentials, verify user existence, recover usernames via email addresses, and retrieve client IP information. These services help maintain secure access to the system and support account recovery processes.

2. Functionality and Usage

2.1. User Login

Authenticates a user and returns detailed user information and associated device list.

  • Username – Enter your login credential.

  • Password – Enter your password.

  • Login – Click to authenticate and access the system.

Upon successful authentication, the system returns:

  • User permission level

  • List of associated devices with details:

    • Serial number

    • Root object path

    • Device model

    • OUI (Organizationally Unique Identifier)

    • Manufacturer

    • Product class

2.2. Find Username

Verifies whether a specific username exists in the system.

  • Username – Enter the username to check.

  • Check Existence – Click to verify if the username exists.

Results indicate whether the username was found or not:

  • Username found (Success: Code 100)

  • Username not found (Failed: Code 200)

2.3. Username Recovery

Retrieves a username associated with a registered email address.

  • Email Address – Enter the email address used during signup.

  • Get Username – Click to retrieve the associated username.

Results include:

  • For successful recovery: The username associated with the provided email.

  • For failed recovery: A message indicating the login was not found.

2.4. Client IP Information

Retrieves the IP address of the client making the request.

  • Get IP Address – Click to retrieve your current IP address.

Results display the current IP address of the client (user) that sent the request.

3. Account Security Recommendations

  1. Password Protection – Use strong, unique passwords for your account.

  2. Regular Updates – Change your password periodically.

  3. Secure Environment – Only log in from secure networks and computers.

  4. Session Management – Log out when finished to prevent unauthorized access.

  5. Recovery Information – Keep your email address up-to-date for account recovery.

4. Status Codes

  • 100 – Success

  • 201 – Username not found

  • 202 – Database error

  • 203 – Incorrect request structure

  • 204 – General error

  • 205 – ACS connection error