cancel
Showing results for 
Search instead for 
Did you mean: 

Query REST API for users by email address?

Andy_Barker
Star Contributor
Star Contributor

Greetings all! I recently added some integrations with the Administration REST API to our internal process that manages onboarding and offboarding of users in our organization.  In working with the Admin API for User administration, I noticed that there's not a straightforward way to query for user accounts by anything other than User ID. Back in 2021, Tyler (responding to Ryan Wakefield) mentioned that the team was working on a feature called "Expand Parameters" that would at least allow us to return more additional information from the GET /users method: https://community.hyland.com/forum/threads/81326-multiple-questions-on-new-ep5-users-administration

 

I was wondering if there had been any more progress on this feature or plans to include it on the 25.1 roadmap. My use case is that while all of our users have an account named by their email address for SSO, some users will also have a secondary account that uses standard auth for things that don't support SSO (like OnBase Minutes). Ideally, I want to update my offboarding script to be able to find these other standard auth accounts by their email address, but it would currently be a lot of data and requests going back and forth. Being able to return email address as one of the fields from the GET /users call would make this much more doable. Bonus points if we could add other criteria to the GET /users call than just isServiceAccount (ie isStandardAuth, isLocked, etc). If this is something I should write up as a feedback request, let me know.

1 ACCEPTED ANSWER

AdamShaneHyland
Employee
Employee

Hi @Andy Barker ,

 

At this time the feature you are inquiring about is not available.  This would be a further enhancement to the product.  I would recommend submitting a Feedback for the additional functionality.

 

The only thing that I could think of (which is not ideal, but would work), is to maintain your own list of users and email addresses (or other user properties).  You could do this by ...

 

Query for all users - /api/users

https://sdk.onbase.com/rest/docs.html?product=OnBase&release=Foundation23.1&spec=onbase-administrati...

 

Iterate through each user ID for their respective properties - /api/users/{userId}

https://sdk.onbase.com/rest/docs.html?product=OnBase&release=Foundation23.1&spec=onbase-administrati...

 

Best wishes.

View answer in original post

1 REPLY 1

AdamShaneHyland
Employee
Employee

Hi @Andy Barker ,

 

At this time the feature you are inquiring about is not available.  This would be a further enhancement to the product.  I would recommend submitting a Feedback for the additional functionality.

 

The only thing that I could think of (which is not ideal, but would work), is to maintain your own list of users and email addresses (or other user properties).  You could do this by ...

 

Query for all users - /api/users

https://sdk.onbase.com/rest/docs.html?product=OnBase&release=Foundation23.1&spec=onbase-administrati...

 

Iterate through each user ID for their respective properties - /api/users/{userId}

https://sdk.onbase.com/rest/docs.html?product=OnBase&release=Foundation23.1&spec=onbase-administrati...

 

Best wishes.