Skip to main content

Maximo API Key - REST/OSLC API Authentication with IdP via SAML

Maximo 7.6.0.9 provides capability to integrate Maximo with Identity Providers (IdP) like Azure AD, Open Connect etc., using SAML. Security Assertion Markup Language (SAML) is an open standard that allows identity providers (IdP) to pass authorization credentials to service providers (SP).

As this integration worked properly on Maximo UI application, Browser less connection for Maximo REST, OSLC APIs was not supported and needed direct local active directory connection. Maximo has added this feature of API Key from Maximo 7.6.0.9 which can be used to overcome the unseen limitation. In the earlier versions of Maximo, creation of API for specific user and management of the key was not user friendly and it needed MAXAUTH to be passed to generate the API Key from REST/OSLC API call. With Maximo 7.6.1.2, API Key feature has been improved and now administrators can generate the API keys for users from Maximo UI and revoke them on the go.

Once users have integrated Maximo with SAML authentication, users can go to the Work Center application and can assign the API keys from the Administration Work Center.

We have mentioned the steps in details below on how API Keys can be created and used for REST/OSLC APIs -

1.To create API key, administrators should go to Administration Work Center > Integration.


2. Click on the API Keys and click on the Add API Keys button-


Search for user for which API Key needs to be generated and click on the Add button.


This will generate API Key for the user and the key will be visible on the work center. In the future if the administrator wants to revoke the access of the user, then the key can be deleted by pressing the Delete button on the same card.


5. Now this API Key can be used with REST/OSLC APIs.

While using the API Key, there is no need to pass MAXAUTH for Non-LDAP (Native Authentication) or User Credentials with BASIC Auth for LDAP enabled Maximo Instance.


6. APIKEY will be passed in Params for API and which will provide the API output after authentication from Maximo.




Hopefully, this post helps to understand the steps required to configure API Key.

In case there are further questions, please feel free to comment or reach out on LinkedIn.




Labels:

Comments

Post a Comment

Popular posts from this blog

Maximo OSLC Integration with External System- Get data in JSON format

Greetings! If you have noticed recent version of Maximo, couple new application in Integration module has been added which are OSLC Resources and OSLC Provider.These modules gives us ability to integrate with external system in JSON. OSLC is an open community that creates specifications for the integration of products and/or tools.  IBM is a leading contributor to this community and many software products within the IBM Software Group are implementing OSLC in order to enable cross-product integrations. An OSLC integration requires 2 players-  1. OSLC Consumer application 2. OSLC Provider application.   An OSLC provider application makes containers of associated resources(data) available for integration through service providers. Consumer applications then use these service providers to query resources and to create, update, and delete resource data.  The consumer application sends a query to the service provider for resource data. The service p...
2 comments
Read more

TD Tool Kit - Importing new language in Multilingual Maximo environment

Greetings! +IBM MAXIMO  gives you ability to use multiple languages like Spanish , Portuguese, Chinese , Korean , French etc other than English , if your Maximo environment is global and have users across the globe. Importing a new language in Maximo can be done by TD Tool kit. TD took kit stands for Translation Data Toolkit.  The Translation Data Toolkit is used to translate the Maximo database and handling Multi Language functionality. The TDToolkit is located under the {Maximo_install}\tools\maximo directory.  The process to import new language is a 3 step activity- 1. Take Maximo down by stopping application servers. 2. Export Labels in XLIFF file format 3. Translate the XLIFF file 4. Check for error and import translated XLIFF files. 5. Validate and start Maximo. Export Labels in XLIFF file format -  In Maximo directory , XLIFF files store all the translations for different tags related with a MBO or database table. In order to expor...
2 comments
Read more

Maximo- An Introduction !!

Greetings ! Very often during conversations , I have seen a strange reaction on face of people when someone say that I am consulting in Maximo and the response which most of the time you'll get from those tech-heads is - "Maximo , What is Maximo...?" so here we are trying to explain and revisit my understanding over this product Maximo. +IBM MAXIMO   is a leading enterprise level asset management product used in various industries like - Manufacturing , Automotive , Oil & Gas , Transportation , Health Care , Retail which gives you immense ability to track down the cost of an asset in plant right starting from installation to its decommissioning. It is a pioneer Asset Life Cycle and Maintenance Management Solution and part of family of software known as "CMMS"- Computerized maintenance management system. In simple term , everything is Maximo revolves around the term - Total Cost of an Asset. In today's competitive world and atmosphere of slowing...
11 comments
Read more