API Users are able to be assigned access tokens which allow you to authenticate with the API. TrackVia uses access tokens to verify a user’s identity and permission level when accessing the API. Tokens ensure account security by limiting API access and enforcing permissions. A TrackVia
Super Admin has the ability to create up to 100 unique access tokens, each with its own expiration date and set of permissions. Actions that use the access token will be performed by and that user will be displayed in the appropriate
Updated fields of TrackVia.
API Users are a special kind of user and are used only for API connections and integrations. Designating a user as an
API user means that user will:
- Restrict Web and Mobile access.
API Usersare unable to use either the TrackVia web or mobile applications.
- Bypass Single Sign On (SSO).
API Usersbypass SSO login in order to prevent their access tokens from inadvertently expiring due to SSO policies.
- Ignore password expiration policies.
API Usersare exempt from TrackVia password expiration policies.
- Be eligible for access token creation. Only API Users may be used to create access tokens.
- Have permissions managed like any other user.
API Userswill still need to be put in a properly configured role in order to have read, write, or delete permissions in an account.
To designate a user as an
API User, navigate to
Manage Users and select the user you want to assign to a token. Check the
Set As API User box on that user. Users in
Unverified status may not be designated as
API Key is unique to your TrackVia account and is a required component for accessing the TrackVia API. Once generated, it cannot be changed or deleted. It can be copied for use in an integration using the clipboard icon. This
API Key should be used as the value of the
query string parameter in the of API requests. To create an
API Key navigate to
API Access from inside of your
After creating at least one
Super Admins will be able to create auth tokens by clicking
Create Auth Token. A window will open for the
Super Admin to set the token’s name,
API User, and expiration date. Once created, these values cannot be changed. Only active users, designated as an
API User, will be shown in this window. The expiration date can be any date in the future and will expire at
midnight UTC on the date selected. Once created, auth tokens can be copied using the clipboard icon and used in
Microservices. They can be turned off by clicking the gear icon and selecting