API accounts | EPM-WM

When using the EPM Management API, you must set up an account that is used to authenticate access to the API.

Not all API users will require full access to the API. Permissions can be assigned at a granular level and to only those API endpoints the user requires access to.

API endpoints

API endpoints and their methods

• Audit
  • /AuthorizationRequestAudits
  • /ActivityAudits
• Insight
  • /AppSwitcher

    ℹ️

    Assigning Full Access to the Insight endpoint results in Read access to Management and Audit endpoints.

• Management
  • /Computers
  • /File
  • /Groups
  • /Policies
  • /Roles
  • /Users
  • /AcceptedDomains
  • /Tasks
  • /GlobalRoles
  • /About
  • /AuthenticationProvider
  • /ApiAccounts
• Reporting
  • /Events
• SCIM
  • /scim
• JIT (formerly URM)
  • /AdminAccessRequest
  • /AuthorizationRequest

Create the account

To create the account:

1. Click the Configuration menu, and then click API Settings.

2. Click Create an API Account.

3. Enter a name and description.

   The Client ID and Client Secret are automatically generated. The secret is only visible when initially generated for security reasons.

   You can use the copy icons to copy the values to the API tool you are using. You can access these after the account is created as well.

4. Set the permissions for the account.

   • No Access: No permissions are granted to that endpoint.
   • Read Only: HTTP GET permissions are granted.
   • Full Access: All HTTP permissions are granted.

5. Click Save API Account.

Edit an API account

On the edit page for an API account, you can:

• Change the account name and description
• Copy the client ID
• Generate a client secret
• Change API access

To edit an account:

1. Click the Configuration menu, and then click API Settings.
2. Select Edit API Account from the menu.
3. Change the properties, and click Save API Account.

Delete an API account

1. Click the Configuration menu, and then click API Settings.
2. Click the trash can icon to delete the account.
3. Click Delete Anyway on the confirmation dialog box.

Generate a client secret

1. Click the Configuration menu, and then click API Settings.
2. Click the Generate new Client secret icon for the API account you use to access the API.
3. Click Generate Secret.
4. The client secret is displayed in the Client Secret column. Copy the secret to the authorization page of the API.

View API account details

View the API account details to see a snapshot of the account properties. The details include:

• Name and description
• Client ID
• Client Secret
• Access permissions