Skip to content

Get-GitHubOrganization

SYNOPSIS

List organization

SYNTAX

List all organizations for the authenticated user (Default)

Get-GitHubOrganization [-PerPage <int>] [-Context <Object>] [<CommonParameters>]

Get a specific organization

Get-GitHubOrganization -Name <string> [-Context <Object>] [<CommonParameters>]

List public organizations for a specific user

Get-GitHubOrganization -Username <string> [-Context <Object>] [<CommonParameters>]

Get the organizations belonging to an Enterprise

Get-GitHubOrganization -Enterprise <string> [-Context <Object>] [<CommonParameters>]

List all organizations on the tenant

Get-GitHubOrganization -All [-Since <int>] [-PerPage <int>] [-Context <Object>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

List organizations for the authenticated user - if no parameters are provided. List organizations for a user - if a username is provided. Lists all organizations, in the order that they were created on GitHub - if '-All' is provided. Get an organization - if a organization name is provided.

EXAMPLES

EXAMPLE 1

Get-GitHubOrganization

List all organizations for the authenticated user.

EXAMPLE 2

Get-GitHubOrganization -Username 'octocat'

List public organizations for a specific user.

EXAMPLE 3

Get-GitHubOrganization -All -Since 142951047

List all organizations made after an ID.

EXAMPLE 4

Get-GitHubOrganization -Name 'PSModule'

Get a specific organization.

EXAMPLE 5

Get-GitHubOrganization -Enterprise 'msx'

Get the organizations belonging to an Enterprise.

PARAMETERS

-All

List all organizations. Use '-Since' to start at a specific organization ID.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: List all organizations on the tenant
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Enterprise

The Enterprise slug to get organizations from.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Get the organizations belonging to an Enterprise
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

The organization name. The name is not case sensitive.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Get a specific organization
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PerPage

The number of results per page (max 100).

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: List all organizations for the authenticated user
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: List all organizations on the tenant
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Since

A organization ID. Only return organizations with an ID greater than this ID.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: List all organizations on the tenant
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Username

The handle for the GitHub user account.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- User
ParameterSets:
- Name: List public organizations for a specific user
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

{{ Fill in the Description }}

OUTPUTS

GitHubOrganization

{{ Fill in the Description }}

NOTES