How To
Summary
How to use OAuth2 authentication on outbound integration
Objective
OAuth client configuration can be created using User Interface or OSLC API.
1) a) Using User Interface
Go to End Points application and click on Add/Modify OAuth Clients.
Click on New Row.

1) b) Using OSLC API
Prerequirements:
Ensure MAXADMIN group has the correct privileges:
- Open Maximo with the maxadmin user.
- Go to the Security Groups application, open the MAXADMIN group, then click the Object Structures tab. Filter to show the MXAPIOAUTHCLIENT and ensure all access is granted as shown in this screen capture:

- If you have to add access, do so, then log out and back in so that the privileges take effect.
Post the OAuth2 Client Provider settings into Maximo.
- Set the method to "POST"
- Paste the appropriate URL (replace the first part with the correct hostname):
http://MAXIMOHOST/maximo/oslc/os/mxapioauthclient?lean=1&ctx=ccrypto=1&_lid=maxadmin&_lpwd=maxadmin
- Paste the appropriate settings in the body:
{ "clientname":"oauth2", "clientid":"spiffe://server.dev/data", "clientsecret":"put client secret here", "scope":"spiffe://server.dev/oauth-data/.default", "tokenurl":"https://identity.service.server.dev/oauth2/v1/token" }
Notes about the values:
Client name: It can be anything, but will be referenced later in the configuration.
Client ID, client secret, scope, and token URL: Provided by the OAuth server administrator -
Send to Post the settings to Maximo. If the post is successful, you receive a “201 Created”.
2) OAuth 2 End Point to Maximo
- Log in to Maximo as the Maxadmin user. Go to Integration >> End Points.
Click “New End Point” and give it a name and description.- Enter the following values:
a. Handler: HTTP
b. Consumed By: INTEGRATION
c. OAUTHCLIENT: Use the “clientname” value you entered before. This example is oauth2.
d. URL: enter the URL of the external system to which you send data.
- Enter the following values:

- Save and Test the endpoint. To test, you can either enter valid data that would be expected by the integration, or you can choose to attach a file that would be used by the integration
Environment
OAUTH2 is available after Tivoli's process automation engine 7613 only.
Document Location
Worldwide
[{"Type":"MASTER","Line of Business":{"code":"LOB59","label":"Sustainability Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSLKT6","label":"IBM Maximo Asset Management"},"ARM Category":[{"code":"a8m50000000CbFGAA0","label":"Integration"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"7.6.1"}]
Was this topic helpful?
Document Information
More support for:
IBM Maximo Asset Management
Component:
Integration
Software version:
7.6.1
Document number:
6831321
Modified date:
21 November 2023
UID
ibm16831321
Manage My Notification Subscriptions