Management - API Keys

API Keys, or Application Programming Interface Keys, can be utilized when developing custom software integrations with GDS. An API Key authorizes access to your organization’s data in the same way a User’s account grants them access. If your organization is looking to develop tools that utilize GDS data, an API Key should be used instead of incorporating a user’s credentials in application code.

When provisioning a new API Key, you must define the following:

• Name: This should be a name that can easily identify what the API Key is used for. An example is Credentialing Report Application if the API Key is used to authorize access for a reporting application.

• Role: This defines the level of access the API Key has. Similar to a User’s account, an API Key can be limited to what types of data it can access.

• Expiry Date: This is the date that the API Key will expire on. Please consult with your organization’s Information Security team to ensure API Keys are being maintained accordingly.

Only Manager-level users have the ability to provision and manage API keys for an account.