Service access keys (tenant-level)

Nearly all SBS services require authorization at tenant level, through a service access key (SAK). You can create and manage such service access keys either from the graphical user interface of the SBS Console (Web UI), or programmatically from GraphQL.

To generate a service access key, the following prerequisites must be in place:

• the application for which you are generating the key must exist in your SBS account. See also Create an application.
• the tenant for which you are generating the key must exist in your SBS account. See also Create a tenant.

For an introduction to the SBS account, application, and tenant concepts, refer to the Getting Started tutorial.

Generate a service access key

To generate a service access key:

1. Sign in to the SBS Console.

2. In the left-hand side navigation menu, click Tenants.

3. Click the tenant for which you would like to generate the key.

4. Click the Add button in the top-right corner of the service access keys table. A dialog box appears.

5. Under Applications, select the application for which you are generating the key.

6. Optionally, enter a key description.

7. Optionally, assign a role to the key. The roles available for selection are the ones that were previously created from the Roles page.

8. Optionally, under Scope, enter the extent of permissions available to the bearer of this key. For details, see Scope editor.

   

9. Click Generate Service Access Key. The key is generated and the dialog box remains open.

10. Click Show Secret Key and copy the private key value. You can now use this value in the x-api-key header when accessing a relevant SBS service.

    

Update a service access key

To update the description, role, and scope of a service access key:

1. Sign in to the SBS Console.
2. In the left-hand side navigation menu, click Tenants.
3. Click a tenant to see the available service access keys in the right pane.
4. Click the Edit button next to the key that you want to update. A dialog box appears.
5. Change the role, scope or description of the key as required.

6. Click Save.

Delete a service access key

To delete a service access key:

1. Sign in to the SBS Console.
2. In the left-hand side navigation menu, click Tenants.
3. Click a tenant to see the available service access keys in the right pane.
4. Click Delete next to the key you want to delete.

GraphQL

You can also generate, update and delete service access keys programmatically from GraphQL. For details, see the Account API Reference, and, in particular, the following mutations:

• generateServiceAccessKey
• updateServiceAccessKey
• deleteServiceAccessKey