API Restrictions for User Group (Employee)

Use this screen to define the API restrictions for a selected User Group. API restrictions can be used to exclude access to a set of APIs. Alternatively, API restrictions can be used to allow access to a subset of APIs. Defined API restrictions apply to all users associated with the User Group

The User Group section shows details for the selected user group.

The Restrict checkbox determines whether to restrict or allow APIs based on the definitions.

If you select the Restrict checkbox, all the defined APIs are restricted and the remaining APIs are allowed for the users in the user group.
If you do not select the Restrict checkbox, all the defined APIs are allowed and the remaining APIs are restricted for the users in the user group.

API Restrictions

API: specifies the API to which the restriction applies.
Source: specifies the source of the API call to which the restriction applies. Possible sources include both external systems which are integrated with Transportation Manager, and internal systems which generate API calls.
Note: Not all API calls specify a source. When a source is not specified and cannot be determined based on context, ‘Default’ restrictions will apply. Additionally, if an API call does specify a source, but no restriction is defined for the source, a restriction with source specified as ‘Default’ will apply.
Entity: A specific entity type may be specified for Entity Services APIs. This further refines the context to which the restriction applies.

Note: If no values are defined in the API Restrictions, then the Restrict value applies generally. All APIs for all Sources and Entity Types are either allowed or restricted, based upon the value.