Business Teams Service REST API

Your applications can access and administer business teams by using REST calls.

Documentation

After you deploy Business Teams Service (BTS), you can access the OpenAPI documentation for the REST APIs that are available on the server by directing your browser to the following URL: https://<cpd-host>/teamserver/api/explorer.

The Business Teams Service API on the context path /teamserver manages global teams.

Teams

The teams REST API supports the discovery, creation, retrieval, modification, and deletion of team resources. The following summary lists the operations that are available on the teams context path:

• /teamserver/rest/teams

  • GET: Retrieve team definitions.
  • POST: Create a Team definition.

• /teamserver/rest/teams/{uuid}

    - GET: Retrieve a team definition.
    - PUT: Replace a team definition.
    - DELETE: Delete a team definition.
    - PATCH: Update a team definition incrementally.
  

• /teamserver/rest/teams/{uuid}/contained_users

    - GET: Retrieve the users that are contained in the specified team.
  

• /teamserver/rest/teams/{uuid}/contained_groups

    - GET: Retrieve the groups that are contained in the specified team.
  

Users

The users REST API supports retrieving information about the current user, checking their team memberships, and checking their permissions. The following summary lists the operations that are available on the users context path:

• /teamserver/rest/users/current_user

    - GET: Retrieve information about the current user.
  

• /teamserver/rest/users/current_user/teams

    - GET: Retrieve information about the which teams the current user is a member of.
  

• /teamserver/rest/users/current_user/member_of_any_team

    - GET: Returns true if the current user is a member of any of a specified list of teams.
  

• /teamserver/rest/users/current_user/permission

    - GET: Returns a list of team actions, where the value true indicates that the current user is allowed to perform the action. For example:
  

    {
      "canListMyTeams": true,
      "canListAllTeams": true,
      "canViewTeamDetails": true,
      "canCreateTeam": true,
      "canModifyTeam": true,
      "canReplaceTeam": true,
      "canDeleteTeam": true
    }
  

• /teamserver/rest/users

    - GET: Retrieves information about the list of users. You can use it to search for users that match a filter.
  

• /teamserver/rest/users/{userDN}/teams

    - GET: Returns a list of team definitions for the teams that the user is a member of.
  

• /teamserver/rest/users/{userDN}/member_of_any_team

    - GET: Returns true if the specified user is a member of any of a specified list of teams.
  

Groups

The groups REST API supports retrieving information about the groups.

The following summary lists the operations that are available on the groups context path:

• /teamserver/rest/groups

    - GET: Retrieves information about the list of groups from the user repository, for example LDAP, by using SCIM. It allows you to search for groups that match a filter.