ss.symphony.symphony-authenticator-java-jersey2-client.1.0.1.source-code.README.md Maven / Gradle / Ivy
# swagger-java-client
## Requirements
Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
mvn install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
mvn deploy
```
Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
### Maven users
Add this dependency to your project's POM:
```xml
io.swagger
swagger-java-client
1.0.0
compile
```
### Gradle users
Add this dependency to your project's build file:
```groovy
compile "io.swagger:swagger-java-client:1.0.0"
```
### Others
At first generate the JAR by executing:
mvn package
Then manually install the following JARs:
* target/swagger-java-client-1.0.0.jar
* target/lib/*.jar
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Java code:
```java
import org.symphonyoss.symphony.authenticator.invoker.*;
import org.symphonyoss.symphony.authenticator.invoker.auth.*;
import org.symphonyoss.symphony.authenticator.invoker.model.*;
import org.symphonyoss.symphony.authenticator.api.AuthenticationApi;
import java.io.File;
import java.util.*;
public class AuthenticationApiExample {
public static void main(String[] args) {
AuthenticationApi apiInstance = new AuthenticationApi();
AuthenticateRequest authRequest = new AuthenticateRequest(); // AuthenticateRequest | application generated token
try {
ExtensionAppTokens result = apiInstance.v1AuthenticateExtensionAppPost(authRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AuthenticationApi#v1AuthenticateExtensionAppPost");
e.printStackTrace();
}
}
}
```
## Documentation for API Endpoints
All URIs are relative to *https://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuthenticationApi* | [**v1AuthenticateExtensionAppPost**](docs/AuthenticationApi.md#v1AuthenticateExtensionAppPost) | **POST** /v1/authenticate/extensionApp | Authenticate a client-extension application
*AuthenticationApi* | [**v1AuthenticatePost**](docs/AuthenticationApi.md#v1AuthenticatePost) | **POST** /v1/authenticate | Authenticate.
*PodApi* | [**v1AppPodCertificateGet**](docs/PodApi.md#v1AppPodCertificateGet) | **GET** /v1/app/pod/certificate | Retrieve the certificate that can be use to validate the JWT token obtain through the extension application authentication flow.
## Documentation for Models
- [AuthenticateRequest](docs/AuthenticateRequest.md)
- [Error](docs/Error.md)
- [ExtensionAppTokens](docs/ExtensionAppTokens.md)
- [PodCertificate](docs/PodCertificate.md)
- [Token](docs/Token.md)
## Documentation for Authorization
All endpoints do not require authorization.
Authentication schemes defined for the API:
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issue.
## Author