Team and team member API

Admin console: team and team member management; requires an admin session.

list teams

interface address:

• /team/list

HTTP request method:

• GET

request params:

response code:

• common response

response example：

• JSON:

  {
    "data": [
      {
        "id": "1",
        "name": "team-name",
        "domain_id": "1",
        "url": "/team/detail/1",
        "user": "admin"
      }
    ],
    "code": 0,
    "message": "OK"
  }
  

create team

interface address:

• /team/:domain/create

HTTP request method:

• POST

request params:

• domain (path): root domain

• name (form, required): team name, letters and hyphens only

• domain (form, required): same as the root domain above

• user (form, required): username of the owner (a member of this domain)

response code:

• 0: Success

• 1: Invalid parameters, no permission, team already exists, etc.

example:

curl -X POST "$BASE_URL/team/example.com/create" -d "name=dev-team&domain=example.com&user=admin"

team member list (page)

interface address:

• /team/member/list/:id

HTTP request method:

• GET

request params:

• id (path): team ID

response code:

• common response

Note: returns the member list of the team (including domain members or team members). When id is the current domain, the members of the domain are returned.

team member list (API)

interface address:

• /api/team/member/list/:id

HTTP request method:

• GET

request params:

• id (path): team ID

response code:

• common response

response example：

• JSON:

  {
    "data": [
      {
        "id": "1",
        "url": "/member/1/detail/1",
        "name": "Admin",
        "user": "admin",
        "type": 0,
        "email": "admin@example.com"
      }
    ],
    "code": 0,
    "message": "OK"
  }
  

create team member

interface address:

• /team/member/create/:id

HTTP request method:

• POST

request params:

• id (path): team ID

• email (form, required): member email, must be an existing user of this domain (e.g. user@example.com)

response code:

• 0: Success

• 1: Invalid parameters, no permission, user does not exist, etc.

example:

curl -X POST "$BASE_URL/team/member/create/1" -d "email=user@example.com"

Page routes (non-JSON API)

• GET /team - team management page

• GET /team/:domain - team detail/list page of a domain

• GET /team/member/:id - member management page of a team