Service Principals

Administrators can create and manage tokens for applications and services, eliminating the need for User role members within your Organization to handle API keys. This detaches authentication from an individual User, improving security and simplifying API access management. Service principals can enable the usage of Wherobots APIs including the Spatial SQL API, CI/CD pipelines, and automated workflows like Apache Airflow ETLs.

​

Before you start

In order to use service principals, ensure that you have the following:

• A Wherobots account.
• An Admin role within your Organization.
  • To confirm that you’re an Administrator, review your role in Organization Settings > Users.
  • Those with a User role can’t manage service principals or their associated API keys.
    • While Organization Administrators can give those in the User role access to the API keys associated with a service principal, those in a User role cannot create, modify, or delete service principals or their related API keys.

​

Use service principals as an Administrator

Administrators have the ability to create, modify, or delete service principals.

​

Create a service principal

To create a service principal, do the following: When you successfully create a service principal, you will be redirected to your service principal’s detail page.

​

Manage a service principal

As an Administrator, you can:

• Rename a service principal
• Assign API keys to a service principal
• Delete a service principal

​

Find your service principal

To modify your service principal first find your service principal by doing the following:

​

Rename service principal

To change the name of your service principal, do the following:

​

Add an API key to a service principal

After clicking Submit, Wherobots generates an API key.

​

Delete a service principal

As an Administrator, you can delete a service principal. Deleting a service principal also revokes the API keys associated with that service principal. To delete a service principal, do the following:

​

API keys for members with the User role

Any member of your Organization, including members with the User role, can manage their own API keys in Settings > API Keys. There, you can create your own keys, list them, change their expiration dates, and revoke them. For steps, see API Keys. Only Admins can:

• View or revoke other members’ API keys.
• Create API keys for service principals.
• Create, rename, or delete service principals.

If you need an API key that belongs to a service principal, ask an Admin in your Organization to share it with you. To find the Admins in your Organization, do the following:

​

Switching to service principal-managed API keys

Existing API keys that are not already associated with a service principal cannot be migrated to one. Instead, you’ll need to create new API keys under a service principal. If you want to use service principal-managed API keys instead of unattached API keys, do the following: