org.symphonyoss.symphony.authenticator.api

Class AuthenticationApi

java.lang.Object

org.symphonyoss.symphony.authenticator.api.AuthenticationApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-12-17T23:28:57.629-05:00")
public class AuthenticationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AuthenticationApi()
AuthenticationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
Token	v1AppAuthenticatePost() PROVISIONAL - Authenticate an application in a delegated context.
OboAuthResponse	v1AppUsernameUsernameAuthenticatePost(String username, String sessionToken) PROVISIONAL - Authenicate an application in a delegated context to act on behalf of a user
OboAuthResponse	v1AppUserUidAuthenticatePost(Long uid, String sessionToken) PROVISIONAL - Authenicate an application in a delegated context to act on behalf of a user
ExtensionAppTokens	v1AuthenticateExtensionAppPost(AuthenticateRequest 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.
Token	v1AuthenticatePost() Authenticate.
Token	v1LogoutPost(String sessionToken) Logout.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationApi

public AuthenticationApi()

AuthenticationApi

public AuthenticationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

v1AppAuthenticatePost

public Token v1AppAuthenticatePost()
                            throws ApiException

PROVISIONAL - Authenticate an application in a delegated context. Based on the SSL client certificate presented by the TLS layer, authenticate the API caller and return an application session.

Returns:

Token

Throws:

ApiException - if fails to make API call

v1AppUserUidAuthenticatePost

public OboAuthResponse v1AppUserUidAuthenticatePost(Long uid,
                                                    String sessionToken)
                                             throws ApiException

PROVISIONAL - Authenicate an application in a delegated context to act on behalf of a user

Parameters:

uid - user id (required)

sessionToken - Authorization token obtains from app/authenicate API (required)

Returns:

OboAuthResponse

Throws:

ApiException - if fails to make API call

v1AppUsernameUsernameAuthenticatePost

public OboAuthResponse v1AppUsernameUsernameAuthenticatePost(String username,
                                                             String sessionToken)
                                                      throws ApiException

PROVISIONAL - Authenicate an application in a delegated context to act on behalf of a user

Parameters:

username - username (required)

sessionToken - Authorization token obtains from app/authenicate API (required)

Returns:

OboAuthResponse

Throws:

ApiException - if fails to make API call

v1AuthenticateExtensionAppPost

public ExtensionAppTokens v1AuthenticateExtensionAppPost(AuthenticateRequest authRequest)
                                                  throws ApiException

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.

Parameters:

authRequest - application generated token (required)

Returns:

ExtensionAppTokens

Throws:

ApiException - if fails to make API call

v1AuthenticatePost

public Token v1AuthenticatePost()
                         throws ApiException

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

Returns:

Token

Throws:

ApiException - if fails to make API call

v1LogoutPost

public Token v1LogoutPost(String sessionToken)
                   throws ApiException

Logout. Logout a users session.

Parameters:

sessionToken - the session token to logout. (required)

Returns:

Token

Throws:

ApiException - if fails to make API call