Get-GitHubOrganization

SYNOPSIS

List organization

SYNTAX

__AllParameterSets (Default)

Get-GitHubOrganization [-PerPage <Int32>] [-Context <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

NamedOrg

Get-GitHubOrganization -Name <String> [-PerPage <Int32>] [-Context <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

NamedUser

Get-GitHubOrganization -Username <String> [-PerPage <Int32>] [-Context <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

AllOrg

Get-GitHubOrganization [-All] [-Since <Int32>] [-PerPage <Int32>] [-Context <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

UserOrg

Get-GitHubOrganization [-PerPage <Int32>] [-Context <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

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 organizations for the authenticated user.

EXAMPLE 2

Get-GitHubOrganization -Username 'octocat'

List public organizations for the user 'octocat'.

EXAMPLE 3

Get-GitHubOrganization -All -Since 142951047

List organizations, starting with PSModule.

EXAMPLE 4

Get-GitHubOrganization -Name 'PSModule'

Get the organization 'PSModule'.

PARAMETERS

-Name

The organization name. The name is not case sensitive.

Type: String
Parameter Sets: NamedOrg
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Username

The handle for the GitHub user account.

Type: String
Parameter Sets: NamedUser
Aliases: User

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-All

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

Type: SwitchParameter
Parameter Sets: AllOrg
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Since

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

Type: Int32
Parameter Sets: AllOrg
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PerPage

The number of results per page (max 100).

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-GitHubContext)
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

GitHubOrganization

NOTES

RELATED LINKS

https://psmodule.io/GitHub/Functions/Organization/Get-GitHubOrganization