Access private repos using Github App or OAuth App #36463
-
|
Hi, I'm a student working to create a CICD pipeline using github app or Oauth App and github repos. I realized that most companies would have their repos private. I looked through the documentation on Github App and OAuth App and I was able to figure out how to get a list of public repos but I'm unable to retrieve the private repos. I'm using Javascript to get the list of repos. Below is my code, I tried the const octokit = new Octokit({
auth: token
});
try {
const response = await octokit.request('Get /user/repos?type=private', {});
return response.data;
} catch(e) {
console.log(e.message);
} |
Beta Was this translation helpful? Give feedback.
Replies: 3 comments 1 reply
-
|
After some digging and testing, I was able to figure out the problem. In order to view and access private repos, the Github App needs to be installed on the user's account. I was able to install my Github App on the account and from there I was able to access the private repos. |
Beta Was this translation helpful? Give feedback.
-
|
Hey there @melchanti and thank you for asking a good question! I'm glad you found our community 🙂 |
Beta Was this translation helpful? Give feedback.
-
|
The access token generated by a GitHub app will not work with the |
Beta Was this translation helpful? Give feedback.
-
|
This is a simple script that performs the task. const fs = require('fs');
const jwt = require('jsonwebtoken');
const axios = require('axios');
// GitHub App installation ID
const installationId = 'INSTALATION_ID';
// GitHub App ID and path to the private key PEM file
const appId = 'APP_ID';
const privateKeyPath = 'KEY_PATH';
// Function to read the private key from PEM file
function getPrivateKey() {
return fs.readFileSync(privateKeyPath, 'utf8');
}
// Function to fetch repositories based on installation ID
async function fetchRepositories() {
try {
// Generate JWT (JSON Web Token) for authentication
const privateKey = getPrivateKey();
const token = jwt.sign({ iss: appId }, privateKey, { algorithm: 'RS256', expiresIn: '10m' });
// Get access token for the installation
const accessTokenResponse = await axios.post(`https://api.github.com/app/installations/${installationId}/access_tokens`, {}, {
headers: {
'Authorization': `Bearer ${token}`,
'Accept': 'application/vnd.github.v3+json'
}
});
const accessToken = accessTokenResponse.data.token;
console.log({accessToken})
// Fetch repositories using the access token
const reposResponse = await axios.get('https://api.github.com/installation/repositories', {
headers: {
'Authorization': `Bearer ${accessToken}`,
'Accept': 'application/vnd.github.v3+json'
}
});
// Log repository names
const repositories = reposResponse.data;
console.dir({repositories} , {depth : Infinity})
// repositories.forEach(repo => {
// console.log(repo.full_name);
// });
} catch (error) {
console.error('Error fetching repositories:', error.message);
}
}
// Call the function to fetch repositories
fetchRepositories(); |
Beta Was this translation helpful? Give feedback.
After some digging and testing, I was able to figure out the problem. In order to view and access private repos, the Github App needs to be installed on the user's account. I was able to install my Github App on the account and from there I was able to access the private repos.