Module: Octokit::Client::Organizations

Included in:
Octokit::Client
Defined in:
lib/octokit/client/organizations.rb

Overview

Methods for the Organizations API

See Also:

Instance Method Summary collapse

Instance Method Details

#add_team_member(team_id, user, options = {}) ⇒ Boolean

Add team member

Requires authenticated organization owner or member with team admin permission.

Examples:

@client.add_team_member(100000, 'pengwynn')
# Opt-in to future behavior for this endpoint. Adds the member to the
# team if they're already an org member. If not, the method will return
# 422 and indicate the user should call the new Team Membership endpoint.
@client.add_team_member \
  100000,
  'pengwynn',
  :accept => "application/vnd.github.the-wasp-preview+json"

Parameters:

  • team_id (Integer) —

    Team id.

  • user (String) —

    GitHub username of new team member.

Returns:

  • (Boolean) —

    True on successful addition, false otherwise.

See Also:


442
443
444
445
446
447
 
# File 'lib/octokit/client/organizations.rb', line 442

def add_team_member(team_id, user, options = {})
  # There's a bug in this API call. The docs say to leave the body blank,
  # but it fails if the body is both blank and the content-length header
  # is not 0.
  boolean_from_response :put, "teams/#{team_id}/members/#{user}", options.merge({ name: user })
end

#add_team_membership(team_id, user, options = {}) ⇒ Sawyer::Resource

Add or invite a user to a team

Examples:

Check if a user has a membership for a team

@client.add_team_membership(1234, 'pengwynn')

Parameters:

  • team_id (Integer) —

    Team id.

  • user (String) —

    GitHub username of the user to invite.

Returns:

  • (Sawyer::Resource) —

    Hash of team membership info

See Also:


663
664
665
 
# File 'lib/octokit/client/organizations.rb', line 663

def add_team_membership(team_id, user, options = {})
  put "teams/#{team_id}/memberships/#{user}", options
end

#add_team_repository(team_id, repo, options = {}) ⇒ Boolean Also known as: add_team_repo

Add team repository

This can also be used to update the permission of an existing team

Requires authenticated user to be an owner of the organization that the team is associated with. Also, the repo must be owned by the organization, or a direct form of a repo owned by the organization.

Examples:

@client.add_team_repository(100000, 'github/developer.github.com')
@client.add_team_repo(100000, 'github/developer.github.com')

Add a team with admin permissions

@client.add_team_repository(100000, 'github/developer.github.com', permission: 'admin')

Parameters:

  • team_id (Integer) —

    Team id.

  • repo (String, Hash, Repository) —

    A GitHub repository.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :permission (String) —

    The permission to grant the team. Only valid on organization-owned repositories. Can be one of: pull, push, or admin. If not specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

Returns:

  • (Boolean) —

    True if successful, false otherwise.

See Also:


554
555
556
 
# File 'lib/octokit/client/organizations.rb', line 554

def add_team_repository(team_id, repo, options = {})
  boolean_from_response :put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options
end

#all_organizations(options = {}) ⇒ Array<Sawyer::Resource> Also known as: all_orgs

List all GitHub organizations

This provides a list of every organization, in the order that they were created.

Organization that you’ve seen.

Parameters:

  • options (Hash) (defaults to: {}) —

    Optional options.

Options Hash (options):

  • :since (Integer) —

    The integer ID of the last

Returns:

  • (Array<Sawyer::Resource>) —

    List of GitHub organizations.

See Also:


100
101
102
 
# File 'lib/octokit/client/organizations.rb', line 100

def all_organizations(options = {})
  paginate 'organizations', options
end

#billing_actions(org) ⇒ Sawyer::Resource

Get GitHub Actions billing for an organization

Requires authenticated organization owner.

Examples:

@client.billing_actions('github')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

Returns:

  • (Sawyer::Resource) —

    Hash representing GitHub Actions billing for an organization.

See Also:


823
824
825
 
# File 'lib/octokit/client/organizations.rb', line 823

def billing_actions(org)
  get "#{Organization.path(org)}/settings/billing/actions"
end

#child_teams(team_id, options = {}) ⇒ Sawyer::Resource

List child teams

Requires authenticated organization member.

Examples:

@client.child_teams(100000, :accept => "application/vnd.github.hellcat-preview+json")

Parameters:

  • team_id (Integer) —

    Team id.

Returns:

  • (Sawyer::Resource) —

    Hash representing team.

See Also:


368
369
370
 
# File 'lib/octokit/client/organizations.rb', line 368

def child_teams(team_id, options = {})
  paginate "teams/#{team_id}/teams", options
end

#convert_to_outside_collaborator(org, user, options = {}) ⇒ Boolean

Converts an organization member to an outside collaborator

Requires authenticated organization members.

Examples:

@client.convert_to_outside_collaborator('github', 'lizzhale')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • user (String) —

    GitHub username to be removed as outside collaborator

Returns:

  • (Boolean) —

    Return true if outside collaborator removed from organization, false otherwise.

See Also:


268
269
270
 
# File 'lib/octokit/client/organizations.rb', line 268

def convert_to_outside_collaborator(org, user, options = {})
  boolean_from_response :put, "#{Organization.path org}/outside_collaborators/#{user}", options
end

#create_team(org, options = {}) ⇒ Sawyer::Resource

Create team

Requires authenticated organization owner.

Examples:

@client.create_team('github', {
  :name => 'Designers',
  :repo_names => ['github/dotfiles']
})

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :name (String) —

    Team name.

  • :repo_names (Array<String>) —

    Repositories for the team.

  • :maintainers (Array<String>) —

    Maintainers for the team.

  • :parent_team_id (Integer) —

    ID of a team to set as the parent team.

Returns:

  • (Sawyer::Resource) —

    Hash representing new team.

See Also:


304
305
306
307
308
309
 
# File 'lib/octokit/client/organizations.rb', line 304

def create_team(org, options = {})
  if options.key?(:permission)
    octokit_warn 'Deprecated: Passing :permission option to #create_team. Assign team repository permission by passing :permission to #add_team_repository instead.'
  end
  post "#{Organization.path org}/teams", options
end

#delete_migration_archive(org, id, options = {}) ⇒ Object

Deletes a previous migration archive.

Requires authenticated organization owner.

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • id (Integer) —

    ID number of the migration.

See Also:


797
798
799
 
# File 'lib/octokit/client/organizations.rb', line 797

def delete_migration_archive(org, id, options = {})
  delete "#{Organization.path(org)}/migrations/#{id}/archive", options
end

#delete_team(team_id, options = {}) ⇒ Boolean

Delete team

Requires authenticated organization owner.

Examples:

@client.delete_team(100000)

Parameters:

  • team_id (Integer) —

    Team id.

Returns:

  • (Boolean) —

    True if deletion successful, false otherwise.

See Also:


404
405
406
 
# File 'lib/octokit/client/organizations.rb', line 404

def delete_team(team_id, options = {})
  boolean_from_response :delete, "teams/#{team_id}", options
end

#migration_archive_url(org, id, options = {}) ⇒ Object

Fetches the URL to a migration archive.

Requires authenticated organization owner.

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • id (Integer) —

    ID number of the migration.

See Also:


783
784
785
786
787
788
 
# File 'lib/octokit/client/organizations.rb', line 783

def migration_archive_url(org, id, options = {})
  url = "#{Organization.path(org)}/migrations/#{id}/archive"

  response = client_without_redirects(options).get(url)
  response.headers['location']
end

#migration_status(org, id, options = {}) ⇒ Object

Fetches the status of a migration.

Requires authenticated organization owner.

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • id (Integer) —

    ID number of the migration.

See Also:


772
773
774
 
# File 'lib/octokit/client/organizations.rb', line 772

def migration_status(org, id, options = {})
  get "#{Organization.path(org)}/migrations/#{id}", options
end

#migrations(org, options = {}) ⇒ Array<Sawyer::Resource>

Lists the most recent migrations.

Requires authenticated organization owner.

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of migration resources.

See Also:


761
762
763
 
# File 'lib/octokit/client/organizations.rb', line 761

def migrations(org, options = {})
  paginate "#{Organization.path(org)}/migrations", options
end

#organization(org, options = {}) ⇒ Sawyer::Resource Also known as: org

Get an organization

Examples:

Octokit.organization('github')
Octokit.org('github')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

Returns:

  • (Sawyer::Resource) —

    Hash representing GitHub organization.

See Also:


18
19
20
 
# File 'lib/octokit/client/organizations.rb', line 18

def organization(org, options = {})
  get Organization.path(org), options
end

#organization_audit_log(org, options = {}) ⇒ Array<Sawyer::Resource>

Get organization audit log.

Gets the audit log for an organization.

To list oldest events first, specify asc.

Examples:

Octokit.organization_audit_log('github', {include: 'all', phrase: 'action:org.add_member created:>2022-08-29 user:octocat'})

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id for which to retrieve the audit log.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :include (String) — default: 'all' —

    Filter by event type. all, git or web.

  • :phrase (String) —

    A search phrase.

  • :order (String) — default: 'desc' —

    The order of audit log events. To list newest events first, specify desc.

Returns:

  • (Array<Sawyer::Resource>) —

    List of events

See Also:


843
844
845
 
# File 'lib/octokit/client/organizations.rb', line 843

def organization_audit_log(org, options = {})
  paginate "#{Organization.path org}/audit-log", options
end

#organization_invitations(org, options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_invitations

List pending organization invitations

Requires authenticated organization member.

Examples:

@client.organization_invitations('github')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing invitations.

See Also:


223
224
225
 
# File 'lib/octokit/client/organizations.rb', line 223

def organization_invitations(org, options = {})
  get "#{Organization.path org}/invitations", options
end

#organization_member?(org, user, options = {}) ⇒ Boolean Also known as: org_member?

Check if a user is a member of an organization.

Use this to check if another user is a member of an organization that you are a member. If you are not in the organization you are checking, use .organization_public_member? instead.

Examples:

Check if a user is in your organization

@client.organization_member?('your_organization', 'pengwynn')
=> false

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • user (String) —

    GitHub username of the user to check.

Returns:

  • (Boolean) —

    Is a member?

See Also:


183
184
185
186
187
188
189
190
 
# File 'lib/octokit/client/organizations.rb', line 183

def organization_member?(org, user, options = {})
  result = boolean_from_response(:get, "#{Organization.path org}/members/#{user}", options)
  if !result && last_response && last_response.status == 302
    boolean_from_response :get, last_response.headers['Location']
  else
    result
  end
end

#organization_members(org, options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_members

Get organization members

Public members of the organization are returned by default. An authenticated client that is a member of the GitHub organization is required to get private members.

Examples:

Octokit.organization_members('github')
Octokit.org_members('github')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing users.

See Also:


144
145
146
147
148
 
# File 'lib/octokit/client/organizations.rb', line 144

def organization_members(org, options = {})
  options = options.dup
  path = 'public_' if options.delete(:public)
  paginate "#{Organization.path org}/#{path}members", options
end

#organization_membership(org, options = {}) ⇒ Sawyer::Resource Also known as: org_membership

Get an organization membership

Parameters:

  • org (Integer, String) —

    The GitHub Organization.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :user (String) —

    The login of the user, otherwise authenticated user.

Returns:

  • (Sawyer::Resource) —

    Hash representing the organization membership.

See Also:


695
696
697
698
699
700
701
702
 
# File 'lib/octokit/client/organizations.rb', line 695

def organization_membership(org, options = {})
  options = options.dup
  if user = options.delete(:user)
    get "#{Organization.path(org)}/memberships/#{user}", options
  else
    get "user/memberships/orgs/#{org}", options
  end
end

#organization_memberships(options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_memberships

List all organizations memberships for the authenticated user

Returns:

  • (Array<Sawyer::Resource>) —

    Array of organizations memberships.

See Also:


683
684
685
 
# File 'lib/octokit/client/organizations.rb', line 683

def organization_memberships(options = {})
  paginate 'user/memberships/orgs', options
end

#organization_public_member?(org, user, options = {}) ⇒ Boolean Also known as: org_public_member?

Check if a user is a public member of an organization.

If you are checking for membership of a user of an organization that you are in, use .organization_member? instead.

Examples:

Check if a user is a hubbernaut

@client.organization_public_member?('github', 'pengwynn')
=> true

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • user (String) —

    GitHub username of the user to check.

Returns:

  • (Boolean) —

    Is a public member?

See Also:


208
209
210
 
# File 'lib/octokit/client/organizations.rb', line 208

def organization_public_member?(org, user, options = {})
  boolean_from_response :get, "#{Organization.path org}/public_members/#{user}", options
end

#organization_public_members(org, options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_public_members

Get organization public members

Lists the public members of an organization

Examples:

Octokit.organization_public_members('github')
Octokit.org_public_members('github')

Parameters:

  • org (String) —

    Organization GitHub username.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing users.

See Also:


162
163
164
 
# File 'lib/octokit/client/organizations.rb', line 162

def organization_public_members(org, options = {})
  organization_members org, options.merge(public: true)
end

#organization_repositories(org, options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_repositories, org_repos

List organization repositories

Public repositories are available without authentication. Private repos require authenticated organization member.

Examples:

Octokit.organization_repositories('github')
Octokit.org_repositories('github')
Octokit.org_repos('github')
@client.org_repos('github', {:type => 'private'})

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id for which to list repos.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :type (String) — default: 'all' —

    Filter by repository type. all, public, member, sources, forks, or private.

Returns:

  • (Array<Sawyer::Resource>) —

    List of repositories

See Also:


125
126
127
 
# File 'lib/octokit/client/organizations.rb', line 125

def organization_repositories(org, options = {})
  paginate "#{Organization.path org}/repos", options
end

#organization_teams(org, options = {}) ⇒ Array<Sawyer::Resource> Also known as: org_teams

List teams

Requires authenticated organization member.

Examples:

@client.organization_teams('github')
@client.org_teams('github')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing teams.

See Also:


283
284
285
 
# File 'lib/octokit/client/organizations.rb', line 283

def organization_teams(org, options = {})
  paginate "#{Organization.path org}/teams", options
end

#organizations(user = nil, options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_organizations, list_orgs, orgs

Get organizations for a user.

Nonauthenticated calls to this method will return organizations that the user is a public member.

Use an authenicated client to get both public and private organizations for a user.

Calling this method on a @client will return that users organizations. Private organizations are included only if the @client is authenticated.

Examples:

Octokit.organizations('pengwynn')
@client.organizations('pengwynn')
Octokit.orgs('pengwynn')
Octokit.list_organizations('pengwynn')
Octokit.list_orgs('pengwynn')
@client.organizations

Parameters:

  • user (Integer, String) (defaults to: nil) —

    GitHub user login or id of the user to get list of organizations.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing organizations.

See Also:


81
82
83
 
# File 'lib/octokit/client/organizations.rb', line 81

def organizations(user = nil, options = {})
  paginate "#{User.path user}/orgs", options
end

#outside_collaborators(org, options = {}) ⇒ Array<Sawyer::Resource>

List outside collaborators for an organization

Requires authenticated organization members.

Examples:

@client.outside_collaborators('github')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing users.

See Also:


238
239
240
 
# File 'lib/octokit/client/organizations.rb', line 238

def outside_collaborators(org, options = {})
  paginate "#{Organization.path org}/outside_collaborators", options
end

#publicize_membership(org, user, options = {}) ⇒ Boolean

Publicize a user's membership of an organization

Requires authenticated organization owner.

Examples:

@client.publicize_membership('github', 'pengwynn')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • user (String) —

    GitHub username of user to publicize.

Returns:

  • (Boolean) —

    True if publicization successful, false otherwise.

See Also:


608
609
610
 
# File 'lib/octokit/client/organizations.rb', line 608

def publicize_membership(org, user, options = {})
  boolean_from_response :put, "#{Organization.path org}/public_members/#{user}", options
end

#remove_organization_member(org, user, options = {}) ⇒ Boolean Also known as: remove_org_member

Remove organization member

Requires authenticated organization owner or member with team admin access.

Examples:

@client.remove_organization_member('github', 'pengwynn')
@client.remove_org_member('github', 'pengwynn')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • user (String) —

    GitHub username of user to remove.

Returns:

  • (Boolean) —

    True if removal is successful, false otherwise.

See Also:


591
592
593
594
595
 
# File 'lib/octokit/client/organizations.rb', line 591

def remove_organization_member(org, user, options = {})
  # this is a synonym for: for team in org.teams: remove_team_member(team.id, user)
  # provided in the GH API v3
  boolean_from_response :delete, "#{Organization.path org}/members/#{user}", options
end

#remove_organization_membership(org, options = {}) ⇒ Boolean Also known as: remove_org_membership

Remove an organization membership

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

Returns:

  • (Boolean) —

    Success

See Also:


731
732
733
734
735
 
# File 'lib/octokit/client/organizations.rb', line 731

def remove_organization_membership(org, options = {})
  options = options.dup
  user = options.delete(:user)
  user && boolean_from_response(:delete, "#{Organization.path(org)}/memberships/#{user}", options)
end

#remove_outside_collaborator(org, user, options = {}) ⇒ Boolean

Remove outside collaborator from an organization

Requires authenticated organization members.

Examples:

@client.remove_outside_collaborator('github', 'lizzhale')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • user (String) —

    GitHub username to be removed as outside collaborator

Returns:

  • (Boolean) —

    Return true if outside collaborator removed from organization, false otherwise.

See Also:


253
254
255
 
# File 'lib/octokit/client/organizations.rb', line 253

def remove_outside_collaborator(org, user, options = {})
  boolean_from_response :delete, "#{Organization.path org}/outside_collaborators/#{user}", options
end

#remove_team_member(team_id, user, options = {}) ⇒ Boolean

Remove team member

Requires authenticated organization owner or member with team admin permission.

Examples:

@client.remove_team_member(100000, 'pengwynn')

Parameters:

  • team_id (Integer) —

    Team id.

  • user (String) —

    GitHub username of the user to boot.

Returns:

  • (Boolean) —

    True if user removed, false otherwise.

See Also:


460
461
462
 
# File 'lib/octokit/client/organizations.rb', line 460

def remove_team_member(team_id, user, options = {})
  boolean_from_response :delete, "teams/#{team_id}/members/#{user}", options
end

#remove_team_membership(team_id, user, options = {}) ⇒ Boolean

Remove team membership

Examples:

@client.remove_team_membership(100000, 'pengwynn')

Parameters:

  • team_id (Integer) —

    Team id.

  • user (String) —

    GitHub username of the user to boot.

Returns:

  • (Boolean) —

    True if user removed, false otherwise.

See Also:


675
676
677
 
# File 'lib/octokit/client/organizations.rb', line 675

def remove_team_membership(team_id, user, options = {})
  boolean_from_response :delete, "teams/#{team_id}/memberships/#{user}", options
end

#remove_team_repository(team_id, repo, _options = {}) ⇒ Boolean Also known as: remove_team_repo

Remove team repository

Removes repository from team. Does not delete the repository.

Requires authenticated organization owner.

Examples:

@client.remove_team_repository(100000, 'github/developer.github.com')
@client.remove_team_repo(100000, 'github/developer.github.com')

Parameters:

  • team_id (Integer) —

    Team id.

  • repo (String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Boolean) —

    Return true if repo removed from team, false otherwise.

See Also:


574
575
576
 
# File 'lib/octokit/client/organizations.rb', line 574

def remove_team_repository(team_id, repo, _options = {})
  boolean_from_response :delete, "teams/#{team_id}/repos/#{Repository.new(repo)}"
end

#start_migration(org, repositories, options = {}) ⇒ Sawyer::Resource

Initiates the generation of a migration archive.

Requires authenticated organization owner.

Examples:

@client.start_migration('github', ['github/dotfiles'])

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • repositories (Array<String>) —

    :repositories Repositories for the organization.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :lock_repositories (Boolean, optional) —

    Indicates whether repositories should be locked during migration

Returns:

  • (Sawyer::Resource) —

    Hash representing the new migration.

See Also:


749
750
751
752
 
# File 'lib/octokit/client/organizations.rb', line 749

def start_migration(org, repositories, options = {})
  options[:repositories] = repositories
  post "#{Organization.path(org)}/migrations", options
end

#team(team_id, options = {}) ⇒ Sawyer::Resource

Get team

Requires authenticated organization member.

Examples:

@client.team(100000)

Parameters:

  • team_id (Integer) —

    Team id.

Returns:

  • (Sawyer::Resource) —

    Hash representing team.

See Also:


320
321
322
 
# File 'lib/octokit/client/organizations.rb', line 320

def team(team_id, options = {})
  get "teams/#{team_id}", options
end

#team_by_name(org, team_slug, options = {}) ⇒ Sawyer::Resource

Get team by name and org

Requires authenticated organization member.

Examples:

@client.team_by_name("github", "justice-league")

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • team_slug (String) —

    Team slug.

Returns:

  • (Sawyer::Resource) —

    Hash representing team.

See Also:


334
335
336
 
# File 'lib/octokit/client/organizations.rb', line 334

def team_by_name(org, team_slug, options = {})
  get "#{Organization.path(org)}/teams/#{team_slug}", options
end

#team_invitations(team_id, options = {}) ⇒ Array<Sawyer::Resource>

List pending team invitations

Requires authenticated organization member.

Examples:

@client.team_invitations('github')

Parameters:

  • team_id (Integer) —

    Team id.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing invitations.

See Also:


493
494
495
 
# File 'lib/octokit/client/organizations.rb', line 493

def team_invitations(team_id, options = {})
  get "teams/#{team_id}/invitations", options
end

#team_member?(team_id, user, options = {}) ⇒ Boolean

Check if a user is a member of a team.

Use this to check if another user is a member of a team that you are a member.

Examples:

Check if a user is in your team

@client.team_member?(100000, 'pengwynn')
=> false

Parameters:

  • team_id (Integer) —

    Team id.

  • user (String) —

    GitHub username of the user to check.

Returns:

  • (Boolean) —

    Is a member?

See Also:


479
480
481
 
# File 'lib/octokit/client/organizations.rb', line 479

def team_member?(team_id, user, options = {})
  boolean_from_response :get, "teams/#{team_id}/members/#{user}", options
end

#team_members(team_id, options = {}) ⇒ Array<Sawyer::Resource>

List team members

Requires authenticated organization member.

Examples:

@client.team_members(100000)

Parameters:

  • team_id (Integer) —

    Team id.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing users.

See Also:


417
418
419
 
# File 'lib/octokit/client/organizations.rb', line 417

def team_members(team_id, options = {})
  paginate "teams/#{team_id}/members", options
end

#team_membership(team_id, user, options = {}) ⇒ Sawyer::Resource

Check if a user has a team membership.

Examples:

Check if a user has a membership for a team

@client.team_membership(1234, 'pengwynn')

Parameters:

  • team_id (Integer) —

    Team id.

  • user (String) —

    GitHub username of the user to check.

Returns:

  • (Sawyer::Resource) —

    Hash of team membership info

See Also:


648
649
650
 
# File 'lib/octokit/client/organizations.rb', line 648

def team_membership(team_id, user, options = {})
  get "teams/#{team_id}/memberships/#{user}", options
end

#team_permissions_for_repo(org, team_slug_or_id, owner, repo, options = {}) ⇒ String, Sawyer::Resource

Check team permissions for a repository

Requires authenticated organization member.

Examples:

# Check whether the team has any permissions with the repository
@client.team_permissions_for_repo("github", "justice-league", "octocat", "hello-world")
# Get the full repository object including the permissions level and role for the team
@client.team_permissions_for_repo("github", "justice-league", "octocat", "hello-world", :accept => 'application/vnd.github.v3.repository+json')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • team_slug_or_id (String, Integer) —

    Team slug or Team ID.

  • owner (String) —

    Owner name for the repository.

  • repo (String) —

    Name of the repo to check permissions against.

Returns:

  • (String, Sawyer::Resource) —

    Depending on options it may be an empty string or a resource.

See Also:


355
356
357
 
# File 'lib/octokit/client/organizations.rb', line 355

def team_permissions_for_repo(org, team_slug_or_id, owner, repo, options = {})
  get "#{Organization.path(org)}/teams/#{team_slug_or_id}/repos/#{owner}/#{repo}", options
end

#team_repositories(team_id, options = {}) ⇒ Array<Sawyer::Resource> Also known as: team_repos

List team repositories

Requires authenticated organization member.

Examples:

@client.team_repositories(100000)
@client.team_repos(100000)

Parameters:

  • team_id (Integer) —

    Team id.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing repositories.

See Also:


508
509
510
 
# File 'lib/octokit/client/organizations.rb', line 508

def team_repositories(team_id, options = {})
  paginate "teams/#{team_id}/repos", options
end

#team_repository?(team_id, repo, _options = {}) ⇒ Boolean Also known as: team_repo?

Check if a repo is managed by a specific team

Examples:

@client.team_repository?(8675309, 'octokit/octokit.rb')
@client.team_repo?(8675309, 'octokit/octokit.rb')

Parameters:

  • team_id (Integer) —

    Team ID.

  • repo (String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Boolean) —

    True if managed by a team. False if not managed by the team OR the requesting user does not have authorization to access the team information.

See Also:


525
526
527
 
# File 'lib/octokit/client/organizations.rb', line 525

def team_repository?(team_id, repo, _options = {})
  boolean_from_response :get, "teams/#{team_id}/repos/#{Repository.new(repo)}"
end

#unlock_repository(org, id, repo, options = {}) ⇒ Object

Unlock a previous migration archive.

Requires authenticated organization owner.

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • id (Integer) —

    ID number of the migration.

  • repo (String) —

    Name of the repository.

See Also:


809
810
811
 
# File 'lib/octokit/client/organizations.rb', line 809

def unlock_repository(org, id, repo, options = {})
  delete "#{Organization.path(org)}/migrations/#{id}/repos/#{repo}/lock", options
end

#unpublicize_membership(org, user, options = {}) ⇒ Boolean Also known as: conceal_membership

Conceal a user's membership of an organization.

Requires authenticated organization owner.

Examples:

@client.unpublicize_membership('github', 'pengwynn')
@client.conceal_membership('github', 'pengwynn')

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • user (String) —

    GitHub username of user to unpublicize.

Returns:

  • (Boolean) —

    True of unpublicization successful, false otherwise.

See Also:


624
625
626
 
# File 'lib/octokit/client/organizations.rb', line 624

def unpublicize_membership(org, user, options = {})
  boolean_from_response :delete, "#{Organization.path org}/public_members/#{user}", options
end

#update_organization(org, values, options = {}) ⇒ Sawyer::Resource Also known as: update_org

Update an organization.

Requires authenticated client with proper organization permissions.

Examples:

@client.update_organization('github', {
  :billing_email => '[email protected]',
  :company => 'GitHub',
  :email => '[email protected]',
  :location => 'San Francisco',
  :name => 'github'
})
@client.update_org('github', {:company => 'Unicorns, Inc.'})

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • values (Hash) —

    The updated organization attributes.

Options Hash (values):

  • :billing_email (String) —

    Billing email address. This address is not publicized.

  • :company (String) —

    Company name.

  • :email (String) —

    Publicly visible email address.

  • :location (String) —

    Location of organization.

  • :name (String) —

    GitHub username for organization.

  • :default_repository_permission (String) —

    The default permission members have on organization repositories.

  • :members_can_create_repositories (Boolean) —

    Set true to allow members to create repositories on the organization.

Returns:

  • (Sawyer::Resource) —

    Hash representing GitHub organization.

See Also:


48
49
50
 
# File 'lib/octokit/client/organizations.rb', line 48

def update_organization(org, values, options = {})
  patch Organization.path(org), options.merge(values)
end

#update_organization_membership(org, options = {}) ⇒ Sawyer::Resource Also known as: update_org_membership

Edit an organization membership

Parameters:

  • org (String, Integer) —

    Organization GitHub login or id.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :role (String) —

    The role of the user in the organization.

  • :state (String) —

    The state that the membership should be in.

  • :user (String) —

    The login of the user, otherwise authenticated user.

Returns:

  • (Sawyer::Resource) —

    Hash representing the updated organization membership.

See Also:


714
715
716
717
718
719
720
721
722
723
 
# File 'lib/octokit/client/organizations.rb', line 714

def update_organization_membership(org, options = {})
  options = options.dup
  if user = options.delete(:user)
    options.delete(:state)
    put "#{Organization.path(org)}/memberships/#{user}", options
  else
    options.delete(:role)
    patch "user/memberships/orgs/#{org}", options
  end
end

#update_team(team_id, options = {}) ⇒ Sawyer::Resource

Update team

Requires authenticated organization owner.

Examples:

@client.update_team(100000, {
  :name => 'Front-end Designers',
  :permission => 'push'
})

Parameters:

  • team_id (Integer) —

    Team id.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :name (String) —

    Team name.

  • :permission (String) —

    Permissions the team has for team repositories.

    pull - team members can pull, but not push to or administer these repositories. push - team members can pull and push, but not administer these repositories. admin - team members can pull, push and administer these repositories.

  • :parent_team_id (Integer) —

    ID of a team to set as the parent team.

Returns:

  • (Sawyer::Resource) —

    Hash representing updated team.

See Also:


391
392
393
 
# File 'lib/octokit/client/organizations.rb', line 391

def update_team(team_id, options = {})
  patch "teams/#{team_id}", options
end

#user_teams(options = {}) ⇒ Array<Sawyer::Resource>

List all teams for the authenticated user across all their orgs

Returns:

  • (Array<Sawyer::Resource>) —

    Array of team resources.

See Also:


633
634
635
 
# File 'lib/octokit/client/organizations.rb', line 633

def user_teams(options = {})
  paginate 'user/teams', options
end