[Eric's API] Github Organizations API 가져오기 오류 해결 👨‍💻

얼마전의 나는

Github 의 API를 통해서 

해당하는 Github User의 Organizations 를 가져오려하였다.

 

이때 여러가지 방법중 나는 2가지 API를 통해서 

User의 List organizations 를 하였다.

 

첫번째는

 

GET

/user/orgs

를 통해서 가져오려 하였다.

https://docs.github.com/en/free-pro-team@latest/rest/orgs/orgs?apiVersion=2022-11-28#list-organizations

 

문제점😡

 

하지만, 분명히 나는 하단의 사진처럼 2개의 조직을 가지고있음에도 불구하고,

하단의 사진처럼 Postman으로 header에 알맞은 token과 X-Github-Api-Version을 

입력했음에도 불구하고 response로

empty array가 나왔다.

 

웃긴건 status code가 200 번으로 

정상이라는 거다.

 

---

해결책

 

그래서 나는 이번에는

다른 API를 통해서 User의 List organizations 를 하였다.

이번에 사용한 API는

 

GET

/users/{username}/orgs

이며, 하단의 방식으로 가져오게 시도하였더니,

https://docs.github.com/en/free-pro-team@latest/rest/orgs/orgs?apiVersion=2022-11-28#list-organizations

 

이번엔 Postman에서 나의 List organizations 를 response 해주는 모습을 볼 수 있다.

하지만 해당 API는

{username}사용자의 공개 조직만을 반환한다.

 

해결책

그래서 처음에 시도하였던

를 통해서 user의 List organizations 를 가져오려면,

처음에 내가 3rd party 인증하는 부분에

나의 organizations 중에서 같이 조회가 되기를 

원하는 organization를 동시에 access를 해줘야한다.

만약에 이미 인증이 완료되어서,

기존의 인증을 취소하고 다시 등록하고싶으면

 

하단의 사진처럼 Github에 들어가서,

해당 사이트의 인증을 취소를 진행하고

다시 나의 organization를 동시에 access를 해주면 해결이 된다.

요약

 

두 API 엔드포인트는 GitHub 사용자의 조직(organization)을 나열하는 데 사용되지만, 주요 차이점은 조회 대상과 관련있다.

 

1. GET /user/orgs

   - 이 API는 현재 인증된 사용자의 조직을 반환합니다.

   - 따라서 이 엔드포인트를 사용하려면 OAuth 토큰 또는 다른 인증 방법을 통해 인증된 세션에서 요청을 해야 합니다.

   - 요청한 사용자가 속한 조직의 목록을 얻기 위해 주로 사용됩니다.

 

2. GET /users/{username}/orgs

   - 이 API는 지정된 `{username}` 사용자의 공개 조직을 반환합니다.

   - `{username}`은 원하는 GitHub 사용자의 이름을 나타냅니다.

   - 이 엔드포인트는 특정 사용자의 공개 조직 정보에 대한 열람이 필요할 때 사용됩니다. 인증이 필수는 아니지만, 인증된 요청에서 더 많은 데이터에 접근할 수 있습니다.

 

둘 다 사용자의 조직을 반환하지만, 첫 번째는 현재 인증된 사용자에 관한 것이고, 두 번째는 특정 사용자에 관한 것입니다. 따라서 사용 케이스나 필요한 데이터에 따라 적절한 엔드포인트를 선택해야 합니다.

 

 

 

참고사이트

https://docs.github.com/en/free-pro-team@latest/rest/orgs/orgs?apiVersion=2022-11-28#list-organizations 

Organizations - GitHub Docs