com.symphony.bdk.gen.api

Class AuthenticationApi

java.lang.Object

com.symphony.bdk.gen.api.AuthenticationApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-02-19T08:46:07.949+01:00[Europe/Paris]")
public class AuthenticationApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AuthenticationApi(com.symphony.bdk.http.api.ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
com.symphony.bdk.http.api.ApiClient	getApiClient() Get the API cilent
Token	pubkeyAppAuthenticatePost(AuthenticateRequest authenticateRequest) Authenticate an App with public key Based on an authentication request token signed by the application's RSA private key, authenticate the API caller and return a session token.
com.symphony.bdk.http.api.ApiResponse<Token>	pubkeyAppAuthenticatePostWithHttpInfo(AuthenticateRequest authenticateRequest) Authenticate an App with public key Based on an authentication request token signed by the application's RSA private key, authenticate the API caller and return a session token.
Token	pubkeyAppUsernameUsernameAuthenticatePost(java.lang.String sessionToken, java.lang.String username) Authenticate an application in a delegated context to act on behalf of a user
com.symphony.bdk.http.api.ApiResponse<Token>	pubkeyAppUsernameUsernameAuthenticatePostWithHttpInfo(java.lang.String sessionToken, java.lang.String username) Authenticate an application in a delegated context to act on behalf of a user
Token	pubkeyAppUserUserIdAuthenticatePost(java.lang.String sessionToken, java.lang.Long userId) Authenticate an application in a delegated context to act on behalf of a user
com.symphony.bdk.http.api.ApiResponse<Token>	pubkeyAppUserUserIdAuthenticatePostWithHttpInfo(java.lang.String sessionToken, java.lang.Long userId) Authenticate an application in a delegated context to act on behalf of a user
Token	pubkeyAuthenticatePost(AuthenticateRequest authenticateRequest) Authenticate with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token.
com.symphony.bdk.http.api.ApiResponse<Token>	pubkeyAuthenticatePostWithHttpInfo(AuthenticateRequest authenticateRequest) Authenticate with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token.
ExtensionAppTokens	v1PubkeyAppAuthenticateExtensionAppPost(AuthenticateExtensionAppRequest authenticateRequest) Authenticate extension app with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token.
com.symphony.bdk.http.api.ApiResponse<ExtensionAppTokens>	v1PubkeyAppAuthenticateExtensionAppPostWithHttpInfo(AuthenticateExtensionAppRequest authenticateRequest) Authenticate extension app with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthenticationApi

public AuthenticationApi(com.symphony.bdk.http.api.ApiClient apiClient)

Method Detail

getApiClient

public com.symphony.bdk.http.api.ApiClient getApiClient()

Get the API cilent

Returns:

API client

pubkeyAppAuthenticatePost

public Token pubkeyAppAuthenticatePost(AuthenticateRequest authenticateRequest)
                                throws com.symphony.bdk.http.api.ApiException

Authenticate an App with public key Based on an authentication request token signed by the application's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid app, malformed authentication token, app's public key not imported in the pod, invalid token signature etc.).

Parameters:

authenticateRequest - (required)

Returns:

Token

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

pubkeyAppAuthenticatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<Token> pubkeyAppAuthenticatePostWithHttpInfo(AuthenticateRequest authenticateRequest)
                                                                                   throws com.symphony.bdk.http.api.ApiException

Authenticate an App with public key Based on an authentication request token signed by the application's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid app, malformed authentication token, app's public key not imported in the pod, invalid token signature etc.).

Parameters:

authenticateRequest - (required)

Returns:

ApiResponse<Token>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

pubkeyAppUserUserIdAuthenticatePost

public Token pubkeyAppUserUserIdAuthenticatePost(java.lang.String sessionToken,
                                                 java.lang.Long userId)
                                          throws com.symphony.bdk.http.api.ApiException

Authenticate an application in a delegated context to act on behalf of a user

Parameters:

sessionToken - App Session authentication token. (required)

userId - the user ID (required)

Returns:

Token

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

pubkeyAppUserUserIdAuthenticatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<Token> pubkeyAppUserUserIdAuthenticatePostWithHttpInfo(java.lang.String sessionToken,
                                                                                                    java.lang.Long userId)
                                                                                             throws com.symphony.bdk.http.api.ApiException

Authenticate an application in a delegated context to act on behalf of a user

Parameters:

sessionToken - App Session authentication token. (required)

userId - the user ID (required)

Returns:

ApiResponse<Token>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

pubkeyAppUsernameUsernameAuthenticatePost

public Token pubkeyAppUsernameUsernameAuthenticatePost(java.lang.String sessionToken,
                                                       java.lang.String username)
                                                throws com.symphony.bdk.http.api.ApiException

Authenticate an application in a delegated context to act on behalf of a user

Parameters:

sessionToken - App Session authentication token. (required)

username - the username (required)

Returns:

Token

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

pubkeyAppUsernameUsernameAuthenticatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<Token> pubkeyAppUsernameUsernameAuthenticatePostWithHttpInfo(java.lang.String sessionToken,
                                                                                                          java.lang.String username)
                                                                                                   throws com.symphony.bdk.http.api.ApiException

Authenticate an application in a delegated context to act on behalf of a user

Parameters:

sessionToken - App Session authentication token. (required)

username - the username (required)

Returns:

ApiResponse<Token>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

pubkeyAuthenticatePost

public Token pubkeyAuthenticatePost(AuthenticateRequest authenticateRequest)
                             throws com.symphony.bdk.http.api.ApiException

Authenticate with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid user, malformed authentication token, user's public key not imported in the pod, invalid token signature etc.).

Parameters:

authenticateRequest - (required)

Returns:

Token

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

pubkeyAuthenticatePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<Token> pubkeyAuthenticatePostWithHttpInfo(AuthenticateRequest authenticateRequest)
                                                                                throws com.symphony.bdk.http.api.ApiException

Authenticate with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid user, malformed authentication token, user's public key not imported in the pod, invalid token signature etc.).

Parameters:

authenticateRequest - (required)

Returns:

ApiResponse<Token>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1PubkeyAppAuthenticateExtensionAppPost

public ExtensionAppTokens v1PubkeyAppAuthenticateExtensionAppPost(AuthenticateExtensionAppRequest authenticateRequest)
                                                           throws com.symphony.bdk.http.api.ApiException

Authenticate extension app with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid user, malformed authentication token, user's public key not imported in the pod, invalid token signature etc.).

Parameters:

authenticateRequest - (required)

Returns:

ExtensionAppTokens

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1PubkeyAppAuthenticateExtensionAppPostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<ExtensionAppTokens> v1PubkeyAppAuthenticateExtensionAppPostWithHttpInfo(AuthenticateExtensionAppRequest authenticateRequest)
                                                                                                              throws com.symphony.bdk.http.api.ApiException

Authenticate extension app with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid user, malformed authentication token, user's public key not imported in the pod, invalid token signature etc.).

Parameters:

authenticateRequest - (required)

Returns:

ApiResponse<ExtensionAppTokens>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call