Hi
We have two applications integrated with Simpro using the Resource Owner Flow and the Authorization Code Grant Flow. We need some clarification regarding the required security roles for API access.
For the Resource Owner Flow, our customers set up an API account for us to use. They often ask what security role this API account needs to have, but we haven’t been able to find any documentation specifying the required security roles for the API endpoints we are using. Could you please direct us to the relevant section?
For the Authorization Code Grant Flow, once we receive the client ID and secret from our customer, their staff members will log in using their own accounts. Could you clarify whether API security permissions follow the person who set up the client ID and secret or the person logging in to obtain the token? Additionally, we need to inform our customers about the security roles required for both the person setting up the client ID and secret and the person logging in.
Could you provide us with information on how API endpoints map to security roles in Simpro? Any documentation or guidance would be greatly appreciated.
Looking forward to your response.
Clarification on API Security Roles in Simpro
Forum rules
- Check the documentation first. Before posting questions, please check the documentation to ensure it doesn't already cover what you need.
- No spam. All automated messages, advertisements, and links to competitor websites will be deleted immediately.
- Post in relevant sub-forums only. Messages posted in the wrong topic area will be removed and placed in the correct sub-forum by moderators.
- Respect other users. No flaming or abusing fellow forum members. Users who continue to post inflammatory, abusive comments will be deleted from the forum after two warnings are issued by moderators.
- Harassment. No threats or harassment of other users will be tolerated. Any instance of threatening or harassing behavior is grounds for deletion from the forums.
- Adult content. No profanity or pornography is allowed. Posts containing adult material will be deleted.
- Bandwidth. All images and signatures must be 500 x 500 pixels or smaller. Posts containing over-sized images and signatures will be removed.
- Illegal content. No re-posting of copyrighted materials or other illegal content is allowed. Any posts containing illegal content or copyrighted materials will be deleted.
-
SimproAPITeam
- Posts: 831
- Joined: Wed May 01, 2024 2:31 am
Re: Clarification on API Security Roles in Simpro
Hi Alantod17,
The API applications set up has full admin access to Simpro. There is currently no way of restricting access to parts of Simpro for someone who has access through the API.
The security roles configured apply to Simpro Premium.
Regards
The API applications set up has full admin access to Simpro. There is currently no way of restricting access to parts of Simpro for someone who has access through the API.
The security roles configured apply to Simpro Premium.
Regards
Simpro API Team | Simpro Software Group
Re: Clarification on API Security Roles in Simpro
Hi, thanks for the information.SimproAPITeam wrote: ↑Thu Feb 27, 2025 9:59 pm Hi Alantod17,
The API applications set up has full admin access to Simpro. There is currently no way of restricting access to parts of Simpro for someone who has access through the API.
The security roles configured apply to Simpro Premium.
Regards
Can I please confirm if I’m understanding this correctly:
If UserAdmin (who has full access) sets up the API key for the management team, and User1 (who only has a security role with permission to view quotes) connects using the API flow.
Are you saying that User1 would then gain access to all other parts of the system use API?
If that’s correct, does this behavior apply to all OAuth methods?
-
SimproAPITeam
- Posts: 831
- Joined: Wed May 01, 2024 2:31 am
Re: Clarification on API Security Roles in Simpro
Hi,
That's correct.
All API application users have full access through the API. This applies to all authorization methods.
Regards
That's correct.
All API application users have full access through the API. This applies to all authorization methods.
Regards
Simpro API Team | Simpro Software Group
DEVELOPER CENTER