Skip to main content

Consume WSO2 admin services via Javascript [Server-side]

Each WSO2 product [eg: WSO2 ESB,GReg] provides specific and different functionalities which can be consume via product UI-admin console. But there are cases,where users want to use those functionalities,not from UI, but from their custom client implementations.That's where the importance of Carbon Admin Services come into the picture. 

WSO2  Admin Services can be considered as SOAP web service endpoints which provide wso2 product specific functionalities.The admin services are not visible via the Carbon management console. 
You can access the service description of the admin services[WSDL] if you know the admin service. 
Before accessing the wsdl of a particular admin service,you need to enable the property <HideAdminServiceWSDLs> of carbon.xml as 'false'.
You can find the admin services expose by a WSO2 product,by following below two steps.
  1. Run the server in OSGI mode ./wso2server.sh -DosgiConsole
  2. Once the server starts,type the command 'listAdminServices'

Once you change above carbon.xml property and found the required admin service name,then try accessing below URL assuming that the  https port of running server is 9443.

https://localhost:9443/services/AuthenticationAdmin?wsdl

There are different ways of consuming above admin service.
  1. Via a SOAP web service client tool like Soap-UI as described in here
  2. Via a java client program as described in here
  3. Via a javascript program with Jaggery [New]
From this blog-post,I'll explain how to invoke an admin service from Jaggery.There are two inbuilt mechanisms to achieve my objective from jaggery by using WSRequest or WSStub options.
Below example code shows how to consume an admin service from jaggery,by using WSRequest module.You can download the sample code from here.You can try directly paste the jaggery-code to online try-it tool provided by jaggery web site to try with.[NOTE:Please make sure,your WSO2 product is running while trying from jaggery online try-it]

In this example ;

Admin Service Name- RemoteUserStoreManagerService
Invoked operation -isExistingUser();
Operation Payload- username [The related SOAP payload can be generated with the help of a SOAP client as Soap UI] 






Comments

  1. hi, excuse my english. I am trying make something similar to this post. I was using SOAPUI and not have any problem. I want create a new Tenant in the Identity Server using the service https://127.0.0.1:9443/services/TenantMgtAdminService?wsdl specifically the addTenant function. In SOAPUI need basic authentication. I appreciate your help on this topic.

    ReplyDelete

Post a Comment

Popular posts from this blog

Convert an InputStream to XML

For that we can use DocumentBuilder class in java. By using the method parse(InputStream) ; A new DOM Document object will return. InputStream input; DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); DocumentBuilder parser = factory.newDocumentBuilder(); Document dc= parser.parse(input); In the above code segment,by using the created Document object,the corresponding XML file for the inputStream can be accessed. References: http://www.w3schools.com/dom/dom_intro.asp http:// download.oracle.com/javase/1.4.2/docs/api/javax/xml/parsers/DocumentBuilder.html

CORS support from WSO2 API Manager 2.0.0

Cross-origin resource sharing (CORS) is a mechanism that allows restricted resources  on a web page to be requested from another domain outside the domain from which the first restricted resource was served. For example, an HTML page of a web application served from http://domain-a.com makes an <img src >  request for a different domain as 'domain-b.com' to get an image via an API request.  For security reasons, browsers restrict cross-origin HTTP requests initiated from within scripts as in above example and only allows to make HTTP requests to its own domain. To avoid this limitation modern browsers have been used CORS standard to allow cross domain requests. Modern browsers use CORS in an API container - such as  XMLHttpRequest  or Fetch - to mitigate risks of cross-origin HTTP requests.Thing to  note is it's not only sufficient that the browsers handle client side of cross-origin sharing,but also the servers from which these resources getting need to handl

Passing end-user details from client to real backend endpoint via JWT token

In real-world business system,WSO2 API Manager useful on exposing company APIs, in a secured and controlled manner with the features provided by APIManager as; OAuth support [To secure API invocations] Throttling support [To control API invocations] Monitoring support [To track API usage] More technically what happening is when a user sends a particular API request,it will goes to WSO2 APIManager node and from there,the request will route to the real implemented back-end endpoint of the particular API and get back the response and returned it to the API invoked user. There can be a use-case,that this back-end endpoint may expect the details of API invoked user as to pass those details to some internal company usage  as; Additional authentication/authorization Track usage data from an internal system. So how to support above requirement from WSO2 AM. There comes the use of JSON Web Token[JWT] implementation done inside WSO2 AM. JWT is a means of representing claims to be