Versions Compared

Old Version 14

changes.mady.by.user Amber Cowles

Saved on

compared with

New Version Current

changes.mady.by.user Bianca Rosa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Health Check: The link has been rewritten to its master page by check 'P16'.

Table of Contents
outlinetrue
stylenone

...

'API Keys' are a list of available permissions that will allow access to the data within the PCR-360 database via the API. Users can access and view the various API permissions that are being used within an organization from the Admin > API > API Keys navigation option.

API Permissions GridImage RemovedAPI Key Grid Header exampleImage Added

Whenever adding or editing an API permission, the API key will be randomly generated and disabled from User modifications. Users can select the Read and Write access in various sections like 'Services', 'Equipment', 'Service Desk', and 'SNMP'. This Grid allows the User to  AddImage Modified,  Edit SelectedImage Modified, or Delete SelectedImage Modified API Key Permissions.

Permissions Tab

API Keys Permissions Tab ExampleImage Modified

A User input description is recommended whenever adding a new API Permission. This will create clarity when examining multiple API Permissions sets.

...

Select the desired 'API Permission' and set any desired Expiration Date.  Depending on API Endpoint, you will see fields for granting Read and Write permissions.

Edit

Users can Edit SelectedImage Modified an existing API Permission if there are problems with the initial configuration.

Delete

Users canDelete SelectedImage Modified an existing API Permission. Care should be exercised in this action to make sure that the Permission is not being used elsewhere by PCR-360.


Users Tab

Manage API Keys Form ExampleImage Modified

From 'API Users' Grid the User is able to AddImage Modified, Edit SelectedImage Modified, or Delete SelectedImage Modified API Keys associated to a User's Session. 

...

User Access Validation for the API

Anonymous Mode

This mode of accessing the API has been depreciatedHTTP POST is required for the login endpoint.

A basic request looks like this:

...

The system configuration AUTH_SESSION_LIFETIME_SECONDS defines the length of time a Session is valid.  If this parameter is set to "0", then the Session is set to not expire as long as the User.  Any other value to cause the User to need to get a new Token after the defined interval, regardless of User Activity.

The system configuration AUTH_SESSION_ACTIVITY_SECONDS defined the length of time a User's Session is valid, before it times out do to Inactivity.

For more detail on these configuration values, please see the Authentication Configuration Wiki Page.

All expired tokens for the user and API key will be deleted.

...