GitHub_Get_team_membership_for_a_user.ipynb

Kernel: Python 3

GitHub - Get team membership for a user

Give Feedback | Bug report

Tags: #github #teams #members #rest #api #python #snippet

Author: Florent Ravenel

Last update: 2023-04-26 (Created: 2023-04-18)

Description: This notebook get team membership for a user. It will return a dictionary with the state, role and url of the membership.

References:

• GitHub REST API - Get team membership for a user

Input

Import libraries

import requests
import naas

Setup Variables

• token: GitHub personal access token

• org_id: ID of the organization

• team_id: ID of the team

• username: GitHub username

token = naas.secret.get("GITHUB_TOKEN") or "GITHUB_TOKEN"
org_id = "jupyter-naas"
team_id = "<team_id>"
username = "<username>"

Model

Get team membership for a user

def get_team_membership(token, org, team, username):
    # Init
    res_json = None
    
    # Request
    url = f"https://api.github.com/orgs/{org}/teams/{team}/memberships/{username}"
    headers = {
        "Authorization": f"token {token}",
        "Accept": "application/vnd.github.hellcat-preview+json",
    }
    res = requests.get(url, headers=headers)
    
    # Result
    if res.status_code == 200:
        print(f"✅ User '{username }' found in '{org}/{team}'")
        res_json = res.json()
    else:
        print(f"❌ User not found in '{org}/{team}'")
    return res_json

Output

Display result

membership = get_team_membership(token, org_id, team_id, username)
if membership:
    print(membership)