How-To Create a Custom Application API Integration in Idira Identity

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Announcements

Welcome Idira to LIVEcommunity!

Our community just got stronger! Explore new identity security resources, connect with experts, and discover more ways to learn and collaborate.

Meet Idira

Idira Success Blogs
3 min read
L4 Transporter

Introduction 

This article provides step-by-step instructions for configuring Idira Identity to securely obtain and manage access tokens for a downstream application’s APIs. By setting up this integration, you enable Idira Identity to authenticate, authorize, and broker access on behalf of users or services, ensuring consistent security controls and streamlined API access across your environment.  

Part 1: Create a service user 

The service user acts on behalf of the external IdP when information is sent to Idira Identity. 

  1. Go to Core Services > Users, then click Add. 

  1. Complete the Login name, Display name, and Password fields, and record these credentials for later integration use. 

  1. Under Status, select Is OAuth confidential client. This automatically selects Password never expires and Is service user. 

  1. Click Create User. 

 

Part 2: Creating an OAuth2 Server Application in Idira Identity 

  1. In the Identity Administration portal, select Apps & Widgets > Web Apps, then click Add Web Apps. The Add Web Apps screen displays. 

  1. Go to the Custom tab. 

  1. On the Custom tab, next to OAuth2 Server, click Add. 

  1. In the Add Web App screen, click Yes to add the application and click Close. 

  1. The application that you just added opens to the Settings page. 

  1. Enter a name in the Application ID text box. Be sure that you use all lowercase letters and no spaces. 

  1. Navigate to General Usage, Tokens, Scope, and Advanced to adjust the settings as necessary. 

  1. Go to Permissions and click Add to assign the service user you created in Part1.  

  1. Click Save. 

 

Part 3: Integrating with the Application’s APIs 

  1. Configure your Application. 

  1. In your application, configure the OAuth2 client with the generated Client ID and Client Secret. This will be the credentials of the service account created in Part 1. 

  1. Set the token endpoint, authorization endpoint, and scopes according to your Idira Identity OAuth2 app settings. 

  1. Test Authentication 

  1. Initiate an OAuth2 flow (e.g., Client Credentials) to obtain an access token. 

  1. Use the access token to make authenticated API requests. 

  1. Validate Access 

  1. Ensure the service user has the correct permissions and that the integration works as expected. 

 

Troubleshooting Tips 

  • Double-check user permissions and assigned roles if access fails. 

  • Verify client ID, client secret, and endpoint URLs match those configured in Idira Identity. 

  • Review Idira Identity logs for authentication or authorization errors. 

 

Conclusion 

Following these steps will help you securely create a service user and OAuth2 Server app in Idira Identity, enabling seamless and secure integration with your application’s APIs. 

 

Additional Resources 

  • 931 Views
  • 0 comments
  • 0 Likes
Top Liked Authors