This is the sixth in a series of posts on the new features of Apache CXF Fediz 1.2.0. The previous post looked
at Single Sign Out support in Fediz. In this article we will briefly cover the new REST API of the Fediz IdP. Prior to the 1.2.0 release all of the IdP configuration was done in a static way using Spring. If the IdP administrator wished to change the claims for a particular application, then the change would necessitate restarting the IdP. In contrast, the Fediz 1.2.0 IdP persists the configuration to a database using JPA. In addition, it allows access to this configuration via a REST API powered by Apache CXF.
To get started, please follow step 1 of the first tutorial
to deploy the Fediz IdP to Apache Tomcat. The REST API is described by a WADL document available at the following URL:
The WADL document describes the following resource URIs:
- services/rs/idps - An IdP for a given realm.
- services/rs/claims - The claims that are available in the IdP.
- services/rs/applications - The applications that are defined in the IdP.
- services/rs/trusted-idps - The trusted IdPs that are defined in the IdP.
- services/rs/roles - The roles associated with the REST API.
By using the standard HTTP verbs in the usual way you can retrieve, store, modify and remove items from the IdP configuration. For example, to see (GET) the configuration associated with the IdP for "realm A" navigate to the following URL in a browser:
The user credentials are defined in "webapps/fediz-idp/WEB-INF/classes/users.properties". You can use "admin/password" by default to access the API. Here you can see the protocols supported, the token types offered, the different ways of authenticating to the IdP, the claim types offered, the applications supported, etc. Note that by default the information returned in a GET request is in XML format. You can return it in JSON format just by appending ".json" to the URL:
For much more information on how to use the new REST API, please see Oliver Wulff's blog
on this topic.
Post a Comment