GitHub is a code hosting platform for collaboration and version control. This connector facilitates automated interactions with Github for actions such as creating and managing repositories, branches, issues, pull requests, and many more.
This document provides information about the GitHub Connector, which facilitates automated interactions, with a GitHub server using FortiSOAR™ playbooks. Add the GitHub Connector as a step in FortiSOAR™ playbooks and perform automated operations with GitHub.
Connector Version: 2.1.0
FortiSOAR™ Version Tested on: 7.6.3-5574
GitHub Version Tested on: 2022-11-28
GitHub Enterprise Server Tested on: 3.15
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the GitHub connector in version 2.1.0:
Added three new actions
Updated the action clone_repository to improve code quality, reliability, and maintainability
Updated the action push_repository for a feature-complete, safer, and cleaner implementation that adds robust GitHub repo synchronization, supports deletion of remote files, and improves developer experience through better logging, path handling, and error management.
Added the following new pluggable source control actions in sample collection
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command as a root user to install the connector:
yum install cyops-connector-github
For managing user access to your organization's repositories and repository roles, refer to https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the GitHub connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:
| Parameter | Description |
|---|---|
| GitHub Account | Select the option used to access the GitHub server to connect and perform the automated operations. You can choose from the following options:
|
| Username | Specify the username used to access the GitHub server to connect and perform the automated operations. |
| Personal Access Token | Specify the Personal Access Token used to access the GitHub server to connect and perform the automated operations. For more information, refer https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens. |
| Verify SSL | Specifies whether the SSL certificate for the server is to be verified. By default, this option is selected, i.e., set to true. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations:
| Function | Description | Annotation and Category |
|---|---|---|
| Create Repository | Creates a new organization or an authenticated user repository based on the repository type, organization or repository owner's name, and other input parameters you have specified | create_repository Investigation |
| Create Repository Using Template | Creates a new repository using a template based on the template owner, template repository name, new repository name, and other input parameters you have specified | create_repository_using_template Investigation |
| List Organization Repositories | Lists all the repositories of an organization based on the organization name, repository type, sort criteria, sort order, and other input parameters you have specified | list_organization_repositories Investigation |
| List User Repositories | Lists public repositories for the specified user based on the username, repository type, sort criteria, sort order, and other input parameters you have specified | list_user_repositories Investigation |
| List Authenticated User Repositories | Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access based on the authenticated user's affiliation, repository type, sort criteria, sort order, and other input parameters you have specified | list_authenticated_user_repositories Investigation |
| Update Repository | Updates an organization's or an authenticated user's repository based on the old repository name, new repository name, and other input parameters you have specified | update_repository Investigation |
| Delete Repository | Deletes an organization's or an authenticated user's repository from GitHub based on the repository type, organization or repository owner's name, and other input parameters you have specified | delete_repository Investigation |
| Fork Organization Repository | Forks an organization's or an account owner's repository based on the repository owner's name, repository name, and other input parameters you have specified | fork_organization_repository Investigation |
| List Fork Repositories | Lists the repositories that have been forked for the specified organization based on the repository owner name, repository name, repository sort type, and other input parameters you have specified | list_fork_repositories Investigation |
| Create or Update File Contents | Creates a new file or replaces an existing file in a repository based on the repository type, organization or repository owner's name, file name, commit message, file contents, and other input parameters you have specified | create_update_file_contents Investigation |
| Add Repository Collaborator | Updates a personal repository of a specified user to add a collaborator for the repository based on the repository owner name, repository name, collaborator username, and other input parameters you have specified | add_repository_collaborator Investigation |
| List Repository Collaborator | Lists the collaborator details for specified repository based on the repository owner name, repository name, and other input parameters you have specified | list_repository_collaborator Investigation |
| Get Branch Revision | Retrieves branch revision details of the specified branch in GitHub based on the repository type, organization or repository owner's name, base branch name, and other input parameters you have specified | get_branch_revision Investigation |
| Create Branch | Creates a new branch in GitHub based on the repository type, organization or repository owner's name, new branch name, base branch name or SHA, and other input parameters you have specified | create_branch Investigation |
| Merge Branch | Merges a specified branch to the base branch in GitHub based on the repository owner name, repository name, base branch name, head branch name, and other input parameters you have specified | merge_branch Investigation |
| List Branches | Lists branches of the specified repository based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_branches Investigation |
| Delete Branch | Delete a new branch in GitHub based on the repository type, organization or repository owner's name, repository name, branch name, and other input parameters you have specified | delete_branch Investigation |
| Fetch Upstream | Synchronizes a branch of a forked repository to keep it up-to-date with the upstream repository based on the repository owner's name, repository name, branch name, and other input parameters you have specified | fetch_upstream Investigation |
| Clone Repository | Clones the specified repository in GitHub based on the repository type, organization or repository owner's name, repository name, specify if you want the repository as a .zipfile, and other input parameters you have specified | clone_repository Investigation |
| Update Remote Repository | Applies changes made in a FortiSOAR file to the specified remote repository that is cloned from GitHub based on the file IRI and cloned repository path you have specified | update_clone_repository Investigation |
| Push Changes | Commits the local repository changes to the specified repository in GitHub based on the repository type, organization or repository owner's name, repository name, cloned repository path, and other input parameters you have specified | push_repository Investigation |
| Create Pull Request | Creates a pull request for the specified repository on GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | create_pull_request Investigation |
| List Pull Request | Lists pull requests for the specified repository on GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_pull_request Investigation |
| Add Reviewers for a Pull Request | Adds reviewers for the specified pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified. Pull request authors, repository owners, and collaborators can request a review of the pull request from anyone with write access to the repository. Each requested reviewer receives a notification asking them to review the pull request | add_reviewers Investigation |
| List Review Comments on a Pull Request | Lists the review comments associated with the specified pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified | list_review_comments Investigation |
| List Pull Request Reviews | Lists the reviews associated with the specified pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified | list_pr_reviews Investigation |
| Add Pull Request Review | Adds a review for a pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified | submit_pr_review Investigation |
| Merge Pull Request | Merges the specified pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified | merge_pull_request Investigation |
| Create Issue | Creates an issue for the specified repository or user on GitHub based on the repository type, organization, or repository owner's name, repository name, title, and other input parameters you have specified | create_issue Investigation |
| List Repository Issue | List issues for the specified repository or user on GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_repository_issue Investigation |
| Update Issue | Update issues for the specified repository or user on GitHub based on the repository type, organization or repository owner's name, repository name, update number, and other input parameters you have specified | update_issue Investigation |
| Create Issue Comment | Creates an issue comment for the specified repository or user on GitHub based on the repository type, organization, or repository owner's name, repository name, and other input parameters you have specified | create_issue_comment Investigation |
| Create Release | Creates a release for the specified repository on GitHub based on the repository type, organization or repository owner's name, repository name, tag name, and other input parameters you have specified | create_release Investigation |
| List Releases | Returns a list of releases that does not include regular GitHub tags associated with a release. Information about published releases is available to everyone. Only users with push access will receive listings for draft releases. The list of releases is retrieved from GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_releases Investigation |
| List Stargazers | Lists the people that have marked the specified repository in GitHub with a star based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_stargazers Investigation |
| Star Repository | Stars the specified repository for the authenticated user in GitHub based on the repository type, organization or repository owner's name, repository name, and repository owner you have specified | star_repository Investigation |
| List Watchers | Lists the people that are watching the specified repository in GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_watchers Investigation |
| Set Repository Subscription | Sets the subscription to the specified repository in GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | set_repo_subscription Investigation |
| Get Server URL | Retrieves the server URL (Web URL) of the configured GitHub server. | get_web_url Investigation |
| Get File | Retrieves information such as name, size, and content about a file from the GitHub repository based on the repository type, repository name, and other input parameters that you have specified. | get_file_from_repository Investigation |
| Delete File | Deletes a file from the GitHub repository based on the repository type, repository name, and other input parameters that you have specified. | delete_file_from_repository Investigation |
| Search Code | Searches the code based on the query that you have specified. | search_code Investigation |
| Get Repository | Retrieves an organization's or an authenticated user's repository based on the repository name and the organization or repository owner's name that you have specified. | get_repository Investigation |
| Get Commit | Retrieves the contents of a single commit reference based on the repository type, repository name, commit reference, and other input parameters that you have specified. The commit reference can be a commit SHA, branch name, or tag name. | get_commit Investigation |
| Get Commit Comparison | Retrieves a comparison of two commits against each other based on the repository type, repository name, base branch name, head branch name, and other input parameters that you have specified. You can compare commit SHAs within the same repository, or across repositories within the same network (such as forks). This allows you to view changes between commits, including commits made on forked branches. | compare_commit Investigation |
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository in which to create the repository on GitHub:
|
| Repository Name | Specify the name of the repository you want to create on GitHub |
| Description | Specify a short description of the repository you want to create on GitHub |
| Homepage | Specify the homepage of the repository you want to create on GitHub. A Homepage is a URL that contains more information about the repository |
| Private | Select this option to create a Private repository on GitHub. Clear this option to create a Public repository on GitHub |
| Has Issues | Select this option to enable issues for the repository you want to create on GitHub. Clear this option to disable issues for the repository you want to create on GitHub |
| Has Projects | Select this option to enable projects for the repository you want to create on GitHub. Clear this option to disable projects for the repository you want to create on GitHub |
| Has Wiki | Select this option to enable the wiki for the repository you want to create on GitHub; this is the default. Clear this option to disable the wiki for the repository you want to create on GitHub |
| Is Template | Select this option to make the repository you are creating available as a template repository on GitHub. Clear this option to prevent the repository you are creating from being available as a template repository on GitHub |
| Other Fields | Specify fields in the JSON format to be used as Search criteria (used to determine dynamic membership) fields or as link fields |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": "",
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": "",
"permissions": {
"admin": "",
"maintain": "",
"push": "",
"triage": "",
"pull": ""
},
"allow_squash_merge": "",
"allow_merge_commit": "",
"allow_rebase_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_update_branch": "",
"network_count": "",
"subscribers_count": ""
}
| Parameter | Description |
|---|---|
| Template Owner | Specify the name of the template owner of the repository you want to create on GitHub |
| Template Repository | Specify the name of the template repository using which you want to create this repository on GitHub |
| New Repository Name | Specify the name of the repository you want to create on GitHub |
| New Repository Owner | Specify the name of the organization or person who will own the new repository |
| Description | Specify a short description of the repository you want to create on GitHub |
| Include All Branches | Select this option to include the directory structure and files from all branches in the template repository and not just the default branch |
| Private | Select this option to create a private repository on GitHub. By default, this option is cleared and hence creates a public repository on GitHub |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"forks": "",
"stargazers_count": "",
"watchers_count": "",
"watchers": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"open_issues": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"allow_rebase_merge": "",
"allow_auto_merge": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
}
}
| Parameter | Description |
|---|---|
| Organization Name | Specify the name of the organization whose list of repositories you want to retrieve from GitHub. |
| Repository Type | Select the type of repository you want to retrieve from GitHub. The repository type limits the results to the repositories you have selected. You can select from the following options:
|
| Sort | Select the property to sort the results returned by this operation. You can select from the following options:
|
| Direction | Select the property to sort the direction of the results returned by this operation. You can select from the following options:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"template_repository": ""
}
]
| Parameter | Description |
|---|---|
| Username | Specify the username of the GitHub account whose repositories you want to retrieve from GitHub. |
| Repository Type | Select the type of repository you want to retrieve from GitHub. The repository type limits the results to the repositories you have selected. You can select from the following options:
|
| Sort | Select the property to sort the results returned by this operation. You can select from the following options:
|
| Direction | Select the property to sort the direction of the results returned by this operation. You can select from the following options:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": "",
"permissions": {
"admin": "",
"maintain": "",
"push": "",
"triage": "",
"pull": ""
}
}
]
| Parameter | Description |
|---|---|
| Visibility | (Optional) Select from the following options to specify the visibility of the repositories to be fetched.
|
| Affiliation | Specify a comma-separated list of values from the following options:
|
| Repository Type | Select the type of repository you want to retrieve from GitHub. The repository type limits the results to the repositories you have selected. You can select from the following options:
|
| Sort | Select the property to sort the results returned by this operation. You can select from the following options:
|
| Direction | Select the property to sort the direction of the results returned by this operation. You can select from the following options:
|
| Updated After | Specify the start date and time of the duration in which the notifications, to be displayed, were updated |
| Updated Before | Specify the end date and time of the duration in which the notifications, to be displayed, were updated |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"allow_rebase_merge": "",
"template_repository": "",
"temp_clone_token": "",
"allow_squash_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_merge_commit": "",
"subscribers_count": "",
"network_count": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
},
"forks": "",
"open_issues": "",
"watchers": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the method from the following options using which you want to create the repository on GitHub:
|
| Old Repository Name | Specify the name of the repository that you want to update on GitHub. |
| New Repository Name | Specify the new name of the repository to update on GitHub. |
| Description | (Optional) Specify a short description of the repository you want to create on GitHub. |
| Homepage | (Optional) Specify the homepage of the repository you want to create on GitHub. A Homepage is a URL that contains more information about the repository. |
| Private | (Optional) Select this option to create a Private repository on GitHub. Clear this option (default) to create a Public repository on GitHub. |
| Has Issues | (Optional) Select this option (default) to enable issues for the repository you want to create on GitHub. Clear this option to disable issues for the repository you want to create on GitHub. |
| Has Projects | (Optional) Select this option to enable projects for the repository you want to create on GitHub. Clear this option to disable projects for the repository you want to create on GitHub. |
| Has Wiki | (Optional) Select this option to enable the wiki for the repository you want to create on GitHub; this is the default. Clear this option to disable the wiki for the repository you want to create on GitHub. |
| Other Fields | (Optional) Specify fields in the JSON format to be used as Search criteria (used to determine dynamic membership) fields or as link fields. |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": "",
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": "",
"permissions": {
"admin": "",
"maintain": "",
"push": "",
"triage": "",
"pull": ""
},
"allow_squash_merge": "",
"allow_merge_commit": "",
"allow_rebase_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_update_branch": "",
"network_count": "",
"subscribers_count": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository to delete from GitHub:
|
| Repository Name | Specify the name of the repository that you want to delete from GitHub. |
The output contains a non-dictionary value.
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose fork is to be created:
|
| Repository Name | Specify the name of the repository you want to fork in GitHub. |
| Organization Name | (Optional) Specify the name of the organization whose repository you want to fork in GitHub. |
| New Fork Name | Specify a new name for the fork, when forking from an existing repository. |
| Default Branch | Select this option to fork an existing repository's default branch only from GitHub. |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
},
"language": "",
"forks_count": "",
"forks": "",
"stargazers_count": "",
"watchers_count": "",
"watchers": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"open_issues": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"pull": "",
"push": "",
"admin": ""
},
"allow_rebase_merge": "",
"template_repository": {},
"temp_clone_token": "",
"allow_squash_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_merge_commit": "",
"allow_forking": "",
"subscribers_count": "",
"network_count": "",
"organization": {},
"parent": {},
"source": {}
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose forks are to be listed:
|
| Repository Name | Specify the name of the repository whose list of forked repositories you want to retrieve from GitHub. |
| Sort Repository By | Select the property to sort the results returned by this operation, from the following options:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"template_repository": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose file contents are to be updated on GitHub:
|
| Repository Name | Specify the name of the repository whose file contents are to be created or updated, on GitHub. |
| File Name | Specify the name of the file whose file contents are to be created or updated, on GitHub. |
| Commit Message | Specify the commit message that you want to add while creating/updating the content file on GitHub. |
| File Content | Specify the file content that you want to create or update on GitHub. |
| Branch Name | (Optional) Specify the branch name where you want to add the content file on GitHub. |
| SHA | (Optional) Specify the blob SHA of the file being replaced. Required if you are updating a file. |
The output contains the following populated JSON schema:
{
"content": {
"name": "",
"path": "",
"sha": "",
"size": "",
"url": "",
"html_url": "",
"git_url": "",
"download_url": "",
"type": "",
"_links": {
"self": "",
"git": "",
"html": ""
}
},
"commit": {
"sha": "",
"node_id": "",
"url": "",
"html_url": "",
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"tree": {
"sha": "",
"url": ""
},
"message": "",
"parents": [],
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": ""
}
}
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type from the following options:
|
| Repository Owner | Specify the account holder of the repository on GitHub in which you want to add the specified collaborator. |
| Repository Name | Specify the name of the repository on GitHub in which you want to add the specified collaborator. |
| Collaborator Username | Specify the handle for the GitHub user account that you want to add as a collaborator for the specified repository on GitHub. |
| Permission | (Optional) Select the permission that you want to grant to the specified collaborator. Permissions are valid only on organization-owned repositories. You can select from the following options:
|
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"repository": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"hooks_url": ""
},
"invitee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"inviter": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"permissions": "",
"created_at": "",
"url": "",
"html_url": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type from the following options:
|
| Repository Owner | Specify the account holder of the repository on GitHub in which you want to add the specified collaborator. |
| Repository Name | Specify the name of the repository on GitHub in which you want to add the specified collaborator. |
| Collaborator Affiliation | Select the affiliation, from the following options, to filter the repository collaborators:
|
| Permission | Select the permissions granted, from the following options, to filter the repository collaborators:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": "",
"permissions": {
"admin": "",
"maintain": "",
"push": "",
"triage": "",
"pull": ""
},
"role_name": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose branch revision details are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose branch revision details you want to retrieve from GitHub. |
| Base Branch | Specify the name of the branch whose branch revision details you want to retrieve from GitHub. |
The output contains the following populated JSON schema:
{
"ref": "",
"node_id": "",
"url": "",
"object": {
"sha": "",
"type": "",
"url": ""
}
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository where the branch is to be created on GitHub:
|
| Repository Name | Specify the name of the repository for which you want to create a branch on GitHub. |
| New Branch Name | Specify the name of the branch you want to create on GitHub. |
| Base Branch Name/SHA | Select from the following options to create a new branch from the base branch on GitHub.
|
The output contains the following populated JSON schema:
{
"ref": "",
"node_id": "",
"url": "",
"object": {
"sha": "",
"type": "",
"url": ""
}
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose repository branch is to be merged on GitHub:
|
| Repository Name | Specify the name of the repository that you want to merge with the base branch in GitHub. |
| Base Branch Name | Specify the name of the base branch to which you want to merge the specified head in GitHub. |
| Head | Specify the head that you want to merge to the base branch in GitHub. This can be a branch name or a commit SHA1. |
| Commit Message | (Optional) Specify the commit message to be used for the merge and commit action. If you do not specify any commit message, a default commit message is used. |
The output contains the following populated JSON schema:
{
"url": "",
"sha": "",
"node_id": "",
"html_url": "",
"comments_url": "",
"commit": {
"url": "",
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "",
"tree": {
"url": "",
"sha": ""
},
"comment_count": "",
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": ""
}
},
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"parents": [
{
"url": "",
"sha": ""
}
],
"stats": {
"additions": "",
"deletions": "",
"total": ""
},
"files": [
{
"filename": "",
"additions": "",
"deletions": "",
"changes": "",
"status": "",
"raw_url": "",
"blob_url": "",
"patch": ""
}
]
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose repository branches are to be listed on GitHub:
|
| Repository Name | Specify the name of the repository whose list of branches you want to retrieve from GitHub. |
| Protected | Select this option to return only protected branches from GitHub. Clear this option to return only unprotected branches from GitHub. Omit this parameter, i.e., set it to null, to return all branches from GitHub. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"name": "",
"commit": {
"sha": "",
"url": ""
},
"protected": "",
"protection": {
"enabled": "",
"required_status_checks": {
"enforcement_level": "",
"contexts": [],
"checks": []
}
},
"protection_url": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose branch is to be deleted from GitHub:
|
| Repository Name | Specify the name of the repository whose branch is to be deleted from GitHub. |
| Branch Name | Specify the name of the branch you want to delete on GitHub. |
The output contains a non-dictionary value.
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository with which to synchronize the fork:
|
| Repository Name | Specify the name of the repository with which you want to synchronize the specified branch. |
| Branch Name | Specify the name of the branch that should be updated to match the specified upstream repository. |
The output contains the following populated JSON schema:
{
"message": "",
"merge_type": "",
"base_branch": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository to be cloned on GitHub:
|
| Repository Name | Specify the name of the repository to be cloned on GitHub |
| Branch Name | Specify the name of the repository's branch to cloned. |
| Clone As ZIP | Select this option to clone the specified repository as a zip file |
The output contains the following populated JSON schema:
{
"path": ""
}
| Parameter | Description |
|---|---|
| FortiSOAR File IRI | Specify the FortiSOAR file IRI whose changes you want to replace in the specified local repository. |
| Cloned Repository Path | Specify the path of the cloned repository to which you want to apply the changes of the specified FortiSOAR file. |
The output contains a non-dictionary value.
| Parameter | Description |
|---|---|
| Repository Type | Select a repository type from the following options in which to push the changes on GitHub:
|
| Repository Name | Specify the name of the repository whose changes you want to push on GitHub. |
| Cloned Repository Path | Specify the path of the cloned repository whose changes you want to push on GitHub. |
| Branch Name | Specify the name of the branch to which you want to push the code of the local repository. |
| Commit Summary | Specify a summary of the commit being pushed to GitHub. |
| Commit Description | Specify a description of the commit being pushed to GitHub. |
The output contains the following populated JSON schema:
{
"status": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository in which to create a pull request on GitHub:
|
| Repository Name | Specify the name of the repository on which you want to create a pull request on GitHub. |
| Head Repository | Specify the name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch. |
| Base Branch | Specify the name of the branch to which you want to pull the changes. The branch to which you want to pull the changes should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. |
| Pull Request Title | Specify the title of the new pull request that you want to create on GitHub. |
| Pull Request Comments | Specify the contents of the new pull request that you want to create on GitHub. |
| Allow Edits By Maintainers | Select this option to allow maintainers to modify the pull request. |
| Draft | Select this option to create the pull request as a 'Draft'. |
The output contains the following populated JSON schema:
{
"url": "",
"id": "",
"node_id": "",
"html_url": "",
"diff_url": "",
"patch_url": "",
"issue_url": "",
"number": "",
"state": "",
"locked": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"merged_at": "",
"merge_commit_sha": "",
"assignee": "",
"assignees": [],
"requested_reviewers": [],
"requested_teams": [],
"labels": [],
"milestone": "",
"draft": "",
"commits_url": "",
"review_comments_url": "",
"review_comment_url": "",
"comments_url": "",
"statuses_url": "",
"head": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"base": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"issue": {
"href": ""
},
"comments": {
"href": ""
},
"review_comments": {
"href": ""
},
"review_comment": {
"href": ""
},
"commits": {
"href": ""
},
"statuses": {
"href": ""
}
},
"author_association": "",
"auto_merge": "",
"active_lock_reason": "",
"merged": "",
"mergeable": "",
"rebaseable": "",
"mergeable_state": "",
"merged_by": "",
"comments": "",
"review_comments": "",
"maintainer_can_modify": "",
"commits": "",
"additions": "",
"deletions": "",
"changed_files": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose, pull requests are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose pull requests are to be retrieved from GitHub. |
| Pull Number | (Optional) Specify the number that identifies the pull request. |
| State | (Optional) Select the state of the pull requests whose details you want to retrieve from GitHub. The state parameter filters the results returned by this operation to only pull requests that match the selected state. You can select from following options:
|
| Head Repository | (Optional) Specify the head user or head organization and branch name in the format of user:ref-name or organization:ref-name to filter the results returned by this operation to only pull requests that match the specified head repository. |
| Base Branch | (Optional) Specify the name of the base branch name to filter the results returned by this operation to only pull requests that match the specified base branch name. |
| Sort | (Optional) Select the property to sort the results returned by this operation. You can select from the following options:
|
| Direction | (Optional) Select the property to sort the direction of the results returned by this operation. You can select from the following options:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
Output schema when the Pull Number is not specified:
[
{
"url": "",
"id": "",
"node_id": "",
"html_url": "",
"diff_url": "",
"patch_url": "",
"issue_url": "",
"number": "",
"state": "",
"locked": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"merged_at": "",
"merge_commit_sha": "",
"assignee": "",
"assignees": [],
"requested_reviewers": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"requested_teams": [],
"labels": [],
"milestone": "",
"draft": "",
"commits_url": "",
"review_comments_url": "",
"review_comment_url": "",
"comments_url": "",
"statuses_url": "",
"head": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"base": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"issue": {
"href": ""
},
"comments": {
"href": ""
},
"review_comments": {
"href": ""
},
"review_comment": {
"href": ""
},
"commits": {
"href": ""
},
"statuses": {
"href": ""
}
},
"author_association": "",
"auto_merge": "",
"active_lock_reason": ""
}
]
Output schema when the Pull Number IS specified:
{
"url": "",
"id": "",
"node_id": "",
"html_url": "",
"diff_url": "",
"patch_url": "",
"issue_url": "",
"number": "",
"state": "",
"locked": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"merged_at": "",
"merge_commit_sha": "",
"assignee": "",
"assignees": [],
"requested_reviewers": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"requested_teams": [],
"labels": [],
"milestone": "",
"draft": "",
"commits_url": "",
"review_comments_url": "",
"review_comment_url": "",
"comments_url": "",
"statuses_url": "",
"head": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"base": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"issue": {
"href": ""
},
"comments": {
"href": ""
},
"review_comments": {
"href": ""
},
"review_comment": {
"href": ""
},
"commits": {
"href": ""
},
"statuses": {
"href": ""
}
},
"author_association": "",
"auto_merge": "",
"active_lock_reason": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository where reviewers for a PR are to be added on GitHub:
|
| Repository Name | Specify the name of the repository in which you want to add reviewers for the specified pull request in GitHub. |
| Pull Number | Specify the number that identifies the pull request to which you want to add reviewers. |
| Reviewers | (Optional) Specify the comma-separated list of user names that you want to add as reviewers of the specified repository. |
| Team Reviewers | (Optional) Specify the comma-separated list of team names that you want to add as reviewers of the specified repository. |
The output contains the following populated JSON schema:
{
"url": "",
"id": "",
"node_id": "",
"html_url": "",
"diff_url": "",
"patch_url": "",
"issue_url": "",
"commits_url": "",
"review_comments_url": "",
"review_comment_url": "",
"comments_url": "",
"statuses_url": "",
"number": "",
"state": "",
"locked": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"labels": [
{
"id": "",
"node_id": "",
"url": "",
"name": "",
"description": "",
"color": "",
"default": ""
}
],
"milestone": {
"url": "",
"html_url": "",
"labels_url": "",
"id": "",
"node_id": "",
"number": "",
"state": "",
"title": "",
"description": "",
"creator": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"open_issues": "",
"closed_issues": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"due_on": ""
},
"active_lock_reason": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"merged_at": "",
"merge_commit_sha": "",
"assignee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assignees": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"requested_reviewers": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"requested_teams": [
{
"id": "",
"node_id": "",
"url": "",
"html_url": "",
"name": "",
"slug": "",
"description": "",
"privacy": "",
"permission": "",
"members_url": "",
"repositories_url": "",
"parent": ""
}
],
"head": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"allow_rebase_merge": "",
"template_repository": "",
"temp_clone_token": "",
"allow_squash_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_merge_commit": "",
"subscribers_count": "",
"network_count": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
},
"forks": "",
"open_issues": "",
"watchers": ""
}
},
"base": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"allow_rebase_merge": "",
"template_repository": "",
"temp_clone_token": "",
"allow_squash_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_merge_commit": "",
"subscribers_count": "",
"network_count": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
},
"forks": "",
"open_issues": "",
"watchers": ""
}
},
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"issue": {
"href": ""
},
"comments": {
"href": ""
},
"review_comments": {
"href": ""
},
"review_comment": {
"href": ""
},
"commits": {
"href": ""
},
"statuses": {
"href": ""
}
},
"author_association": "",
"auto_merge": "",
"draft": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose PR review comments are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose PR review comments are to be retrieved from GitHub. |
| Pull Number | Specify the number that identifies the pull request whose associated comments you want to retrieve from GitHub. |
| Sort | Select the property to sort the results returned by this operation. You can select from following options:
|
| Direction | Select the direction to sort the results returned by this operation. You can select from following options:
NOTE:If you do not specify the Sort parameter then this parameter is ignored. |
The output contains the following populated JSON schema:
[
{
"url": "",
"pull_request_review_id": "",
"id": "",
"node_id": "",
"diff_hunk": "",
"path": "",
"position": "",
"original_position": "",
"commit_id": "",
"original_commit_id": "",
"in_reply_to_id": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"created_at": "",
"updated_at": "",
"html_url": "",
"pull_request_url": "",
"author_association": "",
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"pull_request": {
"href": ""
}
},
"start_line": "",
"original_start_line": "",
"start_side": "",
"line": "",
"original_line": "",
"side": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose, pull request reviews are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose pull request reviews are to be retrieved from GitHub. |
| Pull Number | Specify the number that identifies the pull request whose associated reviews you want to retrieve from GitHub. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"state": "",
"html_url": "",
"pull_request_url": "",
"author_association": "",
"_links": {
"html": {
"href": ""
},
"pull_request": {
"href": ""
}
},
"submitted_at": "",
"commit_id": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository where the pull request review is to be added on GitHub:
|
| Repository Name | Specify the name of the repository where the pull request review is to be added on GitHub. |
| Pull Number | Specify the number that identifies the pull request whose review you want to submit to GitHub. |
| Commit ID | Specify the SHA of the commit that needs a review. |
| Review Comment | Specify the body of the pull request review whose review you want to submit to GitHub. Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review. |
| Review Action | Select the review action of the pull request whose review you want to submit to GitHub. |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"state": "",
"html_url": "",
"pull_request_url": "",
"author_association": "",
"_links": {
"html": {
"href": ""
},
"pull_request": {
"href": ""
}
},
"submitted_at": "",
"commit_id": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose, pull requests are to be merged on GitHub:
|
| Repository Name | Specify the name of the repository whose pull requests are to be merged in GitHub. |
| Pull Number | Specify the number that identifies the pull request that you want to merge with the specified repository in GitHub. |
| Commit Title | Specify the title of the automatic commit message to be used for the merge and commit action. If you do not specify any commit title, a default title is used. |
| Commit Message | Specify the contents of the automatic commit message to be used for the merge and commit action. |
| SHA | Value of the SHA that the pull request head must match to allow merging with the specified repository. |
| Merge Method | Select the method for merging the specified pull request with the specified repository. You can select from following options:
|
The output contains the following populated JSON schema:
{
"sha": "",
"merged": "",
"message": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository where the issue is to be created from GitHub:
|
| Repository Name | Specify the name of the repository where the issue is to be created in GitHub. |
| Title | Specify the title of the issue which you want to create in GitHub. |
| Contents | Specify the contents of the issue which you want to create in GitHub. |
| Assignees | Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. |
| Milestone | Specify the number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise. |
| Labels | Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise. |
The output contains the following populated JSON schema:
{
"url": "",
"repository_url": "",
"labels_url": "",
"comments_url": "",
"events_url": "",
"html_url": "",
"id": "",
"node_id": "",
"number": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"labels": [
{
"id": "",
"node_id": "",
"url": "",
"name": "",
"color": "",
"default": "",
"description": ""
}
],
"state": "",
"locked": "",
"assignee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assignees": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"milestone": "",
"comments": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"author_association": "",
"active_lock_reason": "",
"body": "",
"closed_by": "",
"reactions": {
"url": "",
"total_count": "",
"+1": "",
"-1": "",
"laugh": "",
"hooray": "",
"confused": "",
"heart": "",
"rocket": "",
"eyes": ""
},
"timeline_url": "",
"performed_via_github_app": "",
"state_reason": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose issues are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose issues are to be retrieved in GitHub. |
| Milestone | Specify a value for the milestone. If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned. |
| State | Select the type of state of issue you want to retrieve from GitHub. You can select from following options:
|
| Assignee | Specify the name of the user. Pass none for issues with no assigned user, and * for issues assigned to any user. |
| Creator | Specify the user that created the issue. |
| Mentioned | Specify a user mentioned in the issue. |
| Labels | Specify a list of comma-separated label names. Example: bug,ui,@high. |
| Sort | Select the property to sort the results returned by this operation. You can select from following options:
|
| Direction | Select the property to sort the direction of the results returned by this operation. You can select from following options:
|
| Since | (Optional) Specify the start date and time of the duration in which the notifications to be displayed was updated. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"url": "",
"repository_url": "",
"labels_url": "",
"comments_url": "",
"events_url": "",
"html_url": "",
"id": "",
"node_id": "",
"number": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"labels": [
{
"id": "",
"node_id": "",
"url": "",
"name": "",
"color": "",
"default": "",
"description": ""
}
],
"state": "",
"locked": "",
"assignee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assignees": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"milestone": "",
"comments": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"author_association": "",
"active_lock_reason": "",
"body": "",
"reactions": {
"url": "",
"total_count": "",
"+1": "",
"-1": "",
"laugh": "",
"hooray": "",
"confused": "",
"heart": "",
"rocket": "",
"eyes": ""
},
"timeline_url": "",
"performed_via_github_app": "",
"state_reason": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose issues are to be updated on GitHub:
|
| Repository Name | Specify the name of the repository whose issues are to be updated on GitHub. |
| Issue Number | Specify the issue number of the repository whose issues are to be updated on GitHub. |
| Title | Specify the title of the issue which you want to update on GitHub. |
| Contents | Specify the contents of the issue which you want to update on GitHub. |
| State | Select the type of state of issue you want to update on GitHub. You can from following options:
|
| State Reason | Select the type of state reason for the current state of the issue you want to update in GitHub. You can select from following options:
|
| Milestone | Specify the number of the milestone to associate this issue with or null to remove the current. |
| Labels | Specify labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. |
| Assignees | Specify logins for users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. |
The output contains the following populated JSON schema:
{
"url": "",
"repository_url": "",
"labels_url": "",
"comments_url": "",
"events_url": "",
"html_url": "",
"id": "",
"node_id": "",
"number": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"labels": [
{
"id": "",
"node_id": "",
"url": "",
"name": "",
"color": "",
"default": "",
"description": ""
}
],
"state": "",
"locked": "",
"assignee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assignees": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"milestone": "",
"comments": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"author_association": "",
"active_lock_reason": "",
"body": "",
"closed_by": "",
"reactions": {
"url": "",
"total_count": "",
"+1": "",
"-1": "",
"laugh": "",
"hooray": "",
"confused": "",
"heart": "",
"rocket": "",
"eyes": ""
},
"timeline_url": "",
"performed_via_github_app": "",
"state_reason": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository in which to create an issue on GitHub:
|
| Repository Name | Specify the name of the repository whose issue comment you want to create in GitHub |
| Issue Number | Specify the issue number of the repository whose issue comment you want to create in GitHub |
| Comment | Specify the comment contents of the issue comment which you want to create in GitHub |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"url": "",
"html_url": "",
"body": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"created_at": "",
"updated_at": "",
"issue_url": "",
"author_association": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose release is to be created on GitHub:
|
| Repository Name | Specify the name of the repository whose release is to be created on GitHub. |
| Tag Name | Specify the name of the tag to be associated with the release you want to create on GitHub. |
| Target Branch | Specifies the Commit hash value that determines from where the Git tag is created. By default, this is set to the default branch of the repository (usually master). |
| Release Title | Specify the name of the release you want to create on the specified repository on GitHub. |
| Release Description | Specify the contents of the tag associated with the release you want to create on the specified repository on GitHub. |
| Generate Release Notes | Select this option to automatically generate the "Release Title" and "Release Description" for this release. If the "Release Title" is specified, then the specified "Release Title" will be used; otherwise, a name will be automatically generated. If the "Release Description" is specified, the "Release Description" will be pre-pended to the automatically generated notes. |
The output contains the following populated JSON schema:
{
"url": "",
"html_url": "",
"assets_url": "",
"upload_url": "",
"tarball_url": "",
"zipball_url": "",
"discussion_url": "",
"id": "",
"node_id": "",
"tag_name": "",
"target_commitish": "",
"name": "",
"body": "",
"draft": "",
"prerelease": "",
"created_at": "",
"published_at": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assets": [
{
"url": "",
"browser_download_url": "",
"id": "",
"node_id": "",
"name": "",
"label": "",
"state": "",
"content_type": "",
"size": "",
"download_count": "",
"created_at": "",
"updated_at": "",
"uploader": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
}
]
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose releases are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose draft releases list you want to retrieve from GitHub. |
| Per Page | Specify the number of results, per page, that this operation should return. By default, this value is set as 30; and the maximum value you can specify for this parameter is 100. |
| Page | Specify the page number from which you want the operation to return the results of the operation. By default, this value is set as 1. |
The output contains the following populated JSON schema:
[
{
"url": "",
"html_url": "",
"assets_url": "",
"upload_url": "",
"tarball_url": "",
"zipball_url": "",
"id": "",
"node_id": "",
"tag_name": "",
"target_commitish": "",
"name": "",
"body": "",
"draft": "",
"prerelease": "",
"created_at": "",
"published_at": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assets": [
{
"url": "",
"browser_download_url": "",
"id": "",
"node_id": "",
"name": "",
"label": "",
"state": "",
"content_type": "",
"size": "",
"download_count": "",
"created_at": "",
"updated_at": "",
"uploader": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
}
]
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose stargazers are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose stargazers are to be retrieved from GitHub. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository to be starred on GitHub:
|
| Repository Name | Specify the name of the repository to be starred on GitHub. |
The output contains a non-dictionary value.
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose watchers are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose watchers are to be retrieved from GitHub. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose subscription is to be managed on GitHub:
|
| Repository Name | Specify the name of the repository whose subscription is to be managed. |
| Subscribed | Select this option to receive notifications from the specified repository. |
| Ignored | Select this option to block notifications from the specified repository. |
The output contains the following populated JSON schema:
{
"subscribed": "",
"ignored": "",
"reason": "",
"created_at": "",
"url": "",
"repository_url": ""
}
None.
The output contains the following populated JSON schema:
{
"server_url": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository whose file contents are to be retrieved from GitHub. You can choose from following options:
|
| Repository Name | Specify the name of the repository whose file contents are to be retrieved from GitHub. |
| File Name | Specify the name or path of the file whose contents are to be retrieved from GitHub. For example, directory/file.txt |
| Branch Name | (Optional) Specify the branch name from where to retrieve the file contents on GitHub. |
| Decode Content | (Optional) Select to decode the file contents. The files are Base64 encoded. |
The output contains the following populated JSON schema:
{
"sha": "",
"url": "",
"name": "",
"path": "",
"size": "",
"type": "",
"_links": {
"git": "",
"html": "",
"self": ""
},
"content": "",
"git_url": "",
"encoding": "",
"html_url": "",
"download_url": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository on GitHub that contains the file to be deleted. You can choose from following options:
|
| Repository Name | Specify the name of the repository on GitHub whose file is to be deleted. |
| File Name | Specify the name or path of the file on GitHub that is to be deleted. For example, directory/file.txt |
| Commit Message | Specify the commit message to add for deleting the file from GitHub. |
| SHA | Specify the blob SHA of the file being deleted. |
| Branch Name | (Optional) Specify the branch name from which you want to delete the file on GitHub. By default, it deletes from the main branch. |
The output contains the following populated JSON schema:
{
"commit": {
"sha": "",
"url": "",
"tree": {
"sha": "",
"url": ""
},
"author": {
"date": "",
"name": "",
"email": ""
},
"message": "",
"node_id": "",
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
],
"html_url": "",
"committer": {
"date": "",
"name": "",
"email": ""
},
"verification": {
"reason": "",
"payload": "",
"verified": "",
"signature": ""
}
},
"content": ""
}
| Parameter | Description |
|---|---|
| Search Query | Specify the search query using which to filter results. For example: To find the definition of the addClass function inside a jQuery repository, use addClass+in:file+language:js+repo:jquery/jquery |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
{
"items": [
{
"sha": "",
"url": "",
"name": "",
"path": "",
"score": "",
"git_url": "",
"html_url": "",
"repository": {
"id": "",
"url": "",
"fork": "",
"name": "",
"owner": {
"id": "",
"url": "",
"type": "",
"login": "",
"node_id": "",
"html_url": "",
"gists_url": "",
"repos_url": "",
"avatar_url": "",
"events_url": "",
"site_admin": "",
"gravatar_id": "",
"starred_url": "",
"followers_url": "",
"following_url": "",
"organizations_url": "",
"subscriptions_url": "",
"received_events_url": ""
},
"node_id": "",
"private": "",
"html_url": "",
"keys_url": "",
"tags_url": "",
"blobs_url": "",
"forks_url": "",
"full_name": "",
"hooks_url": "",
"pulls_url": "",
"teams_url": "",
"trees_url": "",
"events_url": "",
"issues_url": "",
"labels_url": "",
"merges_url": "",
"archive_url": "",
"commits_url": "",
"compare_url": "",
"description": "",
"branches_url": "",
"comments_url": "",
"contents_url": "",
"git_refs_url": "",
"git_tags_url": "",
"releases_url": "",
"statuses_url": "",
"assignees_url": "",
"downloads_url": "",
"languages_url": "",
"milestones_url": "",
"stargazers_url": "",
"deployments_url": "",
"git_commits_url": "",
"subscribers_url": "",
"contributors_url": "",
"issue_events_url": "",
"subscription_url": "",
"collaborators_url": "",
"issue_comment_url": "",
"notifications_url": ""
}
}
],
"total_count": "",
"incomplete_results": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository whose repository details you want to retrieve. You can choose from the following options:
|
| Repository Name | Specify the name of the repository to retrieve its details. |
The output contains the following populated JSON schema:
{
"id": "",
"url": "",
"fork": "",
"name": "",
"size": "",
"forks": "",
"owner": {
"id": "",
"url": "",
"type": "",
"login": "",
"node_id": "",
"html_url": "",
"gists_url": "",
"repos_url": "",
"avatar_url": "",
"events_url": "",
"site_admin": "",
"gravatar_id": "",
"starred_url": "",
"followers_url": "",
"following_url": "",
"user_view_type": "",
"organizations_url": "",
"subscriptions_url": "",
"received_events_url": ""
},
"topics": [],
"git_url": "",
"license": "",
"node_id": "",
"private": "",
"ssh_url": "",
"svn_url": "",
"archived": "",
"disabled": "",
"has_wiki": "",
"homepage": "",
"html_url": "",
"keys_url": "",
"language": "",
"tags_url": "",
"watchers": "",
"blobs_url": "",
"clone_url": "",
"forks_url": "",
"full_name": "",
"has_pages": "",
"hooks_url": "",
"pulls_url": "",
"pushed_at": "",
"teams_url": "",
"trees_url": "",
"created_at": "",
"events_url": "",
"has_issues": "",
"issues_url": "",
"labels_url": "",
"merges_url": "",
"mirror_url": "",
"updated_at": "",
"visibility": "",
"archive_url": "",
"commits_url": "",
"compare_url": "",
"description": "",
"forks_count": "",
"is_template": "",
"open_issues": "",
"permissions": {
"pull": "",
"push": "",
"admin": "",
"triage": "",
"maintain": ""
},
"branches_url": "",
"comments_url": "",
"contents_url": "",
"git_refs_url": "",
"git_tags_url": "",
"has_projects": "",
"organization": {
"id": "",
"url": "",
"type": "",
"login": "",
"node_id": "",
"html_url": "",
"gists_url": "",
"repos_url": "",
"avatar_url": "",
"events_url": "",
"site_admin": "",
"gravatar_id": "",
"starred_url": "",
"followers_url": "",
"following_url": "",
"user_view_type": "",
"organizations_url": "",
"subscriptions_url": "",
"received_events_url": ""
},
"releases_url": "",
"statuses_url": "",
"allow_forking": "",
"assignees_url": "",
"downloads_url": "",
"has_downloads": "",
"languages_url": "",
"network_count": "",
"default_branch": "",
"milestones_url": "",
"stargazers_url": "",
"watchers_count": "",
"deployments_url": "",
"git_commits_url": "",
"has_discussions": "",
"subscribers_url": "",
"allow_auto_merge": "",
"contributors_url": "",
"issue_events_url": "",
"stargazers_count": "",
"subscription_url": "",
"temp_clone_token": "",
"collaborators_url": "",
"custom_properties": {},
"issue_comment_url": "",
"notifications_url": "",
"open_issues_count": "",
"subscribers_count": "",
"allow_merge_commit": "",
"allow_rebase_merge": "",
"allow_squash_merge": "",
"merge_commit_title": "",
"allow_update_branch": "",
"merge_commit_message": "",
"delete_branch_on_merge": "",
"squash_merge_commit_title": "",
"squash_merge_commit_message": "",
"web_commit_signoff_required": "",
"use_squash_pr_title_as_default": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository whose branch commit details are to be retrieved from GitHub. You can choose from the following options:
|
| Repository Name | Specify the name of the repository to retrieve its branch commit details from GitHub. |
| Reference | Specify the commit reference as commit SHA, branch name, or tag name. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. Default value is 30 and the maximum value is 100. |
| Page | (Optional) Specify the page number from which to return the results of the operation. Default value is 1. |
The output contains the following populated JSON schema:
{
"sha": "",
"node_id": "",
"commit": {
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "",
"tree": {
"sha": "",
"url": ""
},
"url": "",
"comment_count": "",
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": "",
"verified_at": ""
}
},
"url": "",
"html_url": "",
"comments_url": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"user_view_type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"user_view_type": "",
"site_admin": ""
},
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
],
"stats": {
"total": "",
"additions": "",
"deletions": ""
},
"files": [
{
"sha": "",
"filename": "",
"status": "",
"additions": "",
"deletions": "",
"changes": "",
"blob_url": "",
"raw_url": "",
"contents_url": "",
"patch": ""
}
]
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository whose commit details are to be compared on GitHub. You can choose from the following options:
|
| Repository Name | Specify the name of the repository to retrieve its commit comparison from GitHub. |
| Base | Specify the base branch name (BASE) from the same repository for comparison. You can also use the format USERNAME:BASE to reference a branch from a different repository for comparison. A base branch is the stable branch against which the new changes are compared and eventually merged. |
| Head | Specify the head branch name (HEAD) from the same repository for comparison. You can also use the format USERNAME:HEAD to reference a branch from a different repository for comparison. A head branch is the new branch which contains the changes to be compared and merged into the BASE branch. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. Default value is 30 and the maximum value is 100. |
| Page | (Optional) Specify the page number from which to return the results of the operation. Default value is 1. |
The output contains the following populated JSON schema:
{
"url": "",
"html_url": "",
"permalink_url": "",
"diff_url": "",
"patch_url": "",
"base_commit": {
"sha": "",
"node_id": "",
"commit": {
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "",
"tree": {
"sha": "",
"url": ""
},
"url": "",
"comment_count": "",
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": "",
"verified_at": ""
}
},
"url": "",
"html_url": "",
"comments_url": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
]
},
"merge_base_commit": {
"sha": "",
"node_id": "",
"commit": {
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "",
"tree": {
"sha": "",
"url": ""
},
"url": "",
"comment_count": "",
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": "",
"verified_at": ""
}
},
"url": "",
"html_url": "",
"comments_url": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
]
},
"status": "",
"ahead_by": "",
"behind_by": "",
"total_commits": "",
"commits": [
{
"sha": "",
"node_id": "",
"commit": {
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "New PB",
"tree": {
"sha": "",
"url": ""
},
"url": "",
"comment_count": 0,
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": "",
"verified_at": ""
}
},
"url": "",
"html_url": "",
"comments_url": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
]
}
],
"files": [
{
"sha": "",
"filename": "",
"status": "",
"additions": "",
"deletions": "",
"changes": "",
"blob_url": "",
"raw_url": "",
"contents_url": "",
"patch": ""
}
]
}
The Sample - GitHub - 2.1.0 playbook collection comes bundled with the GitHub connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the GitHub connector.
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.
NOTE: To use GitHub as a source control platform, all its associated playbooks must be in an active state.
The Sample - GitHub - 2.1.0 playbook collection contains pluggable source control that are used to perform actions through the Continuous Delivery solution pack. The pluggable source control playbooks are in the format: GitHub - playbookName. For example, GitHub - Create Repository.
Every playbook expects two input parameters:
connector_config_id which is used in connector actions' Configuration parameter.NOTE: To use GitHub as a source control platform, following playbooks must be in an active state.
| Playbook Name | Parameter Name | Dictionary | Required Tag | Additional Information |
|---|---|---|---|---|
| GitHub - Add Pull Request Review | add_pr_review_params |
{ "org_name": "", "repo_name": "", "pull_number": "", "state": "" }
|
GitHub-AddPullRequestReview | Not Required |
| GitHub - Update Issue | update_issue_params |
{ "org_name":"", "repo_name":"", "issue_no":"", "contents":"", "state":"" }
|
GitHub-UpdateIssue | Not Required |
| GitHub - Create Issue | create_issue_params |
{ "org_name":"", "repo_name":"", "issue_title":"", "issue_content":"", "issue_assignee":" " }
|
GitHub-CreateIssue | Not Required |
| GitHub - List Repository Issue | list_repo_issues_params |
{ "org_name":"", "repo_name":"", "state":"", "created_after":"" }
|
GitHub-ListRepositoryIssue | The last step of this playbook should be Set Variable, where user must map the response of the List Repository Issue action with the following keys:
{"id": "", "html_url": "", "number": "", "title": "", "body": "", "reporterUsername": "", "assigneeUsername": "", "state": "", "repository_url": "" }
|
| GitHub - Create Issue Comment | add_issue_comment_params |
{ "org_name":"", "repo_name":"", "cr_number":"", "commit_message":"" }
|
GitHub-CreateIssueComment | Not Required |
| GitHub - Create Repository | create_repo_params |
{ "org_name":"", "repo_name":" " }
|
GitHub-CreateRepository | Create Repository step should be set to Ignore Error Yes |
| GitHub - Create Branch | create_branch_params |
{ "org_name":"", "repo_name":"", "new_branch":"", "branch_name":"" }
|
GitHub-CreateBranch | Create Branch step should be set Ignore Error Yes |
| GitHub - List Pull Request | list_pr_params |
{ "org_name": "", "repo_name": "", "state": "", "pull_number": "", }
|
GitHub-ListPullRequest | The last step of this playbook should be Set Variable, where user must add key reviewer_names in the response of List Pull Request action and return the result. |
| GitHub - Create Release | create_release_params |
{ "org_name":"", "repo_name":"", "tag_name":"", "base_branch":"", "release_description":"" }
|
GitHub-CreateRelease | Not Required |
| GitHub - Delete Branch | delete_branch_params |
{ "org_name":"", "repo_name":"", "branch_name":"" }
|
GitHub-DeleteBranch | Not Required |
| GitHub - Fetch Release | fetch_release_params |
{ "org_name":"", "repo_name":"", "release_name":"" }
|
GitHub-FetchRelease | The last step of the playbook should be Set Variable step where user should return the release matching the release_name key from input. |
| GitHub - Add Reviewers for a Pull Request | add_reviewers_for_pr_params |
{ "org_name":"", "repo_name":"", "pull_number":"", "reviewers":"" }
|
GitHub-PullRequestAddReviewers | Not Required |
| GitHub - List Pull Request Reviews | list_pr_reviews_params |
{ "org_name":"", "repo_name":"", "pull_number":"" }
|
GitHub-ListPullRequestReviews | Not Required |
| GitHub - Create Pull Request | create_pr_params |
{ "org_name":"", "repo_name":"", "head_repo":"", "base_branch":"", "pr_title":"", "pr_comments":"" }
|
GitHub-CreatePullRequest | Set Ignore Error flag to the step Create Pull Request to handle the scenario where if pull request is already created, the Create Pull Request action fails. |
| GitHub - Merge Pull Request | merge_pr_params |
{ "org_name":"", "repo_name":"", "pull_number":"" }
|
GitHub-MergePullRequest | Not Required |
| GitHub - List Repository Collaborator | list_repo_collaborator_params |
{ "org_name":"", "repo_name":"" }
|
GitHub-ListRepositoryCollaborator | Not Required |
| GitHub - Add Repository Collaborator | add_repo_collaborator_params |
{ "org_name":"", "repo_name":"", "username":"" }
|
GitHub-AddRepositoryCollaborator | Not Required |
| GitHub - Clone Repository | clone_repo_params |
{ "org_name":"", "repo_name":"", "branch_name":"", "clone_as_zip":"" }
|
GitHub-CloneRepository | Not Required |
| GitHub - Get Server URL | Not Required | Not Required | GitHub-GetServerURL | Not Required |
| GitHub - Update Remote Repository | update_remote_repo_params |
{"file_iri": "", "clone_path": ""}
|
GitHub-UpdateRemoteRepository | Not Required |
| GitHub - Push Changes | push_changes_params |
{
"org_name": "",
"repo_name": "",
"repo_type": "",
"branch_name": "",
"commit_message": "",
"cloned_repo_path": "",
"commit_description": ""
}
|
GitHub-PushChanges | Not Required |
| GitHub - Create or Update File Content | create_update_file_content_params |
{
"org_name": "",
"file_name": "",
"repo_name": "",
"branch_name": "",
"file_content": "",
"commit_message": ""
}
|
GitHub-CreateUpdateFileContent | Not Required |
GitHub is a code hosting platform for collaboration and version control. This connector facilitates automated interactions with Github for actions such as creating and managing repositories, branches, issues, pull requests, and many more.
This document provides information about the GitHub Connector, which facilitates automated interactions, with a GitHub server using FortiSOAR™ playbooks. Add the GitHub Connector as a step in FortiSOAR™ playbooks and perform automated operations with GitHub.
Connector Version: 2.1.0
FortiSOAR™ Version Tested on: 7.6.3-5574
GitHub Version Tested on: 2022-11-28
GitHub Enterprise Server Tested on: 3.15
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the GitHub connector in version 2.1.0:
Added three new actions
Updated the action clone_repository to improve code quality, reliability, and maintainability
Updated the action push_repository for a feature-complete, safer, and cleaner implementation that adds robust GitHub repo synchronization, supports deletion of remote files, and improves developer experience through better logging, path handling, and error management.
Added the following new pluggable source control actions in sample collection
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command as a root user to install the connector:
yum install cyops-connector-github
For managing user access to your organization's repositories and repository roles, refer to https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the GitHub connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:
| Parameter | Description |
|---|---|
| GitHub Account | Select the option used to access the GitHub server to connect and perform the automated operations. You can choose from the following options:
|
| Username | Specify the username used to access the GitHub server to connect and perform the automated operations. |
| Personal Access Token | Specify the Personal Access Token used to access the GitHub server to connect and perform the automated operations. For more information, refer https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens. |
| Verify SSL | Specifies whether the SSL certificate for the server is to be verified. By default, this option is selected, i.e., set to true. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations:
| Function | Description | Annotation and Category |
|---|---|---|
| Create Repository | Creates a new organization or an authenticated user repository based on the repository type, organization or repository owner's name, and other input parameters you have specified | create_repository Investigation |
| Create Repository Using Template | Creates a new repository using a template based on the template owner, template repository name, new repository name, and other input parameters you have specified | create_repository_using_template Investigation |
| List Organization Repositories | Lists all the repositories of an organization based on the organization name, repository type, sort criteria, sort order, and other input parameters you have specified | list_organization_repositories Investigation |
| List User Repositories | Lists public repositories for the specified user based on the username, repository type, sort criteria, sort order, and other input parameters you have specified | list_user_repositories Investigation |
| List Authenticated User Repositories | Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access based on the authenticated user's affiliation, repository type, sort criteria, sort order, and other input parameters you have specified | list_authenticated_user_repositories Investigation |
| Update Repository | Updates an organization's or an authenticated user's repository based on the old repository name, new repository name, and other input parameters you have specified | update_repository Investigation |
| Delete Repository | Deletes an organization's or an authenticated user's repository from GitHub based on the repository type, organization or repository owner's name, and other input parameters you have specified | delete_repository Investigation |
| Fork Organization Repository | Forks an organization's or an account owner's repository based on the repository owner's name, repository name, and other input parameters you have specified | fork_organization_repository Investigation |
| List Fork Repositories | Lists the repositories that have been forked for the specified organization based on the repository owner name, repository name, repository sort type, and other input parameters you have specified | list_fork_repositories Investigation |
| Create or Update File Contents | Creates a new file or replaces an existing file in a repository based on the repository type, organization or repository owner's name, file name, commit message, file contents, and other input parameters you have specified | create_update_file_contents Investigation |
| Add Repository Collaborator | Updates a personal repository of a specified user to add a collaborator for the repository based on the repository owner name, repository name, collaborator username, and other input parameters you have specified | add_repository_collaborator Investigation |
| List Repository Collaborator | Lists the collaborator details for specified repository based on the repository owner name, repository name, and other input parameters you have specified | list_repository_collaborator Investigation |
| Get Branch Revision | Retrieves branch revision details of the specified branch in GitHub based on the repository type, organization or repository owner's name, base branch name, and other input parameters you have specified | get_branch_revision Investigation |
| Create Branch | Creates a new branch in GitHub based on the repository type, organization or repository owner's name, new branch name, base branch name or SHA, and other input parameters you have specified | create_branch Investigation |
| Merge Branch | Merges a specified branch to the base branch in GitHub based on the repository owner name, repository name, base branch name, head branch name, and other input parameters you have specified | merge_branch Investigation |
| List Branches | Lists branches of the specified repository based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_branches Investigation |
| Delete Branch | Delete a new branch in GitHub based on the repository type, organization or repository owner's name, repository name, branch name, and other input parameters you have specified | delete_branch Investigation |
| Fetch Upstream | Synchronizes a branch of a forked repository to keep it up-to-date with the upstream repository based on the repository owner's name, repository name, branch name, and other input parameters you have specified | fetch_upstream Investigation |
| Clone Repository | Clones the specified repository in GitHub based on the repository type, organization or repository owner's name, repository name, specify if you want the repository as a .zipfile, and other input parameters you have specified | clone_repository Investigation |
| Update Remote Repository | Applies changes made in a FortiSOAR file to the specified remote repository that is cloned from GitHub based on the file IRI and cloned repository path you have specified | update_clone_repository Investigation |
| Push Changes | Commits the local repository changes to the specified repository in GitHub based on the repository type, organization or repository owner's name, repository name, cloned repository path, and other input parameters you have specified | push_repository Investigation |
| Create Pull Request | Creates a pull request for the specified repository on GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | create_pull_request Investigation |
| List Pull Request | Lists pull requests for the specified repository on GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_pull_request Investigation |
| Add Reviewers for a Pull Request | Adds reviewers for the specified pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified. Pull request authors, repository owners, and collaborators can request a review of the pull request from anyone with write access to the repository. Each requested reviewer receives a notification asking them to review the pull request | add_reviewers Investigation |
| List Review Comments on a Pull Request | Lists the review comments associated with the specified pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified | list_review_comments Investigation |
| List Pull Request Reviews | Lists the reviews associated with the specified pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified | list_pr_reviews Investigation |
| Add Pull Request Review | Adds a review for a pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified | submit_pr_review Investigation |
| Merge Pull Request | Merges the specified pull request on GitHub based on the repository type, organization or repository owner's name, repository name, pull request number, and other input parameters you have specified | merge_pull_request Investigation |
| Create Issue | Creates an issue for the specified repository or user on GitHub based on the repository type, organization, or repository owner's name, repository name, title, and other input parameters you have specified | create_issue Investigation |
| List Repository Issue | List issues for the specified repository or user on GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_repository_issue Investigation |
| Update Issue | Update issues for the specified repository or user on GitHub based on the repository type, organization or repository owner's name, repository name, update number, and other input parameters you have specified | update_issue Investigation |
| Create Issue Comment | Creates an issue comment for the specified repository or user on GitHub based on the repository type, organization, or repository owner's name, repository name, and other input parameters you have specified | create_issue_comment Investigation |
| Create Release | Creates a release for the specified repository on GitHub based on the repository type, organization or repository owner's name, repository name, tag name, and other input parameters you have specified | create_release Investigation |
| List Releases | Returns a list of releases that does not include regular GitHub tags associated with a release. Information about published releases is available to everyone. Only users with push access will receive listings for draft releases. The list of releases is retrieved from GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_releases Investigation |
| List Stargazers | Lists the people that have marked the specified repository in GitHub with a star based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_stargazers Investigation |
| Star Repository | Stars the specified repository for the authenticated user in GitHub based on the repository type, organization or repository owner's name, repository name, and repository owner you have specified | star_repository Investigation |
| List Watchers | Lists the people that are watching the specified repository in GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | list_watchers Investigation |
| Set Repository Subscription | Sets the subscription to the specified repository in GitHub based on the repository type, organization or repository owner's name, repository name, and other input parameters you have specified | set_repo_subscription Investigation |
| Get Server URL | Retrieves the server URL (Web URL) of the configured GitHub server. | get_web_url Investigation |
| Get File | Retrieves information such as name, size, and content about a file from the GitHub repository based on the repository type, repository name, and other input parameters that you have specified. | get_file_from_repository Investigation |
| Delete File | Deletes a file from the GitHub repository based on the repository type, repository name, and other input parameters that you have specified. | delete_file_from_repository Investigation |
| Search Code | Searches the code based on the query that you have specified. | search_code Investigation |
| Get Repository | Retrieves an organization's or an authenticated user's repository based on the repository name and the organization or repository owner's name that you have specified. | get_repository Investigation |
| Get Commit | Retrieves the contents of a single commit reference based on the repository type, repository name, commit reference, and other input parameters that you have specified. The commit reference can be a commit SHA, branch name, or tag name. | get_commit Investigation |
| Get Commit Comparison | Retrieves a comparison of two commits against each other based on the repository type, repository name, base branch name, head branch name, and other input parameters that you have specified. You can compare commit SHAs within the same repository, or across repositories within the same network (such as forks). This allows you to view changes between commits, including commits made on forked branches. | compare_commit Investigation |
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository in which to create the repository on GitHub:
|
| Repository Name | Specify the name of the repository you want to create on GitHub |
| Description | Specify a short description of the repository you want to create on GitHub |
| Homepage | Specify the homepage of the repository you want to create on GitHub. A Homepage is a URL that contains more information about the repository |
| Private | Select this option to create a Private repository on GitHub. Clear this option to create a Public repository on GitHub |
| Has Issues | Select this option to enable issues for the repository you want to create on GitHub. Clear this option to disable issues for the repository you want to create on GitHub |
| Has Projects | Select this option to enable projects for the repository you want to create on GitHub. Clear this option to disable projects for the repository you want to create on GitHub |
| Has Wiki | Select this option to enable the wiki for the repository you want to create on GitHub; this is the default. Clear this option to disable the wiki for the repository you want to create on GitHub |
| Is Template | Select this option to make the repository you are creating available as a template repository on GitHub. Clear this option to prevent the repository you are creating from being available as a template repository on GitHub |
| Other Fields | Specify fields in the JSON format to be used as Search criteria (used to determine dynamic membership) fields or as link fields |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": "",
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": "",
"permissions": {
"admin": "",
"maintain": "",
"push": "",
"triage": "",
"pull": ""
},
"allow_squash_merge": "",
"allow_merge_commit": "",
"allow_rebase_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_update_branch": "",
"network_count": "",
"subscribers_count": ""
}
| Parameter | Description |
|---|---|
| Template Owner | Specify the name of the template owner of the repository you want to create on GitHub |
| Template Repository | Specify the name of the template repository using which you want to create this repository on GitHub |
| New Repository Name | Specify the name of the repository you want to create on GitHub |
| New Repository Owner | Specify the name of the organization or person who will own the new repository |
| Description | Specify a short description of the repository you want to create on GitHub |
| Include All Branches | Select this option to include the directory structure and files from all branches in the template repository and not just the default branch |
| Private | Select this option to create a private repository on GitHub. By default, this option is cleared and hence creates a public repository on GitHub |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"forks": "",
"stargazers_count": "",
"watchers_count": "",
"watchers": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"open_issues": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"allow_rebase_merge": "",
"allow_auto_merge": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
}
}
| Parameter | Description |
|---|---|
| Organization Name | Specify the name of the organization whose list of repositories you want to retrieve from GitHub. |
| Repository Type | Select the type of repository you want to retrieve from GitHub. The repository type limits the results to the repositories you have selected. You can select from the following options:
|
| Sort | Select the property to sort the results returned by this operation. You can select from the following options:
|
| Direction | Select the property to sort the direction of the results returned by this operation. You can select from the following options:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"template_repository": ""
}
]
| Parameter | Description |
|---|---|
| Username | Specify the username of the GitHub account whose repositories you want to retrieve from GitHub. |
| Repository Type | Select the type of repository you want to retrieve from GitHub. The repository type limits the results to the repositories you have selected. You can select from the following options:
|
| Sort | Select the property to sort the results returned by this operation. You can select from the following options:
|
| Direction | Select the property to sort the direction of the results returned by this operation. You can select from the following options:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": "",
"permissions": {
"admin": "",
"maintain": "",
"push": "",
"triage": "",
"pull": ""
}
}
]
| Parameter | Description |
|---|---|
| Visibility | (Optional) Select from the following options to specify the visibility of the repositories to be fetched.
|
| Affiliation | Specify a comma-separated list of values from the following options:
|
| Repository Type | Select the type of repository you want to retrieve from GitHub. The repository type limits the results to the repositories you have selected. You can select from the following options:
|
| Sort | Select the property to sort the results returned by this operation. You can select from the following options:
|
| Direction | Select the property to sort the direction of the results returned by this operation. You can select from the following options:
|
| Updated After | Specify the start date and time of the duration in which the notifications, to be displayed, were updated |
| Updated Before | Specify the end date and time of the duration in which the notifications, to be displayed, were updated |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"allow_rebase_merge": "",
"template_repository": "",
"temp_clone_token": "",
"allow_squash_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_merge_commit": "",
"subscribers_count": "",
"network_count": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
},
"forks": "",
"open_issues": "",
"watchers": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the method from the following options using which you want to create the repository on GitHub:
|
| Old Repository Name | Specify the name of the repository that you want to update on GitHub. |
| New Repository Name | Specify the new name of the repository to update on GitHub. |
| Description | (Optional) Specify a short description of the repository you want to create on GitHub. |
| Homepage | (Optional) Specify the homepage of the repository you want to create on GitHub. A Homepage is a URL that contains more information about the repository. |
| Private | (Optional) Select this option to create a Private repository on GitHub. Clear this option (default) to create a Public repository on GitHub. |
| Has Issues | (Optional) Select this option (default) to enable issues for the repository you want to create on GitHub. Clear this option to disable issues for the repository you want to create on GitHub. |
| Has Projects | (Optional) Select this option to enable projects for the repository you want to create on GitHub. Clear this option to disable projects for the repository you want to create on GitHub. |
| Has Wiki | (Optional) Select this option to enable the wiki for the repository you want to create on GitHub; this is the default. Clear this option to disable the wiki for the repository you want to create on GitHub. |
| Other Fields | (Optional) Specify fields in the JSON format to be used as Search criteria (used to determine dynamic membership) fields or as link fields. |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": "",
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": "",
"permissions": {
"admin": "",
"maintain": "",
"push": "",
"triage": "",
"pull": ""
},
"allow_squash_merge": "",
"allow_merge_commit": "",
"allow_rebase_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_update_branch": "",
"network_count": "",
"subscribers_count": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository to delete from GitHub:
|
| Repository Name | Specify the name of the repository that you want to delete from GitHub. |
The output contains a non-dictionary value.
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose fork is to be created:
|
| Repository Name | Specify the name of the repository you want to fork in GitHub. |
| Organization Name | (Optional) Specify the name of the organization whose repository you want to fork in GitHub. |
| New Fork Name | Specify a new name for the fork, when forking from an existing repository. |
| Default Branch | Select this option to fork an existing repository's default branch only from GitHub. |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
},
"language": "",
"forks_count": "",
"forks": "",
"stargazers_count": "",
"watchers_count": "",
"watchers": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"open_issues": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"pull": "",
"push": "",
"admin": ""
},
"allow_rebase_merge": "",
"template_repository": {},
"temp_clone_token": "",
"allow_squash_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_merge_commit": "",
"allow_forking": "",
"subscribers_count": "",
"network_count": "",
"organization": {},
"parent": {},
"source": {}
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose forks are to be listed:
|
| Repository Name | Specify the name of the repository whose list of forked repositories you want to retrieve from GitHub. |
| Sort Repository By | Select the property to sort the results returned by this operation, from the following options:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"template_repository": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose file contents are to be updated on GitHub:
|
| Repository Name | Specify the name of the repository whose file contents are to be created or updated, on GitHub. |
| File Name | Specify the name of the file whose file contents are to be created or updated, on GitHub. |
| Commit Message | Specify the commit message that you want to add while creating/updating the content file on GitHub. |
| File Content | Specify the file content that you want to create or update on GitHub. |
| Branch Name | (Optional) Specify the branch name where you want to add the content file on GitHub. |
| SHA | (Optional) Specify the blob SHA of the file being replaced. Required if you are updating a file. |
The output contains the following populated JSON schema:
{
"content": {
"name": "",
"path": "",
"sha": "",
"size": "",
"url": "",
"html_url": "",
"git_url": "",
"download_url": "",
"type": "",
"_links": {
"self": "",
"git": "",
"html": ""
}
},
"commit": {
"sha": "",
"node_id": "",
"url": "",
"html_url": "",
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"tree": {
"sha": "",
"url": ""
},
"message": "",
"parents": [],
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": ""
}
}
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type from the following options:
|
| Repository Owner | Specify the account holder of the repository on GitHub in which you want to add the specified collaborator. |
| Repository Name | Specify the name of the repository on GitHub in which you want to add the specified collaborator. |
| Collaborator Username | Specify the handle for the GitHub user account that you want to add as a collaborator for the specified repository on GitHub. |
| Permission | (Optional) Select the permission that you want to grant to the specified collaborator. Permissions are valid only on organization-owned repositories. You can select from the following options:
|
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"repository": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"hooks_url": ""
},
"invitee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"inviter": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"permissions": "",
"created_at": "",
"url": "",
"html_url": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type from the following options:
|
| Repository Owner | Specify the account holder of the repository on GitHub in which you want to add the specified collaborator. |
| Repository Name | Specify the name of the repository on GitHub in which you want to add the specified collaborator. |
| Collaborator Affiliation | Select the affiliation, from the following options, to filter the repository collaborators:
|
| Permission | Select the permissions granted, from the following options, to filter the repository collaborators:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": "",
"permissions": {
"admin": "",
"maintain": "",
"push": "",
"triage": "",
"pull": ""
},
"role_name": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose branch revision details are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose branch revision details you want to retrieve from GitHub. |
| Base Branch | Specify the name of the branch whose branch revision details you want to retrieve from GitHub. |
The output contains the following populated JSON schema:
{
"ref": "",
"node_id": "",
"url": "",
"object": {
"sha": "",
"type": "",
"url": ""
}
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository where the branch is to be created on GitHub:
|
| Repository Name | Specify the name of the repository for which you want to create a branch on GitHub. |
| New Branch Name | Specify the name of the branch you want to create on GitHub. |
| Base Branch Name/SHA | Select from the following options to create a new branch from the base branch on GitHub.
|
The output contains the following populated JSON schema:
{
"ref": "",
"node_id": "",
"url": "",
"object": {
"sha": "",
"type": "",
"url": ""
}
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose repository branch is to be merged on GitHub:
|
| Repository Name | Specify the name of the repository that you want to merge with the base branch in GitHub. |
| Base Branch Name | Specify the name of the base branch to which you want to merge the specified head in GitHub. |
| Head | Specify the head that you want to merge to the base branch in GitHub. This can be a branch name or a commit SHA1. |
| Commit Message | (Optional) Specify the commit message to be used for the merge and commit action. If you do not specify any commit message, a default commit message is used. |
The output contains the following populated JSON schema:
{
"url": "",
"sha": "",
"node_id": "",
"html_url": "",
"comments_url": "",
"commit": {
"url": "",
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "",
"tree": {
"url": "",
"sha": ""
},
"comment_count": "",
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": ""
}
},
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"parents": [
{
"url": "",
"sha": ""
}
],
"stats": {
"additions": "",
"deletions": "",
"total": ""
},
"files": [
{
"filename": "",
"additions": "",
"deletions": "",
"changes": "",
"status": "",
"raw_url": "",
"blob_url": "",
"patch": ""
}
]
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose repository branches are to be listed on GitHub:
|
| Repository Name | Specify the name of the repository whose list of branches you want to retrieve from GitHub. |
| Protected | Select this option to return only protected branches from GitHub. Clear this option to return only unprotected branches from GitHub. Omit this parameter, i.e., set it to null, to return all branches from GitHub. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"name": "",
"commit": {
"sha": "",
"url": ""
},
"protected": "",
"protection": {
"enabled": "",
"required_status_checks": {
"enforcement_level": "",
"contexts": [],
"checks": []
}
},
"protection_url": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose branch is to be deleted from GitHub:
|
| Repository Name | Specify the name of the repository whose branch is to be deleted from GitHub. |
| Branch Name | Specify the name of the branch you want to delete on GitHub. |
The output contains a non-dictionary value.
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository with which to synchronize the fork:
|
| Repository Name | Specify the name of the repository with which you want to synchronize the specified branch. |
| Branch Name | Specify the name of the branch that should be updated to match the specified upstream repository. |
The output contains the following populated JSON schema:
{
"message": "",
"merge_type": "",
"base_branch": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository to be cloned on GitHub:
|
| Repository Name | Specify the name of the repository to be cloned on GitHub |
| Branch Name | Specify the name of the repository's branch to cloned. |
| Clone As ZIP | Select this option to clone the specified repository as a zip file |
The output contains the following populated JSON schema:
{
"path": ""
}
| Parameter | Description |
|---|---|
| FortiSOAR File IRI | Specify the FortiSOAR file IRI whose changes you want to replace in the specified local repository. |
| Cloned Repository Path | Specify the path of the cloned repository to which you want to apply the changes of the specified FortiSOAR file. |
The output contains a non-dictionary value.
| Parameter | Description |
|---|---|
| Repository Type | Select a repository type from the following options in which to push the changes on GitHub:
|
| Repository Name | Specify the name of the repository whose changes you want to push on GitHub. |
| Cloned Repository Path | Specify the path of the cloned repository whose changes you want to push on GitHub. |
| Branch Name | Specify the name of the branch to which you want to push the code of the local repository. |
| Commit Summary | Specify a summary of the commit being pushed to GitHub. |
| Commit Description | Specify a description of the commit being pushed to GitHub. |
The output contains the following populated JSON schema:
{
"status": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository in which to create a pull request on GitHub:
|
| Repository Name | Specify the name of the repository on which you want to create a pull request on GitHub. |
| Head Repository | Specify the name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch. |
| Base Branch | Specify the name of the branch to which you want to pull the changes. The branch to which you want to pull the changes should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. |
| Pull Request Title | Specify the title of the new pull request that you want to create on GitHub. |
| Pull Request Comments | Specify the contents of the new pull request that you want to create on GitHub. |
| Allow Edits By Maintainers | Select this option to allow maintainers to modify the pull request. |
| Draft | Select this option to create the pull request as a 'Draft'. |
The output contains the following populated JSON schema:
{
"url": "",
"id": "",
"node_id": "",
"html_url": "",
"diff_url": "",
"patch_url": "",
"issue_url": "",
"number": "",
"state": "",
"locked": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"merged_at": "",
"merge_commit_sha": "",
"assignee": "",
"assignees": [],
"requested_reviewers": [],
"requested_teams": [],
"labels": [],
"milestone": "",
"draft": "",
"commits_url": "",
"review_comments_url": "",
"review_comment_url": "",
"comments_url": "",
"statuses_url": "",
"head": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"base": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"issue": {
"href": ""
},
"comments": {
"href": ""
},
"review_comments": {
"href": ""
},
"review_comment": {
"href": ""
},
"commits": {
"href": ""
},
"statuses": {
"href": ""
}
},
"author_association": "",
"auto_merge": "",
"active_lock_reason": "",
"merged": "",
"mergeable": "",
"rebaseable": "",
"mergeable_state": "",
"merged_by": "",
"comments": "",
"review_comments": "",
"maintainer_can_modify": "",
"commits": "",
"additions": "",
"deletions": "",
"changed_files": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose, pull requests are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose pull requests are to be retrieved from GitHub. |
| Pull Number | (Optional) Specify the number that identifies the pull request. |
| State | (Optional) Select the state of the pull requests whose details you want to retrieve from GitHub. The state parameter filters the results returned by this operation to only pull requests that match the selected state. You can select from following options:
|
| Head Repository | (Optional) Specify the head user or head organization and branch name in the format of user:ref-name or organization:ref-name to filter the results returned by this operation to only pull requests that match the specified head repository. |
| Base Branch | (Optional) Specify the name of the base branch name to filter the results returned by this operation to only pull requests that match the specified base branch name. |
| Sort | (Optional) Select the property to sort the results returned by this operation. You can select from the following options:
|
| Direction | (Optional) Select the property to sort the direction of the results returned by this operation. You can select from the following options:
|
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
Output schema when the Pull Number is not specified:
[
{
"url": "",
"id": "",
"node_id": "",
"html_url": "",
"diff_url": "",
"patch_url": "",
"issue_url": "",
"number": "",
"state": "",
"locked": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"merged_at": "",
"merge_commit_sha": "",
"assignee": "",
"assignees": [],
"requested_reviewers": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"requested_teams": [],
"labels": [],
"milestone": "",
"draft": "",
"commits_url": "",
"review_comments_url": "",
"review_comment_url": "",
"comments_url": "",
"statuses_url": "",
"head": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"base": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"issue": {
"href": ""
},
"comments": {
"href": ""
},
"review_comments": {
"href": ""
},
"review_comment": {
"href": ""
},
"commits": {
"href": ""
},
"statuses": {
"href": ""
}
},
"author_association": "",
"auto_merge": "",
"active_lock_reason": ""
}
]
Output schema when the Pull Number IS specified:
{
"url": "",
"id": "",
"node_id": "",
"html_url": "",
"diff_url": "",
"patch_url": "",
"issue_url": "",
"number": "",
"state": "",
"locked": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"merged_at": "",
"merge_commit_sha": "",
"assignee": "",
"assignees": [],
"requested_reviewers": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"requested_teams": [],
"labels": [],
"milestone": "",
"draft": "",
"commits_url": "",
"review_comments_url": "",
"review_comment_url": "",
"comments_url": "",
"statuses_url": "",
"head": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"base": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"private": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"html_url": "",
"description": "",
"fork": "",
"url": "",
"forks_url": "",
"keys_url": "",
"collaborators_url": "",
"teams_url": "",
"hooks_url": "",
"issue_events_url": "",
"events_url": "",
"assignees_url": "",
"branches_url": "",
"tags_url": "",
"blobs_url": "",
"git_tags_url": "",
"git_refs_url": "",
"trees_url": "",
"statuses_url": "",
"languages_url": "",
"stargazers_url": "",
"contributors_url": "",
"subscribers_url": "",
"subscription_url": "",
"commits_url": "",
"git_commits_url": "",
"comments_url": "",
"issue_comment_url": "",
"contents_url": "",
"compare_url": "",
"merges_url": "",
"archive_url": "",
"downloads_url": "",
"issues_url": "",
"pulls_url": "",
"milestones_url": "",
"notifications_url": "",
"labels_url": "",
"releases_url": "",
"deployments_url": "",
"created_at": "",
"updated_at": "",
"pushed_at": "",
"git_url": "",
"ssh_url": "",
"clone_url": "",
"svn_url": "",
"homepage": "",
"size": "",
"stargazers_count": "",
"watchers_count": "",
"language": "",
"has_issues": "",
"has_projects": "",
"has_downloads": "",
"has_wiki": "",
"has_pages": "",
"forks_count": "",
"mirror_url": "",
"archived": "",
"disabled": "",
"open_issues_count": "",
"license": {
"key": "",
"name": "",
"spdx_id": "",
"url": "",
"node_id": ""
},
"allow_forking": "",
"is_template": "",
"topics": [],
"visibility": "",
"forks": "",
"open_issues": "",
"watchers": "",
"default_branch": ""
}
},
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"issue": {
"href": ""
},
"comments": {
"href": ""
},
"review_comments": {
"href": ""
},
"review_comment": {
"href": ""
},
"commits": {
"href": ""
},
"statuses": {
"href": ""
}
},
"author_association": "",
"auto_merge": "",
"active_lock_reason": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository where reviewers for a PR are to be added on GitHub:
|
| Repository Name | Specify the name of the repository in which you want to add reviewers for the specified pull request in GitHub. |
| Pull Number | Specify the number that identifies the pull request to which you want to add reviewers. |
| Reviewers | (Optional) Specify the comma-separated list of user names that you want to add as reviewers of the specified repository. |
| Team Reviewers | (Optional) Specify the comma-separated list of team names that you want to add as reviewers of the specified repository. |
The output contains the following populated JSON schema:
{
"url": "",
"id": "",
"node_id": "",
"html_url": "",
"diff_url": "",
"patch_url": "",
"issue_url": "",
"commits_url": "",
"review_comments_url": "",
"review_comment_url": "",
"comments_url": "",
"statuses_url": "",
"number": "",
"state": "",
"locked": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"labels": [
{
"id": "",
"node_id": "",
"url": "",
"name": "",
"description": "",
"color": "",
"default": ""
}
],
"milestone": {
"url": "",
"html_url": "",
"labels_url": "",
"id": "",
"node_id": "",
"number": "",
"state": "",
"title": "",
"description": "",
"creator": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"open_issues": "",
"closed_issues": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"due_on": ""
},
"active_lock_reason": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"merged_at": "",
"merge_commit_sha": "",
"assignee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assignees": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"requested_reviewers": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"requested_teams": [
{
"id": "",
"node_id": "",
"url": "",
"html_url": "",
"name": "",
"slug": "",
"description": "",
"privacy": "",
"permission": "",
"members_url": "",
"repositories_url": "",
"parent": ""
}
],
"head": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"allow_rebase_merge": "",
"template_repository": "",
"temp_clone_token": "",
"allow_squash_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_merge_commit": "",
"subscribers_count": "",
"network_count": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
},
"forks": "",
"open_issues": "",
"watchers": ""
}
},
"base": {
"label": "",
"ref": "",
"sha": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"repo": {
"id": "",
"node_id": "",
"name": "",
"full_name": "",
"owner": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"private": "",
"html_url": "",
"description": "",
"fork": "",
"url": "",
"archive_url": "",
"assignees_url": "",
"blobs_url": "",
"branches_url": "",
"collaborators_url": "",
"comments_url": "",
"commits_url": "",
"compare_url": "",
"contents_url": "",
"contributors_url": "",
"deployments_url": "",
"downloads_url": "",
"events_url": "",
"forks_url": "",
"git_commits_url": "",
"git_refs_url": "",
"git_tags_url": "",
"git_url": "",
"issue_comment_url": "",
"issue_events_url": "",
"issues_url": "",
"keys_url": "",
"labels_url": "",
"languages_url": "",
"merges_url": "",
"milestones_url": "",
"notifications_url": "",
"pulls_url": "",
"releases_url": "",
"ssh_url": "",
"stargazers_url": "",
"statuses_url": "",
"subscribers_url": "",
"subscription_url": "",
"tags_url": "",
"teams_url": "",
"trees_url": "",
"clone_url": "",
"mirror_url": "",
"hooks_url": "",
"svn_url": "",
"homepage": "",
"language": "",
"forks_count": "",
"stargazers_count": "",
"watchers_count": "",
"size": "",
"default_branch": "",
"open_issues_count": "",
"is_template": "",
"topics": [],
"has_issues": "",
"has_projects": "",
"has_wiki": "",
"has_pages": "",
"has_downloads": "",
"archived": "",
"disabled": "",
"visibility": "",
"pushed_at": "",
"created_at": "",
"updated_at": "",
"permissions": {
"admin": "",
"push": "",
"pull": ""
},
"allow_rebase_merge": "",
"template_repository": "",
"temp_clone_token": "",
"allow_squash_merge": "",
"allow_auto_merge": "",
"delete_branch_on_merge": "",
"allow_merge_commit": "",
"subscribers_count": "",
"network_count": "",
"license": {
"key": "",
"name": "",
"url": "",
"spdx_id": "",
"node_id": "",
"html_url": ""
},
"forks": "",
"open_issues": "",
"watchers": ""
}
},
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"issue": {
"href": ""
},
"comments": {
"href": ""
},
"review_comments": {
"href": ""
},
"review_comment": {
"href": ""
},
"commits": {
"href": ""
},
"statuses": {
"href": ""
}
},
"author_association": "",
"auto_merge": "",
"draft": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose PR review comments are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose PR review comments are to be retrieved from GitHub. |
| Pull Number | Specify the number that identifies the pull request whose associated comments you want to retrieve from GitHub. |
| Sort | Select the property to sort the results returned by this operation. You can select from following options:
|
| Direction | Select the direction to sort the results returned by this operation. You can select from following options:
NOTE:If you do not specify the Sort parameter then this parameter is ignored. |
The output contains the following populated JSON schema:
[
{
"url": "",
"pull_request_review_id": "",
"id": "",
"node_id": "",
"diff_hunk": "",
"path": "",
"position": "",
"original_position": "",
"commit_id": "",
"original_commit_id": "",
"in_reply_to_id": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"created_at": "",
"updated_at": "",
"html_url": "",
"pull_request_url": "",
"author_association": "",
"_links": {
"self": {
"href": ""
},
"html": {
"href": ""
},
"pull_request": {
"href": ""
}
},
"start_line": "",
"original_start_line": "",
"start_side": "",
"line": "",
"original_line": "",
"side": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose, pull request reviews are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose pull request reviews are to be retrieved from GitHub. |
| Pull Number | Specify the number that identifies the pull request whose associated reviews you want to retrieve from GitHub. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"id": "",
"node_id": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"state": "",
"html_url": "",
"pull_request_url": "",
"author_association": "",
"_links": {
"html": {
"href": ""
},
"pull_request": {
"href": ""
}
},
"submitted_at": "",
"commit_id": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository where the pull request review is to be added on GitHub:
|
| Repository Name | Specify the name of the repository where the pull request review is to be added on GitHub. |
| Pull Number | Specify the number that identifies the pull request whose review you want to submit to GitHub. |
| Commit ID | Specify the SHA of the commit that needs a review. |
| Review Comment | Specify the body of the pull request review whose review you want to submit to GitHub. Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review. |
| Review Action | Select the review action of the pull request whose review you want to submit to GitHub. |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"body": "",
"state": "",
"html_url": "",
"pull_request_url": "",
"author_association": "",
"_links": {
"html": {
"href": ""
},
"pull_request": {
"href": ""
}
},
"submitted_at": "",
"commit_id": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose, pull requests are to be merged on GitHub:
|
| Repository Name | Specify the name of the repository whose pull requests are to be merged in GitHub. |
| Pull Number | Specify the number that identifies the pull request that you want to merge with the specified repository in GitHub. |
| Commit Title | Specify the title of the automatic commit message to be used for the merge and commit action. If you do not specify any commit title, a default title is used. |
| Commit Message | Specify the contents of the automatic commit message to be used for the merge and commit action. |
| SHA | Value of the SHA that the pull request head must match to allow merging with the specified repository. |
| Merge Method | Select the method for merging the specified pull request with the specified repository. You can select from following options:
|
The output contains the following populated JSON schema:
{
"sha": "",
"merged": "",
"message": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository where the issue is to be created from GitHub:
|
| Repository Name | Specify the name of the repository where the issue is to be created in GitHub. |
| Title | Specify the title of the issue which you want to create in GitHub. |
| Contents | Specify the contents of the issue which you want to create in GitHub. |
| Assignees | Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. |
| Milestone | Specify the number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise. |
| Labels | Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise. |
The output contains the following populated JSON schema:
{
"url": "",
"repository_url": "",
"labels_url": "",
"comments_url": "",
"events_url": "",
"html_url": "",
"id": "",
"node_id": "",
"number": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"labels": [
{
"id": "",
"node_id": "",
"url": "",
"name": "",
"color": "",
"default": "",
"description": ""
}
],
"state": "",
"locked": "",
"assignee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assignees": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"milestone": "",
"comments": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"author_association": "",
"active_lock_reason": "",
"body": "",
"closed_by": "",
"reactions": {
"url": "",
"total_count": "",
"+1": "",
"-1": "",
"laugh": "",
"hooray": "",
"confused": "",
"heart": "",
"rocket": "",
"eyes": ""
},
"timeline_url": "",
"performed_via_github_app": "",
"state_reason": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose issues are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose issues are to be retrieved in GitHub. |
| Milestone | Specify a value for the milestone. If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned. |
| State | Select the type of state of issue you want to retrieve from GitHub. You can select from following options:
|
| Assignee | Specify the name of the user. Pass none for issues with no assigned user, and * for issues assigned to any user. |
| Creator | Specify the user that created the issue. |
| Mentioned | Specify a user mentioned in the issue. |
| Labels | Specify a list of comma-separated label names. Example: bug,ui,@high. |
| Sort | Select the property to sort the results returned by this operation. You can select from following options:
|
| Direction | Select the property to sort the direction of the results returned by this operation. You can select from following options:
|
| Since | (Optional) Specify the start date and time of the duration in which the notifications to be displayed was updated. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"url": "",
"repository_url": "",
"labels_url": "",
"comments_url": "",
"events_url": "",
"html_url": "",
"id": "",
"node_id": "",
"number": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"labels": [
{
"id": "",
"node_id": "",
"url": "",
"name": "",
"color": "",
"default": "",
"description": ""
}
],
"state": "",
"locked": "",
"assignee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assignees": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"milestone": "",
"comments": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"author_association": "",
"active_lock_reason": "",
"body": "",
"reactions": {
"url": "",
"total_count": "",
"+1": "",
"-1": "",
"laugh": "",
"hooray": "",
"confused": "",
"heart": "",
"rocket": "",
"eyes": ""
},
"timeline_url": "",
"performed_via_github_app": "",
"state_reason": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose issues are to be updated on GitHub:
|
| Repository Name | Specify the name of the repository whose issues are to be updated on GitHub. |
| Issue Number | Specify the issue number of the repository whose issues are to be updated on GitHub. |
| Title | Specify the title of the issue which you want to update on GitHub. |
| Contents | Specify the contents of the issue which you want to update on GitHub. |
| State | Select the type of state of issue you want to update on GitHub. You can from following options:
|
| State Reason | Select the type of state reason for the current state of the issue you want to update in GitHub. You can select from following options:
|
| Milestone | Specify the number of the milestone to associate this issue with or null to remove the current. |
| Labels | Specify labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. |
| Assignees | Specify logins for users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. |
The output contains the following populated JSON schema:
{
"url": "",
"repository_url": "",
"labels_url": "",
"comments_url": "",
"events_url": "",
"html_url": "",
"id": "",
"node_id": "",
"number": "",
"title": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"labels": [
{
"id": "",
"node_id": "",
"url": "",
"name": "",
"color": "",
"default": "",
"description": ""
}
],
"state": "",
"locked": "",
"assignee": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assignees": [
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
],
"milestone": "",
"comments": "",
"created_at": "",
"updated_at": "",
"closed_at": "",
"author_association": "",
"active_lock_reason": "",
"body": "",
"closed_by": "",
"reactions": {
"url": "",
"total_count": "",
"+1": "",
"-1": "",
"laugh": "",
"hooray": "",
"confused": "",
"heart": "",
"rocket": "",
"eyes": ""
},
"timeline_url": "",
"performed_via_github_app": "",
"state_reason": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository in which to create an issue on GitHub:
|
| Repository Name | Specify the name of the repository whose issue comment you want to create in GitHub |
| Issue Number | Specify the issue number of the repository whose issue comment you want to create in GitHub |
| Comment | Specify the comment contents of the issue comment which you want to create in GitHub |
The output contains the following populated JSON schema:
{
"id": "",
"node_id": "",
"url": "",
"html_url": "",
"body": "",
"user": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"created_at": "",
"updated_at": "",
"issue_url": "",
"author_association": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose release is to be created on GitHub:
|
| Repository Name | Specify the name of the repository whose release is to be created on GitHub. |
| Tag Name | Specify the name of the tag to be associated with the release you want to create on GitHub. |
| Target Branch | Specifies the Commit hash value that determines from where the Git tag is created. By default, this is set to the default branch of the repository (usually master). |
| Release Title | Specify the name of the release you want to create on the specified repository on GitHub. |
| Release Description | Specify the contents of the tag associated with the release you want to create on the specified repository on GitHub. |
| Generate Release Notes | Select this option to automatically generate the "Release Title" and "Release Description" for this release. If the "Release Title" is specified, then the specified "Release Title" will be used; otherwise, a name will be automatically generated. If the "Release Description" is specified, the "Release Description" will be pre-pended to the automatically generated notes. |
The output contains the following populated JSON schema:
{
"url": "",
"html_url": "",
"assets_url": "",
"upload_url": "",
"tarball_url": "",
"zipball_url": "",
"discussion_url": "",
"id": "",
"node_id": "",
"tag_name": "",
"target_commitish": "",
"name": "",
"body": "",
"draft": "",
"prerelease": "",
"created_at": "",
"published_at": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assets": [
{
"url": "",
"browser_download_url": "",
"id": "",
"node_id": "",
"name": "",
"label": "",
"state": "",
"content_type": "",
"size": "",
"download_count": "",
"created_at": "",
"updated_at": "",
"uploader": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
}
]
}
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose releases are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose draft releases list you want to retrieve from GitHub. |
| Per Page | Specify the number of results, per page, that this operation should return. By default, this value is set as 30; and the maximum value you can specify for this parameter is 100. |
| Page | Specify the page number from which you want the operation to return the results of the operation. By default, this value is set as 1. |
The output contains the following populated JSON schema:
[
{
"url": "",
"html_url": "",
"assets_url": "",
"upload_url": "",
"tarball_url": "",
"zipball_url": "",
"id": "",
"node_id": "",
"tag_name": "",
"target_commitish": "",
"name": "",
"body": "",
"draft": "",
"prerelease": "",
"created_at": "",
"published_at": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
},
"assets": [
{
"url": "",
"browser_download_url": "",
"id": "",
"node_id": "",
"name": "",
"label": "",
"state": "",
"content_type": "",
"size": "",
"download_count": "",
"created_at": "",
"updated_at": "",
"uploader": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
}
]
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose stargazers are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose stargazers are to be retrieved from GitHub. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository to be starred on GitHub:
|
| Repository Name | Specify the name of the repository to be starred on GitHub. |
The output contains a non-dictionary value.
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose watchers are to be retrieved from GitHub:
|
| Repository Name | Specify the name of the repository whose watchers are to be retrieved from GitHub. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which you want the operation to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
[
{
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"site_admin": ""
}
]
| Parameter | Description |
|---|---|
| Repository Type | Select the repository type, from the following options, of the repository whose subscription is to be managed on GitHub:
|
| Repository Name | Specify the name of the repository whose subscription is to be managed. |
| Subscribed | Select this option to receive notifications from the specified repository. |
| Ignored | Select this option to block notifications from the specified repository. |
The output contains the following populated JSON schema:
{
"subscribed": "",
"ignored": "",
"reason": "",
"created_at": "",
"url": "",
"repository_url": ""
}
None.
The output contains the following populated JSON schema:
{
"server_url": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository whose file contents are to be retrieved from GitHub. You can choose from following options:
|
| Repository Name | Specify the name of the repository whose file contents are to be retrieved from GitHub. |
| File Name | Specify the name or path of the file whose contents are to be retrieved from GitHub. For example, directory/file.txt |
| Branch Name | (Optional) Specify the branch name from where to retrieve the file contents on GitHub. |
| Decode Content | (Optional) Select to decode the file contents. The files are Base64 encoded. |
The output contains the following populated JSON schema:
{
"sha": "",
"url": "",
"name": "",
"path": "",
"size": "",
"type": "",
"_links": {
"git": "",
"html": "",
"self": ""
},
"content": "",
"git_url": "",
"encoding": "",
"html_url": "",
"download_url": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository on GitHub that contains the file to be deleted. You can choose from following options:
|
| Repository Name | Specify the name of the repository on GitHub whose file is to be deleted. |
| File Name | Specify the name or path of the file on GitHub that is to be deleted. For example, directory/file.txt |
| Commit Message | Specify the commit message to add for deleting the file from GitHub. |
| SHA | Specify the blob SHA of the file being deleted. |
| Branch Name | (Optional) Specify the branch name from which you want to delete the file on GitHub. By default, it deletes from the main branch. |
The output contains the following populated JSON schema:
{
"commit": {
"sha": "",
"url": "",
"tree": {
"sha": "",
"url": ""
},
"author": {
"date": "",
"name": "",
"email": ""
},
"message": "",
"node_id": "",
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
],
"html_url": "",
"committer": {
"date": "",
"name": "",
"email": ""
},
"verification": {
"reason": "",
"payload": "",
"verified": "",
"signature": ""
}
},
"content": ""
}
| Parameter | Description |
|---|---|
| Search Query | Specify the search query using which to filter results. For example: To find the definition of the addClass function inside a jQuery repository, use addClass+in:file+language:js+repo:jquery/jquery |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. By default, this value is set to 30; and the maximum value you can specify for this parameter is 100. |
| Page | (Optional) Specify the page number from which to return the results of the operation. By default, this value is set to 1. |
The output contains the following populated JSON schema:
{
"items": [
{
"sha": "",
"url": "",
"name": "",
"path": "",
"score": "",
"git_url": "",
"html_url": "",
"repository": {
"id": "",
"url": "",
"fork": "",
"name": "",
"owner": {
"id": "",
"url": "",
"type": "",
"login": "",
"node_id": "",
"html_url": "",
"gists_url": "",
"repos_url": "",
"avatar_url": "",
"events_url": "",
"site_admin": "",
"gravatar_id": "",
"starred_url": "",
"followers_url": "",
"following_url": "",
"organizations_url": "",
"subscriptions_url": "",
"received_events_url": ""
},
"node_id": "",
"private": "",
"html_url": "",
"keys_url": "",
"tags_url": "",
"blobs_url": "",
"forks_url": "",
"full_name": "",
"hooks_url": "",
"pulls_url": "",
"teams_url": "",
"trees_url": "",
"events_url": "",
"issues_url": "",
"labels_url": "",
"merges_url": "",
"archive_url": "",
"commits_url": "",
"compare_url": "",
"description": "",
"branches_url": "",
"comments_url": "",
"contents_url": "",
"git_refs_url": "",
"git_tags_url": "",
"releases_url": "",
"statuses_url": "",
"assignees_url": "",
"downloads_url": "",
"languages_url": "",
"milestones_url": "",
"stargazers_url": "",
"deployments_url": "",
"git_commits_url": "",
"subscribers_url": "",
"contributors_url": "",
"issue_events_url": "",
"subscription_url": "",
"collaborators_url": "",
"issue_comment_url": "",
"notifications_url": ""
}
}
],
"total_count": "",
"incomplete_results": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository whose repository details you want to retrieve. You can choose from the following options:
|
| Repository Name | Specify the name of the repository to retrieve its details. |
The output contains the following populated JSON schema:
{
"id": "",
"url": "",
"fork": "",
"name": "",
"size": "",
"forks": "",
"owner": {
"id": "",
"url": "",
"type": "",
"login": "",
"node_id": "",
"html_url": "",
"gists_url": "",
"repos_url": "",
"avatar_url": "",
"events_url": "",
"site_admin": "",
"gravatar_id": "",
"starred_url": "",
"followers_url": "",
"following_url": "",
"user_view_type": "",
"organizations_url": "",
"subscriptions_url": "",
"received_events_url": ""
},
"topics": [],
"git_url": "",
"license": "",
"node_id": "",
"private": "",
"ssh_url": "",
"svn_url": "",
"archived": "",
"disabled": "",
"has_wiki": "",
"homepage": "",
"html_url": "",
"keys_url": "",
"language": "",
"tags_url": "",
"watchers": "",
"blobs_url": "",
"clone_url": "",
"forks_url": "",
"full_name": "",
"has_pages": "",
"hooks_url": "",
"pulls_url": "",
"pushed_at": "",
"teams_url": "",
"trees_url": "",
"created_at": "",
"events_url": "",
"has_issues": "",
"issues_url": "",
"labels_url": "",
"merges_url": "",
"mirror_url": "",
"updated_at": "",
"visibility": "",
"archive_url": "",
"commits_url": "",
"compare_url": "",
"description": "",
"forks_count": "",
"is_template": "",
"open_issues": "",
"permissions": {
"pull": "",
"push": "",
"admin": "",
"triage": "",
"maintain": ""
},
"branches_url": "",
"comments_url": "",
"contents_url": "",
"git_refs_url": "",
"git_tags_url": "",
"has_projects": "",
"organization": {
"id": "",
"url": "",
"type": "",
"login": "",
"node_id": "",
"html_url": "",
"gists_url": "",
"repos_url": "",
"avatar_url": "",
"events_url": "",
"site_admin": "",
"gravatar_id": "",
"starred_url": "",
"followers_url": "",
"following_url": "",
"user_view_type": "",
"organizations_url": "",
"subscriptions_url": "",
"received_events_url": ""
},
"releases_url": "",
"statuses_url": "",
"allow_forking": "",
"assignees_url": "",
"downloads_url": "",
"has_downloads": "",
"languages_url": "",
"network_count": "",
"default_branch": "",
"milestones_url": "",
"stargazers_url": "",
"watchers_count": "",
"deployments_url": "",
"git_commits_url": "",
"has_discussions": "",
"subscribers_url": "",
"allow_auto_merge": "",
"contributors_url": "",
"issue_events_url": "",
"stargazers_count": "",
"subscription_url": "",
"temp_clone_token": "",
"collaborators_url": "",
"custom_properties": {},
"issue_comment_url": "",
"notifications_url": "",
"open_issues_count": "",
"subscribers_count": "",
"allow_merge_commit": "",
"allow_rebase_merge": "",
"allow_squash_merge": "",
"merge_commit_title": "",
"allow_update_branch": "",
"merge_commit_message": "",
"delete_branch_on_merge": "",
"squash_merge_commit_title": "",
"squash_merge_commit_message": "",
"web_commit_signoff_required": "",
"use_squash_pr_title_as_default": ""
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository whose branch commit details are to be retrieved from GitHub. You can choose from the following options:
|
| Repository Name | Specify the name of the repository to retrieve its branch commit details from GitHub. |
| Reference | Specify the commit reference as commit SHA, branch name, or tag name. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. Default value is 30 and the maximum value is 100. |
| Page | (Optional) Specify the page number from which to return the results of the operation. Default value is 1. |
The output contains the following populated JSON schema:
{
"sha": "",
"node_id": "",
"commit": {
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "",
"tree": {
"sha": "",
"url": ""
},
"url": "",
"comment_count": "",
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": "",
"verified_at": ""
}
},
"url": "",
"html_url": "",
"comments_url": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"user_view_type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"user_view_type": "",
"site_admin": ""
},
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
],
"stats": {
"total": "",
"additions": "",
"deletions": ""
},
"files": [
{
"sha": "",
"filename": "",
"status": "",
"additions": "",
"deletions": "",
"changes": "",
"blob_url": "",
"raw_url": "",
"contents_url": "",
"patch": ""
}
]
}
| Parameter | Description |
|---|---|
| Repository Type | Select the type of the repository whose commit details are to be compared on GitHub. You can choose from the following options:
|
| Repository Name | Specify the name of the repository to retrieve its commit comparison from GitHub. |
| Base | Specify the base branch name (BASE) from the same repository for comparison. You can also use the format USERNAME:BASE to reference a branch from a different repository for comparison. A base branch is the stable branch against which the new changes are compared and eventually merged. |
| Head | Specify the head branch name (HEAD) from the same repository for comparison. You can also use the format USERNAME:HEAD to reference a branch from a different repository for comparison. A head branch is the new branch which contains the changes to be compared and merged into the BASE branch. |
| Per Page | (Optional) Specify the number of results, per page, that this operation should return. Default value is 30 and the maximum value is 100. |
| Page | (Optional) Specify the page number from which to return the results of the operation. Default value is 1. |
The output contains the following populated JSON schema:
{
"url": "",
"html_url": "",
"permalink_url": "",
"diff_url": "",
"patch_url": "",
"base_commit": {
"sha": "",
"node_id": "",
"commit": {
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "",
"tree": {
"sha": "",
"url": ""
},
"url": "",
"comment_count": "",
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": "",
"verified_at": ""
}
},
"url": "",
"html_url": "",
"comments_url": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
]
},
"merge_base_commit": {
"sha": "",
"node_id": "",
"commit": {
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "",
"tree": {
"sha": "",
"url": ""
},
"url": "",
"comment_count": "",
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": "",
"verified_at": ""
}
},
"url": "",
"html_url": "",
"comments_url": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
]
},
"status": "",
"ahead_by": "",
"behind_by": "",
"total_commits": "",
"commits": [
{
"sha": "",
"node_id": "",
"commit": {
"author": {
"name": "",
"email": "",
"date": ""
},
"committer": {
"name": "",
"email": "",
"date": ""
},
"message": "New PB",
"tree": {
"sha": "",
"url": ""
},
"url": "",
"comment_count": 0,
"verification": {
"verified": "",
"reason": "",
"signature": "",
"payload": "",
"verified_at": ""
}
},
"url": "",
"html_url": "",
"comments_url": "",
"author": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"committer": {
"login": "",
"id": "",
"node_id": "",
"avatar_url": "",
"gravatar_id": "",
"url": "",
"html_url": "",
"followers_url": "",
"following_url": "",
"gists_url": "",
"starred_url": "",
"subscriptions_url": "",
"organizations_url": "",
"repos_url": "",
"events_url": "",
"received_events_url": "",
"type": "",
"_view_type": "",
"site_admin": ""
},
"parents": [
{
"sha": "",
"url": "",
"html_url": ""
}
]
}
],
"files": [
{
"sha": "",
"filename": "",
"status": "",
"additions": "",
"deletions": "",
"changes": "",
"blob_url": "",
"raw_url": "",
"contents_url": "",
"patch": ""
}
]
}
The Sample - GitHub - 2.1.0 playbook collection comes bundled with the GitHub connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the GitHub connector.
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.
NOTE: To use GitHub as a source control platform, all its associated playbooks must be in an active state.
The Sample - GitHub - 2.1.0 playbook collection contains pluggable source control that are used to perform actions through the Continuous Delivery solution pack. The pluggable source control playbooks are in the format: GitHub - playbookName. For example, GitHub - Create Repository.
Every playbook expects two input parameters:
connector_config_id which is used in connector actions' Configuration parameter.NOTE: To use GitHub as a source control platform, following playbooks must be in an active state.
| Playbook Name | Parameter Name | Dictionary | Required Tag | Additional Information |
|---|---|---|---|---|
| GitHub - Add Pull Request Review | add_pr_review_params |
{ "org_name": "", "repo_name": "", "pull_number": "", "state": "" }
|
GitHub-AddPullRequestReview | Not Required |
| GitHub - Update Issue | update_issue_params |
{ "org_name":"", "repo_name":"", "issue_no":"", "contents":"", "state":"" }
|
GitHub-UpdateIssue | Not Required |
| GitHub - Create Issue | create_issue_params |
{ "org_name":"", "repo_name":"", "issue_title":"", "issue_content":"", "issue_assignee":" " }
|
GitHub-CreateIssue | Not Required |
| GitHub - List Repository Issue | list_repo_issues_params |
{ "org_name":"", "repo_name":"", "state":"", "created_after":"" }
|
GitHub-ListRepositoryIssue | The last step of this playbook should be Set Variable, where user must map the response of the List Repository Issue action with the following keys:
{"id": "", "html_url": "", "number": "", "title": "", "body": "", "reporterUsername": "", "assigneeUsername": "", "state": "", "repository_url": "" }
|
| GitHub - Create Issue Comment | add_issue_comment_params |
{ "org_name":"", "repo_name":"", "cr_number":"", "commit_message":"" }
|
GitHub-CreateIssueComment | Not Required |
| GitHub - Create Repository | create_repo_params |
{ "org_name":"", "repo_name":" " }
|
GitHub-CreateRepository | Create Repository step should be set to Ignore Error Yes |
| GitHub - Create Branch | create_branch_params |
{ "org_name":"", "repo_name":"", "new_branch":"", "branch_name":"" }
|
GitHub-CreateBranch | Create Branch step should be set Ignore Error Yes |
| GitHub - List Pull Request | list_pr_params |
{ "org_name": "", "repo_name": "", "state": "", "pull_number": "", }
|
GitHub-ListPullRequest | The last step of this playbook should be Set Variable, where user must add key reviewer_names in the response of List Pull Request action and return the result. |
| GitHub - Create Release | create_release_params |
{ "org_name":"", "repo_name":"", "tag_name":"", "base_branch":"", "release_description":"" }
|
GitHub-CreateRelease | Not Required |
| GitHub - Delete Branch | delete_branch_params |
{ "org_name":"", "repo_name":"", "branch_name":"" }
|
GitHub-DeleteBranch | Not Required |
| GitHub - Fetch Release | fetch_release_params |
{ "org_name":"", "repo_name":"", "release_name":"" }
|
GitHub-FetchRelease | The last step of the playbook should be Set Variable step where user should return the release matching the release_name key from input. |
| GitHub - Add Reviewers for a Pull Request | add_reviewers_for_pr_params |
{ "org_name":"", "repo_name":"", "pull_number":"", "reviewers":"" }
|
GitHub-PullRequestAddReviewers | Not Required |
| GitHub - List Pull Request Reviews | list_pr_reviews_params |
{ "org_name":"", "repo_name":"", "pull_number":"" }
|
GitHub-ListPullRequestReviews | Not Required |
| GitHub - Create Pull Request | create_pr_params |
{ "org_name":"", "repo_name":"", "head_repo":"", "base_branch":"", "pr_title":"", "pr_comments":"" }
|
GitHub-CreatePullRequest | Set Ignore Error flag to the step Create Pull Request to handle the scenario where if pull request is already created, the Create Pull Request action fails. |
| GitHub - Merge Pull Request | merge_pr_params |
{ "org_name":"", "repo_name":"", "pull_number":"" }
|
GitHub-MergePullRequest | Not Required |
| GitHub - List Repository Collaborator | list_repo_collaborator_params |
{ "org_name":"", "repo_name":"" }
|
GitHub-ListRepositoryCollaborator | Not Required |
| GitHub - Add Repository Collaborator | add_repo_collaborator_params |
{ "org_name":"", "repo_name":"", "username":"" }
|
GitHub-AddRepositoryCollaborator | Not Required |
| GitHub - Clone Repository | clone_repo_params |
{ "org_name":"", "repo_name":"", "branch_name":"", "clone_as_zip":"" }
|
GitHub-CloneRepository | Not Required |
| GitHub - Get Server URL | Not Required | Not Required | GitHub-GetServerURL | Not Required |
| GitHub - Update Remote Repository | update_remote_repo_params |
{"file_iri": "", "clone_path": ""}
|
GitHub-UpdateRemoteRepository | Not Required |
| GitHub - Push Changes | push_changes_params |
{
"org_name": "",
"repo_name": "",
"repo_type": "",
"branch_name": "",
"commit_message": "",
"cloned_repo_path": "",
"commit_description": ""
}
|
GitHub-PushChanges | Not Required |
| GitHub - Create or Update File Content | create_update_file_content_params |
{
"org_name": "",
"file_name": "",
"repo_name": "",
"branch_name": "",
"file_content": "",
"commit_message": ""
}
|
GitHub-CreateUpdateFileContent | Not Required |