How to: Manage Service Access

Estimated Reading Time:  3 minutes

Overview

You can manage service access using the Services Administration's Manage Access tab. Managing services access allows Administrators to limit which services a workspace can use. Limiting services to specific workspaces ensures Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. have access to only the APIs APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. they need for their project, preventing unauthorized APIs in an environment that might host multiple teams and workspace projects.

The benefits of limiting access to services include:

  • Relevant Services for Creators: Creators only see services their workspaces have access to instead of all services in the environment.

  • Improved Security: Prevent users from accessing services that they don't have permission to use.

  • Precise Control: Administrators decide what services are available to the environment or individual workspace.

What You'll Learn

In this how-to guide, you'll learn to manage workspace service access when creating or editing a service in Services Administration.

Managing Access When Creating a Service

When Administrators add a new service using the Services Administration page, they must specify if the service is shared to the environment or with one or more workspaces.

To create a new service and limit it to one or more workspaces:

1. At the top right of the Unqork Designer Platform, click the Settings ▾ drop-down.
2. Click Administration.
A static image displaying the Create New Service modal, the Service Title and Service Name fields are highlighted.
3. Under Integration, select Services Administration
4. Click + Add a Service.
5. In the Service Title field, enter a name for the new service. For example, {teamName - Google Places}—replacing {teamName} with your initials or the name of your application team.
6. In the Service Name field, enter the same name in lowercase letters, using hyphens instead of spaces. For example, {teamName}-google-places.

NOTE  Use lowercase alphanumeric characters along with a hyphen (-). A Service Name cannot start or end with a hyphen. Also, there cannot be consecutive hyphens in a Service Name.

7. Click Next. The Manage Access tab displays.
8. From the Share to field, select Workspaces. The Select Workspaces to Share This Service With* field displays.
9. From the Select Workspaces to Whare This Service With* drop-down, select or enter the name of one or more workspaces where you want to share the service.

10. Click Create. The new service's page displays. The service is now ready to be configured, and only Creators in workspaces that have been assigned access can view it.

Managing Access for an Existing Service

Existing services in an environment can be limited to specific environments by changing the service's settings.

WARNING  Services cease to function in workspaces that do not have access to the service.

To limit access to an existing service from the Services Administration page:

1. Navigate to a service and click Manage ▾.
2. Click Open. The service's information page displays.
3. Click Edit Icon Edit. The service page unlocks.
4. From the Service configuration menu, select Manage Access.
5. From the Share to field, select Workspaces. The Select Workspaces to Share This Service With* field displays.
6. From the Select Workspaces to Share This Service With* drop-down, select or enter the name of one or more workspaces where you want to share the service.

7. Click Save Changes. The page refreshes and displays the Services Administration's service list. The service is now only usable by Creators in workspaces that have been assigned access to it.

Best Practices

TIP  To learn more about the different levels of RBAC, view our Introduction to RBAC - Levels of RBAC article.

  • As long as a workspace moduleis shared with your environment, it can use all services limited to other workspaces. Other workspace modules cannot use the service unless that service is assigned to that module's workspace.

Resources