Team members

Each and every team has one or more team members in it.

They work together to ensure stability of your platform, by:

  • defining test cases

  • talking about results

  • deciding on new edge-cases to tackle

  • find possible breaking points

Permissions

Member role vs API call

List members

Get self role

Add member

Change member role

Remove domain

Reader

True

True

False

False

False

Editor

True

True

False

False

False

Admin

True

True

True

True

True

Owner

True

True

True

True

True

List members

Web

In order to view the members in your team, all you have to do is browse to the Team members page.

API call

The API call for listing the members is:

curl -s \
    -d '{"team_id":"my-team"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/membership/list | jq . -r

{
  "Members": [
    {
      "member_email": "[email protected]",
      "team_id": "my-team",
      "member_role": "Owner",
      "activated_date": "2020-03-23T14:33:52Z",
      "invited_date": "N/A"
    },
    {
      "member_email": "[email protected]",
      "team_id": "my-team",
      "member_role": "Editor",
      "activated_date": "2020-03-25T16:09:55Z",
      "invited_date": "2020-03-25T16:09:55Z"
    }
  ]
}

CLI

Listing is simple:

$ rungutan team list
{
    "Members": [
        {
            "member_email": "[email protected]",
            "team_id": "rungutan",
            "member_role": "Owner",
            "activated_date": "2020-05-19T11:03:33Z",
            "invited_date": "N/A"
        }
    ]
}

Get self role

Web

In order to view your membership, you can just check the Team members page and search for yourself.

API call

The API call for getting your own role is:

curl -s \
    -d '{"team_id":"my-team"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/membership/get | jq . -r

{
  "Membership": "Owner"
}

CLI

In case you suddenly forgot:

$ rungutan team get
{
    "Membership": "Owner"
}

Add members

Web

In order to invite a new member to your team, all you have to do is browse to the Team members page and click on the Add member button.

The allowed role for any new member that can be assigned is:

  • Reader

  • Editor

  • Admin

API call

The API call is:

curl -s \
    -d '{"team_id":"my-team", "member_email": "[email protected]", "member_role": "Editor"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/membership/add | jq . -r

{
  "message": "Successfully invited member to your team. A notification email was sent to the user's mailbox."
}

CLI

Remember to use all proper arguments:

$ rungutan team add --member_email [email protected] --member_role Reader
{
    "message": "Successfully invited and sent a notification email to the new member"
}

Change member role

Web

In order to change the role of an existing member in your team, all you have to do is browse to the Team members page and click on the Change member role button for the respective team member.

The allowed role for an existing member that can be assigned is: * Reader * Editor * Admin

API call

The API call is:

curl -s \
    -d '{"team_id":"my-team", "member_email": "[email protected]", "member_role": "Reader"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/membership/change | jq . -r

{
  "message": "Successfully updated your team member's role. A notification email was sent to the user's mailbox."
}

CLI

And then promote him:

$ rungutan team change --member_email [email protected] --member_role Editor
{
    "message": "Successfully updated your team member's role"
}

Remove member

Web

In order to remove an existing member from your team, all you have to do is browse to the Team members page and click on the Remove member button for the respective team member.

PS: You cannot remove yourself from the team.

API call

The API call is:

curl -s \
    -d '{"team_id":"my-team", "member_email": "[email protected]"}' \
    -H "X-Api-Key: my_api_key" \
    -X POST \
    https://api.rungutan.com/v1/api/membership/remove | jq . -r

{
  "message": "Successfully removed member from your team. A notification email was sent to the user's mailbox."
}

CLI

And now fire him:

$ rungutan team remove --member_email [email protected]
{
    "message": "Successfully removed member from your team"
}