GitHub Console Guide

This page provides a complete guide to the GitHub section of the Namirasoft Credential Console. GitHub credentials support several authentication methods (Password, PAT Classic, PAT Fine Grained, OAuth, GitHub App, and SSH), so you can connect to GitHub.com or GitHub Enterprise Server in the way that fits your setup.

What Is GitHub?

GitHub is a cloud platform for hosting Git repositories and collaborating on code. Teams use it to store source code, review changes, track issues, and automate workflows. It is available as GitHub.com and as GitHub Enterprise Server.

 

Namirasoft Credential connects to GitHub using the authentication method you choose, so authorized Namirasoft applications can access your GitHub data without storing your secrets in plain form.

 

Why Secure Credential Management Matters

GitHub credentials, such as passwords, tokens, and private keys, can grant access to your repositories and account data. If they are exposed in logs, configuration files, or shared machines, they can be misused. For this reason every credential must be encrypted and access controlled, exactly like a password.

 

Overview of GitHub Fields and Options

The sections below explain every field in the GitHub credential form. The fields shown depend on the GitHub Type you select.

• ID (String): This is the unique identifier automatically generated by Namirasoft Credential when a GitHub record is created. You do not enter or modify this value. It is used internally for tracking, linking, and referencing the entry across the Namirasoft ecosystem.

• User ID (Namirasoft Account’s ID): This is the unique ID assigned to the Namirasoft Account that created the GitHub record. It serves as a link between the credential and the user who owns or manages it.

• Workspace ID (Namirasoft Workspace’s ID): This refers to a workspace created in the Namirasoft Workspace app, which allows users to organize credentials by project, environment, or team. The workspace name is displayed along with the ID, and it links back to the Namirasoft Workspace app where the workspace details can be viewed.

• Name (String): This is a human friendly label you choose to identify the credential, such as GitHub Production or CI Bot. It helps you and your team recognize which credential is which and has no impact on authentication itself.

• Host (String): This is the GitHub server that Namirasoft connects to. For GitHub.com, enter github.com. For a GitHub Enterprise Server instance, enter the address you use to reach it, such as github.company.com. You can usually find this value in your browser address bar or from your GitHub administrator.

• Username (String): This is the username of the GitHub account that Namirasoft authenticates with, used together with the method you select below. It is the handle shown on your GitHub profile, not your email address.

• GitHub Type (Enum): This selects how Namirasoft authenticates to GitHub. Choose Password, PAT Classic, PAT Fine Grained, OAuth, GitHub App, or SSH. The fields shown below change based on this selection, so you only complete the values your chosen method requires. The values you enter are encrypted and stored in Namirasoft Secret.

• Password: Authenticate with your GitHub username and password. This applies mainly to GitHub Enterprise Server instances that allow password sign in.

 

• • Password (String): This is the password for the GitHub account named above. Enter the password that account signs in with. Note that GitHub.com no longer accepts account passwords for Git or API access, so this method applies mainly to GitHub Enterprise Server.

 

How to Get Your Password?

 

• GitHub.com no longer accepts account passwords for Git or API access, so use a PAT type instead
• This option mainly applies to GitHub Enterprise Server instances that allow password sign in
• Enter the value exactly as it is

 

 

• PAT Classic: Authenticate with a classic personal access token, which grants scope based access to your account.

 

• • PAT Classic Token (String): This is a classic personal access token generated in your GitHub account. It grants access based on the scopes you select and is used in place of your password. Paste it exactly as GitHub provided it.

 

How to Create a GitHub Personal Access Token (Classic)?

 

• Sign in to GitHub, click your profile photo, then choose Settings
• In the left sidebar, open Developer settings
• Go to Personal access tokens, then Tokens (classic)
• Click Generate new token, set a name, an expiration, and only the scopes Namirasoft needs
• Click Generate token and copy it immediately (it is shown only once)
• Paste it into the PAT Classic Token field and save

 

 

• PAT Fine Grained: Authenticate with a fine grained personal access token, which limits access to specific repositories and permissions.

 

• • PAT Fine Grained Token (String): This is a fine grained personal access token generated in your GitHub account. Unlike a classic token, it limits access to specific repositories and permissions, which improves security. Paste it exactly as GitHub provided it.

 

How to Create a GitHub Fine Grained Token?

 

• Sign in to GitHub, click your profile photo, then choose Settings
• In the left sidebar, open Developer settings
• Go to Personal access tokens, then Fine-grained tokens
• Click Generate new token, set a name, an expiration, the resource owner, and the repositories and permissions Namirasoft needs
• Click Generate token and copy it immediately (it is shown only once)
• Paste it into the PAT Fine Grained Token field and save

 

 

• OAuth: Authenticate through a registered GitHub OAuth App, using a client ID, client secret, and tokens.

 

• • OAuth App Client ID (String): This is the public identifier issued to your GitHub OAuth App when you register it. It identifies your application during the OAuth flow and is not secret on its own.

 

• • OAuth App Client Secret (String): This is the confidential secret issued with your GitHub OAuth App. It is used together with the client ID to authenticate your application and must be kept private.

 

• • OAuth App Access Token (String): This is the token your OAuth App uses to make authorized requests to GitHub on behalf of the user.

 

• • OAuth App Refresh Token (String): This is the token used to obtain a new access token when the current one expires, so access continues without re authorizing.

 

How to Get Your GitHub OAuth App Credentials?

 

• Sign in to GitHub, open Settings, then Developer settings
• Select OAuth Apps, then Register a new application
• Set an application name, homepage URL, and authorization callback URL
• Save to get the Client ID, then generate a Client Secret
• Complete the authorization flow to obtain the Access Token and Refresh Token
• Paste each value into its matching field

 

 

• GitHub App: Authenticate as a GitHub App installation, using an installation ID and a signed token.

 

• • GitHub App Installation ID (String): This is the identifier of your GitHub App installation on a user account or organization. It tells GitHub which installation Namirasoft is acting through.

 

• • GitHub App JWT (String): This is a JSON Web Token signed with your GitHub App private key. It authenticates requests as the app itself, which is the first step before requesting an installation token.

 

• • GitHub App Token (String): This is the installation access token that GitHub issues in exchange for the app JWT. It is used to make API calls on behalf of the installation.

 

How to Get Your GitHub App Credentials?

 

• Sign in to GitHub, open Settings, then Developer settings
• Select GitHub Apps, then create or open your app and note the App ID
• Generate a private key and download the .pem file
• Install the app on your account or organization, then open the installation to find the Installation ID
• Create a JWT signed with the private key, then exchange it for an installation Token
• Paste each value into its matching field

 

 

• SSH: Authenticate with an SSH key pair, using a public and private key.

 

• • SSH Public Key (String): This is the public half of your SSH key pair, the same key you add to your GitHub account. It usually begins with ssh-ed25519 or ssh-rsa.

 

• • SSH Private Key (String): This is the private half of your SSH key pair, which proves your identity to GitHub. Paste the full contents of the private key file, including the header and footer lines, and keep it secret.

 

How to Generate an SSH Key Pair?

 

• Open a terminal (Linux, macOS, or Windows 10 and later)
• Run:

 

ssh-keygen -t ed25519

 

• This creates a private key (id_ed25519) and a public key (id_ed25519.pub)
• Paste the public key contents into the SSH Public Key field
• Paste the private key contents into the SSH Private Key field
• In GitHub, open Settings, then SSH and GPG keys, and add the same public key

 

 

• Description (String): This is an optional text field where you can explain the purpose or usage of the GitHub credential, such as which repositories it can access or what team uses it. Adding a description is helpful when working with multiple credentials in a shared workspace.

• Created At (DateTime): This shows the exact date and time when the GitHub credential record was first created. This value is automatically set when you create the record and does not change over time.

• Updated At (DateTime): This shows the exact date and time when the GitHub credential record was most recently modified. It helps you track when the credential was last maintained.