docs.AuthenticationApi.md Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of symphony-authenticator-java-jersey2-client Show documentation
There is a newer version: 1.50.1
Show newest version
# AuthenticationApi

All URIs are relative to *https://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**v1AuthenticateExtensionAppPost**](AuthenticationApi.md#v1AuthenticateExtensionAppPost) | **POST** /v1/authenticate/extensionApp | Authenticate a client-extension application
[**v1AuthenticatePost**](AuthenticationApi.md#v1AuthenticatePost) | **POST** /v1/authenticate | Authenticate.



# **v1AuthenticateExtensionAppPost**
> ExtensionAppTokens v1AuthenticateExtensionAppPost(authRequest)

Authenticate a client-extension application

Based on the application's SSL client certificate presented by the TLS layer, it authenticates the client-extension application and return a symphony verification token. 

### Example
```java
// Import classes:
//import org.symphonyoss.symphony.authenticator.invoker.ApiException;
//import org.symphonyoss.symphony.authenticator.api.AuthenticationApi;


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();
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **authRequest** | [**AuthenticateRequest**](AuthenticateRequest.md)| application generated token |

### Return type

[**ExtensionAppTokens**](ExtensionAppTokens.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


# **v1AuthenticatePost**
> Token v1AuthenticatePost()

Authenticate.

Based on the SSL client certificate presented by the TLS layer, authenticate the API caller and return a session token. 

### Example
```java
// Import classes:
//import org.symphonyoss.symphony.authenticator.invoker.ApiException;
//import org.symphonyoss.symphony.authenticator.api.AuthenticationApi;


AuthenticationApi apiInstance = new AuthenticationApi();
try {
    Token result = apiInstance.v1AuthenticatePost();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AuthenticationApi#v1AuthenticatePost");
    e.printStackTrace();
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**Token**](Token.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json