Fortinet Document Library

Version:


Table of Contents

22.2.0
Download PDF
Copy Link

Managing API users

You can delete or temporarily disable an API user. You can also update the user's portal permissions at any time.

The API Users page displays the following information:

Column Description
API User ID The user's API ID. Click the user ID to update the user details.
Description A description of the user.
Updated The date the user profile was updated.
Status The status (Active/Disabled)

Updating API user permissions

To disable an API user:
  1. Go to API Users. The API User pane opens.
  2. Select an API User ID in the list. The API User Information pane opens.
  3. Click Disable. The Permission Changed Confirmation dialog opens.
  4. Click CONFIRM.
To activate an API user:
  1. Go to API Users. The API User pane opens.
  2. Click the user's API User ID. The API User Information page is displayed.
  3. Click Edit.
  4. From the Status dropdown, select active.
  5. Click Update.
To update an API user's portal permissions:
  1. Go to IAM User. The IAM Users page opens.
  2. Select an API User ID in the list. The API User Information pane opens.
  3. Under Effective Portal Permissions, click Add (+) , and select a service from the list.
  4. Click the Edit button.
  5. Configure the service permissions.

    Permission Description
    Allow Portal Access Toggle Yes to grant access to the service.
    AccessType

    The Access Type is defined by the portal. For example, the access types for Asset Management are:

    • Admin

    • Read Only

    • Read/Write

    Whereas the access types for FortiOS SSO are:

    • SuperAdmin

    • Read Only

  6. Click Confirm.
  7. Click Update.

Managing API users

You can delete or temporarily disable an API user. You can also update the user's portal permissions at any time.

The API Users page displays the following information:

Column Description
API User ID The user's API ID. Click the user ID to update the user details.
Description A description of the user.
Updated The date the user profile was updated.
Status The status (Active/Disabled)

Updating API user permissions

To disable an API user:
  1. Go to API Users. The API User pane opens.
  2. Select an API User ID in the list. The API User Information pane opens.
  3. Click Disable. The Permission Changed Confirmation dialog opens.
  4. Click CONFIRM.
To activate an API user:
  1. Go to API Users. The API User pane opens.
  2. Click the user's API User ID. The API User Information page is displayed.
  3. Click Edit.
  4. From the Status dropdown, select active.
  5. Click Update.
To update an API user's portal permissions:
  1. Go to IAM User. The IAM Users page opens.
  2. Select an API User ID in the list. The API User Information pane opens.
  3. Under Effective Portal Permissions, click Add (+) , and select a service from the list.
  4. Click the Edit button.
  5. Configure the service permissions.

    Permission Description
    Allow Portal Access Toggle Yes to grant access to the service.
    AccessType

    The Access Type is defined by the portal. For example, the access types for Asset Management are:

    • Admin

    • Read Only

    • Read/Write

    Whereas the access types for FortiOS SSO are:

    • SuperAdmin

    • Read Only

  6. Click Confirm.
  7. Click Update.