Jenkins - Set Gihub Oauth plugin parameters via groovy script - #jenkins #groovy #github #oauth

jenkins-set-github-oauth-plugin.groovy

#!groovy

// imports
import hudson.security.AuthorizationStrategy
import hudson.security.SecurityRealm
import jenkins.model.Jenkins
import org.jenkinsci.plugins.GithubAuthorizationStrategy
import org.jenkinsci.plugins.GithubSecurityRealm

// parameters
def githubSecurityRealmParameters = [
  clientID:     '12345678901234567890',
  clientSecret: '1234567890123456789012345678901234567890',
  githubApiUri: 'https://api.github.com',
  githubWebUri: 'https://github.com',
  oauthScopes:  'read:org'
]

def githubAuthorizationStrategyParameters = [
  adminUserNames:                         'my-admin, myself', // admin User Names
  allowAnonymousJobStatusPermission:      false,              // grant ViewStatus permissions for Anonymous Users
  allowAnonymousReadPermission:           false,              // grant READ permissions for Anonymous Users
  allowCcTrayPermission:                  false,              // grant READ permissions for /cc.xml
  allowGithubWebHookPermission:           false,              // grant READ permissions for /github-webhook
  authenticatedUserCreateJobPermission:   false,              // grant CREATE Job permissions to all Authenticated Users
  authenticatedUserReadPermission:        false,              // grant READ permissions to all Authenticated Users
  organizationNames:                      'my-company',       // participant in Organization
  useRepositoryPermissions:               true                // use Github repository permissions
]

// https://github.com/jenkinsci/github-oauth-plugin/blob/github-oauth-0.28.1/src/main/java/org/jenkinsci/plugins/GithubSecurityRealm.java
SecurityRealm githubSecurityRealm = new GithubSecurityRealm(
  githubSecurityRealmParameters.githubWebUri,
  githubSecurityRealmParameters.githubApiUri,
  githubSecurityRealmParameters.clientID,
  githubSecurityRealmParameters.clientSecret,
  githubSecurityRealmParameters.oauthScopes
)

// https://github.com/jenkinsci/github-oauth-plugin/blob/github-oauth-0.28.1/src/main/java/org/jenkinsci/plugins/GithubAuthorizationStrategy.java
AuthorizationStrategy githubAuthorizationStrategy = new GithubAuthorizationStrategy(
  githubAuthorizationStrategyParameters.adminUserNames,
  githubAuthorizationStrategyParameters.authenticatedUserReadPermission,
  githubAuthorizationStrategyParameters.useRepositoryPermissions,
  githubAuthorizationStrategyParameters.authenticatedUserCreateJobPermission,
  githubAuthorizationStrategyParameters.organizationNames,
  githubAuthorizationStrategyParameters.allowGithubWebHookPermission,
  githubAuthorizationStrategyParameters.allowCcTrayPermission,
  githubAuthorizationStrategyParameters.allowAnonymousReadPermission,
  githubAuthorizationStrategyParameters.allowAnonymousJobStatusPermission
)

// get Jenkins instance
Jenkins jenkins = Jenkins.getInstance()

// add configuration to Jenkins
jenkins.setSecurityRealm(githubSecurityRealm)
jenkins.setAuthorizationStrategy(githubAuthorizationStrategy)

// save current Jenkins state to disk
jenkins.save()