Package com.symphony.api.login

Interface AuthenticationApi

@Path("/")
public interface AuthenticationApi

Login 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. Authentication requests will expect the user to pass a token containing user identification information and signed by the user's private key 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	pubkeyAppAuthenticatePost(AuthenticateRequest body)	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(String sessionToken, String username)	Authenticate an application in a delegated context to act on behalf of a user
Token	pubkeyAppUserUserIdAuthenticatePost(String sessionToken, Long userId)	Authenticate an application in a delegated context to act on behalf of a user
Token	pubkeyAuthenticatePost(AuthenticateRequest body)	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 body)	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.

Method Detail

pubkeyAppAuthenticatePost

@POST
@Path("/pubkey/app/authenticate")
@Consumes("application/json")
@Produces("application/json")
Token pubkeyAppAuthenticatePost(AuthenticateRequest body)

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.).

pubkeyAppUserUserIdAuthenticatePost

@POST
@Path("/pubkey/app/user/{userId}/authenticate")
@Produces("application/json")
Token pubkeyAppUserUserIdAuthenticatePost(@HeaderParam("sessionToken")
                                          String sessionToken,
                                          @PathParam("userId")
                                          Long userId)

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

pubkeyAppUsernameUsernameAuthenticatePost

@POST
@Path("/pubkey/app/username/{username}/authenticate")
@Produces("application/json")
Token pubkeyAppUsernameUsernameAuthenticatePost(@HeaderParam("sessionToken")
                                                String sessionToken,
                                                @PathParam("username")
                                                String username)

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

pubkeyAuthenticatePost

@POST
@Path("/pubkey/authenticate")
@Consumes("application/json")
@Produces("application/json")
Token pubkeyAuthenticatePost(AuthenticateRequest body)

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.).

v1PubkeyAppAuthenticateExtensionAppPost

@POST
@Path("/v1/pubkey/app/authenticate/extensionApp")
@Consumes("application/json")
@Produces("application/json")
ExtensionAppTokens v1PubkeyAppAuthenticateExtensionAppPost(AuthenticateExtensionAppRequest body)

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.).