auth

Auth Service

• API version: 1.0.0
  • Build date: 2024-03-03T12:11:35.326194Z[Etc/UTC]

This API provides token-based authentication for user registration, login, and client credential management. It ensures secure communication by utilizing tokens for authentication. Users can register with unique usernames and passwords, authenticate using client credentials, retrieve client IDs and secrets, and regenerate client credentials as needed. The API supports various user roles, including 'user', 'admin', 'moderator', 'guest', and 'superadmin'.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>service</groupId>
  <artifactId>auth</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'auth' jar has been published to maven central.
    mavenLocal()       // Needed if the 'auth' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "service:auth:1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/auth-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import authservice.client.ApiClient;
import authservice.client.ApiException;
import authservice.client.Configuration;
import authservice.client.models.*;
import authservice.client.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://auth-service-latest.onrender.com/auth");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    String username = "johndoe"; // String | User's username
    String password = "password123"; // String | User's password
    try {
      ClientGet200Response result = apiInstance.clientGet(username, password);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#clientGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://auth-service-latest.onrender.com/auth

Class	Method	HTTP request	Description
DefaultApi	clientGet	GET /client	Get client ID and secret
DefaultApi	loginClientPost	POST /login/client	Logs in a user using client ID and secret
DefaultApi	regenerateClientCredentialsPost	POST /regenerate-client-credentials	Regenerate client credentials
DefaultApi	registerPost	POST /register	Registers a new user

Documentation for Models

• ClientGet200Response
• ClientGet401Response
• LoginClientPost200Response
• LoginClientPost401Response
• RegenerateClientCredentialsPost200Response
• RegisterPost201Response
• RegisterPost400Response
• RegisterPost500Response

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author