| page_type | products | languages | extensions | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
|
|
|
Services can send actionable messages to users to complete simple tasks against their services. When a user performs one of the actions in a message, an action request will be sent by Microsoft to the service. The request from Microsoft will contain a bearer token in the authorization header. This code sample shows how to verify the token to ensure the action request is from Microsoft, and use the claims in the token to validate the request.
@RequestMapping(value="/api/expense", method=RequestMethod.POST)
public ResponseEntity<?> post(
@RequestHeader(value="Authorization") String auth) {
// This will validate that the token has been issued by Microsoft for the
// specified target URL i.e. the target matches the intended audience (“aud” claim in token)
//
// In your code, replace https://api.contoso.com with your service’s base URL.
// For example, if the service target URL is https://api.xyz.com/finance/expense?id=1234,
// then replace https://api.contoso.com with https://api.xyz.com
ActionableMessageTokenValidationResult result = validateToken(auth, "https://api.contoso.com");
if (!result.getValidationSucceeded()) {
if (result.getError() != null) {
System.err.println(result.getError().toString());
}
return new ResponseEntity<>(null, HttpStatus.UNAUTHORIZED);
}
// We have a valid token. We will now verify that the sender and action performer are who
// we expect. The sender is the identity of the entity that initially sent the Actionable
// Message, and the action performer is the identity of the user who actually
// took the action (“sub” claim in token).
//
// You should replace the code below with your own validation logic
// In this example, we verify that the email is sent by expense@contoso.com (expected sender)
// and the email of the person who performed the action is john@contoso.com (expected recipient)
//
// You should also return the CARD-ACTION-STATUS header in the response.
// The value of the header will be displayed to the user.
if (!result.getSender().equalsIgnoreCase("expense@contoso.com") ||
!result.getActionPerformer().equalsIgnoreCase("john@contoso.com")) {
HttpHeaders headers = new HttpHeaders();
headers.add("CARD-ACTION-STATUS", "Invalid sender or the action performer is not allowed.");
return new ResponseEntity<>(null, headers, HttpStatus.FORBIDDEN);
}
// Further business logic code here to process the expense report.
HttpHeaders headers = new HttpHeaders();
headers.add("CARD-ACTION-STATUS", "The expense was approved.");
return new ResponseEntity<>(null, headers, HttpStatus.OK);
}
private ActionableMessageTokenValidationResult validateToken(String authHeader, String targetUrl) {
ActionableMessageTokenValidationResult result = new ActionableMessageTokenValidationResult();
try {
String[] tokens = authHeader.split(" ");
if (tokens.length != 2) {
result.setError(new IllegalStateException("Invalid token."));
return result;
}
ActionableMessageTokenValidator validator = new ActionableMessageTokenValidator();
// ValidateToken will verify the following
// 1. The token is issued by Microsoft and its digital signature is valid.
// 2. The token has not expired.
// 3. The audience claim matches the service domain URL.
result = validator.validateToken(tokens[1], targetUrl);
}
catch (Exception ex) {
result.setError(ex);
}
return result;
}
The code sample is using the following library for JWT validation.
OAuth 2.0 SDK With OpenID Connect Extensions 5.17.1
More information Outlook Actionable Messages is available here.
Copyright (c) 2017 Microsoft. All rights reserved.
This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.