Manage TeamSpaces

In organizations where there is more than one development team using
Layer7 Live API Creator
, TeamSpaces provide a way for system administrator (sa) users to group sets of API developers into teams.
In organizations where there is more than one development team using
Layer7 Live API Creator
, TeamSpaces provide a way for system administrator (
sa
) users to group sets of API developers into teams. Each TeamSpace includes its own workspace of APIs. With TeamSpaces, system administrators can control API developer access to only the APIs their team creates. System administrator users are users with access to all TeamSpaces in
Layer7 Live API Creator
. They manage TeamSpaces and TeamSpace users. TeamSpace users are API developers with access to
Layer7 Live API Creator
and can create APIs in the TeamSpace. API users are consumers of API endpoints in API Creator and are defined for each API.
The following procedures are specific to system administrators. System administrators can edit existing TeamSpaces by changing the TeamSpace name and URL name. System administrators can make these edits from the TeamSpaces page in API Creator or using the
accounts
endpoint. System administrators can delete TeamSpaces that do not contain APIs.
For more information about how to manage TeamSpaces using the
accounts
endpoint, see The accounts Endpoint.
In this article:
2
TeamSpace Architecture
The following diagram illustrates the architecture of TeamSpaces in
Layer7 Live API Creator
:
TeamSpaces architecture Copy
TeamSpaces architecture Copy
Layer7 Live API Creator
includes the system TeamSpace and the
default
TeamSpace. TeamSpace users use this TeamSpace. The
default
TeamSpace includes the
admin
TeamSpace user.
For example, the following URL shows default as the TeamSpace name for the
Demo
API sample:
http://localhost:8080/rest/
default
/demo/v1/demo:customer
The API users within the system TeamSpace include the system administrator and all TeamSpace users. The system administrator that manages
Layer7 Live API Creator
can view only the Layer7 Live API Creator Admin project API (Admin API) within the system TeamSpace. All TeamSpace users (including the system administrator) are defined as API users in the Admin API.
Create a TeamSpace
System administrators can create TeamSpaces. Creating a TeamSpace creates the initial API developer user (a TeamSpace user) for the TeamSpace. This user can add other TeamSpace users.
Follow these steps:
  1. Log in to API Creator as a system administrator (
    sa
    ).
    The APIs page appears.
  2. Click the
    TeamSpaces
    tab.
    The TeamSpaces page appears.
  3. Above the list of TeamSpaces, click
    Add
    .
    The Create new TeamSpace window opens.
  4. Complete the following fields, and then click
    Create
    :
    TeamSpace name
    Defines the name that describes this TeamSpace. You can accept the default value or enter your own.
    Unique:
    Yes
    Required:
    Yes
    TeamSpace URL Fragment
    Defines the URL fragment that identifies this TeamSpace on the URL for all APIs that are created in this TeamSpace. You can accept the default value or enter your own.
    Unique:
    Yes
    Required:
    Yes
    Character limit:
    32. Enter only letters, numbers, and underscores.
    Initial developer name
    Defines the username for the initial API developer user (a TeamSpace user) that
    Layer7 Live API Creator
    creates for the TeamSpace. You can accept the default value or enter your own.
    Unique:
    Yes (within the TeamSpace)
    Required:
    Yes
    Initial developer password
    Defines the password for the initial API developer (a TeamSpace user) that
    Layer7 Live API Creator
    creates for this TeamSpace. We recommend that this TeamSpace user change their password. You can record this password and forward it to this TeamSpace user to edit, or you can edit this password by completing
    one
    of the following steps:
    • Log in to API Creator as this TeamSpace user. Select
      Your TeamSpace
      from the gear icon menu, select this TeamSpace user from the TeamSpace Users list, edit the password, and then save your changes.
    • Open the Admin API. In the Secure section, click
      Users
      , select the
      admin
      API user from the API Users list, edit the password, and then save your changes.
    Limit:
    Six characters minimum
    Required:
    Yes
    The TeamSpace is created, is active (the
    Active
    field is selected), and appears in the TeamSpaces list. The initial API developer user (a TeamSpace user) is created.
  5. Log out from API Creator by selecting
    Logout
    from the gear icon menu at the top right of API Creator.
  6. Communicate the initial developer name and the initial developer password to this TeamSpace user.
Change the TeamSpace User Password
As the initial API developer user (a TeamSpace user), and you are new to using API Creator, change the default password that
Layer7 Live API Creator
assigns to you when the
sa
user created the TeamSpace.
Prerequisite:
The system administrator has created the TeamSpace and has communicated your username and default password to you.
For more information about how to change the initial API developer user (a TeamSpace user) password, see Manage TeamSpace Users.
Transfer APIs to Another TeamSpace
TeamSpace users can transfer APIs from one TeamSpace to another. You transfer APIs using the export/import API process.
Prerequisites:
  • The system administrator has created the TeamSpace to which you are transferring the APIs.
  • You have been added as a TeamSpace user to the TeamSpace from which you are transferring the API.
  • You have been added as a TeamSpace user to the TeamSpace to which you are transferring the APIs.
For more information about how to export and import APIs, see Import and Export APIs.
Change the Information for a TeamSpace User
The system administrator can change TeamSpace user information if a TeamSpace user is unable to manage their own TeamSpace user information. For example, the TeamSpace user cannot log in to API Creator because they forgot their password. System administrators change TeamSpace user information using the Admin API.
Best Practice:
As a system administrator, advise TeamSpace users to self-manage their TeamSpace users.
For more information about how to manage TeamSpace users, see Manage TeamSpace Users.
Prerequisites:
  • The system administrator has created the TeamSpace.
  • The Admin API is using the built-in authentication provider.
Follow these steps:
  1. Log in to API Creator as
    sa
    .
    The APIs page appears.
  2. Open the Admin API.
  3. In the Secure section, click
    Users
    .
    The API User page appears.
  4. From the list of API users, click the name of the TeamSpace user for which you want to change information.
    Within the Admin API, TeamSpace users are API users.
  5. Update the fields, including the password, and then save your changes.
    For more information about the fields on this page, see Manage TeamSpace Users.
  6. Communicate the changes to the TeamSpace user.
The TeamSpace user information is changed.
Deactivate your TeamSpace
System administrators can deactivate TeamSpaces. If the TeamSpace is inactive, the TeamSpace users cannot log in to API Creator, cannot access their TeamSpace. The API users cannot call the APIs contained within the TeamSpace, even though the APIs remain active.
Only system administrators can reactivate TeamSpaces.
Prerequisite:
The system administrator has created the TeamSpace.
Follow these steps:
  1. Open the TeamSpace.
  2. Clear the
    Active
    checkbox, add a note describing the reason for deactivating the TeamSpace in the
    Comments
    field, and then save your changes.
The TeamSpace is deactivated.