Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.6 KB

README.md

File metadata and controls

63 lines (45 loc) · 2.6 KB
Raw

Remove team member (Legacy)

Table of contents

  1. Docs
  2. Quick start
  3. Inputs
  4. Outputs

Docs

Original documentation: https://developer.github.com/v3/teams/members/#remove-team-member-legacy

The "Remove team member" endpoint (described below) is deprecated.

We recommend using the Remove team membership endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub."

Quick start

- uses: maxkomarychev/octions/octions/teams/remove-member-legacy@master
  id: my_step_id
  with:
    token: <token value>
    team_id: <team_id value>
    username: <username value>
- name: Print outputs
  run: |
    echo ${{ steps.my_step_id.outputs.id }}
    echo ${{ steps.my_step_id.outputs.number }}
    echo ${{ steps.my_step_id.outputs.status }}

Inputs

Name Is required Description
token true Token to authenticate the request
team_id true team_id parameter
username true username parameter
file_output false Path to store full output of the action
custom_outputs false Custom outputs to create for step. This has to be YAML multiline string literal custom_outputs: |<newline> output_name:path.in.result

Outputs

Name Description
id id field of the response (if exists)
number number field of the response (if exists)
status HTTP status of underlying API call