Package com.symphony.api.authenticator

Interface AuthenticationApi

@Path("/")
public interface AuthenticationApi

Authenticator API

For bots and other on-premise processes to authenticate. Once authenticated, the bot will be able to use the methods described in serviceAPI.yaml and agentAPI.yaml. Connections to the servers will be over client authenticated TLS, the servers for this API will perform the authentication by inspecting the certificate presented by the SSLSocketClient. There will be two implementations of this API, one on your Pod and one on the Key Manager. In order to fully authenticate, an API client will have to call both of these implementations and pass both of the session tokens returned as headers in all subsequent requests to the Symphony API.

Method Summary

Modifier and Type	Method	Description
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(AppAuthenticateRequest body)	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.

Method Detail

v1AppAuthenticatePost

@POST
@Path("/v1/app/authenticate")
@Produces("application/json")
Token v1AppAuthenticatePost()

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.

v1AppUserUidAuthenticatePost

@POST
@Path("/v1/app/user/{uid}/authenticate")
@Produces("application/json")
OboAuthResponse v1AppUserUidAuthenticatePost(@PathParam("uid")
                                             Long uid,
                                             @HeaderParam("sessionToken")
                                             String sessionToken)

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

v1AppUsernameUsernameAuthenticatePost

@POST
@Path("/v1/app/username/{username}/authenticate")
@Produces("application/json")
OboAuthResponse v1AppUsernameUsernameAuthenticatePost(@PathParam("username")
                                                      String username,
                                                      @HeaderParam("sessionToken")
                                                      String sessionToken)

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

v1AuthenticateExtensionAppPost

@POST
@Path("/v1/authenticate/extensionApp")
@Consumes("application/json")
@Produces("application/json")
ExtensionAppTokens v1AuthenticateExtensionAppPost(AppAuthenticateRequest body)

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.

v1AuthenticatePost

@POST
@Path("/v1/authenticate")
@Produces("application/json")
Token v1AuthenticatePost()

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

v1LogoutPost

@POST
@Path("/v1/logout")
@Produces("application/json")
Token v1LogoutPost(@HeaderParam("sessionToken")
                   String sessionToken)

Logout. Logout a users session.