com.atlassian.asap.api.server.http

Interface RequestAuthenticator

public interface RequestAuthenticator

HTTP servers can use this service to authenticate incoming HTTP requests that include a JWT bearer token in the Authorization header, conforming to the specification of ASAP protocol.

See Also:

ASAP Authentication

Method Summary

Modifier and Type	Method and Description
Jwt	authenticateRequest(String authorizationHeader) Authenticates a request by validating the given authorizationHeader according to the conventions.

Method Detail

authenticateRequest

Jwt authenticateRequest(String authorizationHeader)
                 throws AuthenticationFailedException

Authenticates a request by validating the given authorizationHeader according to the conventions. defined in ASAP Specification

Parameters:

authorizationHeader - the value of the 'Authorization' header of the request to validate. This 'Authorization' header should contain a JWT with the necessary authentication information

Returns:

a valid JWT object corresponding to the claims body of the validated token

Throws:

AuthenticationFailedException - if there is a problem validating the token in the header