...
Open
<APIM_HOME>/repository/conf/api-manager.xmlfile and enable JWT as follows.Code Block language html/xml <EnableTokenGeneration>true</EnableTokenGeneration>
Note If you publish APIs before JWT is enabled, you have to republish them to include JWT.
Configure the rest of the elements in the same XML file as described in the table below. If you do not specify values to the elements, the default values will be applied.
Element Description Default Value <SecurityContextHeader/> The name of the HTTP header to which the JWT is attached. X-JWT-Assertion <ClaimsRetrieverImplClass/> By default, the following are encoded to the JWT:
- subscriber name
- application name
- API context
- API version
- authorised resource owner name
In addition, you can also write your own class by extending the interface
org.wso2.carbon.apimgt.impl.token.ClaimsRetriever. The methods in this interface are described below:Method Description void init() throws APIManagementException;
Used to perform initialisation tasks. Is executed once, right before the very first request. SortedMap<String,String> getClaims(String endUserName) throws APIManagementException;
Returns a sorted map of claims. The key of the map indicates the user attribute name and the value indicates the corresponding user attribute value. The order in which these keys and values are encoded depends on the ordering defined by the sorted map. String getDialectURI(String endUserName);
The dialect URI to which the attribute names returned by the
getClaims()method are appended to. For example,
if thegetClaimsmethod returns{email:user1@wso2.com, gender:male}and thegetDialectURI()returnshttp://wso2.org/claims, the JWT will contain“http://wso2.org/claims/gender”:“user1@wso2.com”,“http://wso2.org/claims/email”:“male”as part of the body.The default implementation (
org.wso2.carbon.apimgt.impl.token.DefaultClaimsRetriever) returns the user's attributes defined under the dialect URIhttp://wso2.org/claimsand the JWT will also be encoded with the same dialect URI. The order of encoding the user's attributes is the natural order of the attributes. If no value is specified, no additional claims will be encoded, except the 6 default attributes.org.wso2.carbon.apimgt.impl.token.DefaultClaimsRetriever <ConsumerDialectURI/> The dialect URI under which the user's claims are be looked for. Only works with the default value of
<ClaimsRetrieverImplClass>element defined above.JWT token contains all claims define in the
<ConsumerDialectURI>element. The default value of this element ishttp://wso2.org/claims. To get a list of users to be included in the JWT, simply uncomment this element after enabling JWT. It will include all claims inhttp://wso2.org/claimsto the JWT token.Excerpt hidden true Taken from the shared space: http://docs.wso2.org/display/FAQ/APIM+Common#APIMCommon-HowtogetarolelistofuserstobeincludedintheJWT
http://wso2.org/claims <SignatureAlgorithm/> The signing algorithm used to sign the JWT. The general format of the JWT is
{token infor}.{claims list}.{signature}. When NONE is specified as the algorithm, signing is turned off and the JWT looks as{token infor}.{claims list}, with two strings delimited by a period and a period at the end.This element can have only two values - the default value (SHA256WITHRSA) or NONE.
SHA256WITHRSA