As a Service Provider Admin, you can create and manage API grants for all of your organizations and workspaces at once. This means that you don’t have to spend time managing API grants for multiple organizations and workspaces one at a time.
Create an API grant
To create an API grant for all of your organizations and workspaces:
- Go to the Service Provider Admin portal.
- On the Security tab, click Add API Grant.
- Enter the following information for the API grant:
- For Client Name, enter a name that will help you identify this grant.
- For Scopes, specify the action(s) the system can take on behalf of the user.
Note: See our Understanding API Grant Scopes discussion to learn more about scopes.
- For Expires, set when the grant should expire, based on your organization’s security policies and preferences.
- If necessary, enter a comma-separated list of IP addresses to the IP Allowlist for the grant.
- Click Add Grant.
- You can then view the grant’s secret by clicking Reveal Secret, or you can copy the secret to your clipboard. You will only be able to view the secret once, so make sure to copy down the secret in a secure place. If you lose the secret, you’ll need to regenerate the secret again.
Manage API grants
In the Security tab, you can edit a specific grant’s details or delete the grant by clicking the respective action in the menu dropdown.
View API grant secret
If you lose the grant secret after initially creating the grant, you can regenerate a new secret.
Note: Regenerating a grant secret will invalidate previous secrets.
In the Security tab, click Regenerate in the menu dropdown next to the grant, and then click Proceed. You will only be able to view the new secret once, so make sure to copy down the secret in a secure place. If you lose the new secret, you’ll need to follow these steps to regenerate the secret again.