PowerShell Functions for the Yammer API

This is a project that creates a couple of PowerShell Wrapper Functions calling the Yammer API. The Functions in this script only work on PowerShell v3. You can download PowerShell v3 from Microsoft Download Center.

You need to Request a Yammer API Key at http://www.yammer.com/client_applications/new and use the Consumer key and Consumer secret from the Client application your registered within the Set-YammerAuthentication Function.

You need to unzip all the files from the Downloads Page and Unblock the zip file. Extract the files to a folder and start the jammer.ps1 script dot sourced from within PowerShell.

Dot sourcing is starting the file like this . .\jammer.ps1 (dot space dot filename) 

At the moment the following Functions are within the jammer.ps1 script:

Set-YammerAuthentication

NAME
    Set-YammerAuthentication
   
SYNOPSIS
    Authenticate with Yammer using oAuth
   
   
SYNTAX
    Set-YammerAuthentication [[-ConsumerKey] <String>] [[-ConsumerSecret] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
   
   
DESCRIPTION
    To use this function and the other Yammer PowerShell Functions you first need to register your Application on
    https://www.yammer.com/client_applications/new
    After you have registered your Yammer Application you should use the Consumer and Consumer Secret keys
    in this PowerShell Yammer Module.
    When running the Set-YammerAuthentication Function for the first time the Yammer Consumer and Consumer Secret keys
    are stored in the registry.
    Next time you use the Set-YammerAuthentication Function it searches the registry for the Consumer and Consumer Secret keys.

Get-YammerMessage

NAME
    Get-YammerMessage
   
SYNOPSIS
    Retrieve Yammer Messages
   
   
SYNTAX
    Get-YammerMessage [[-GroupName] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
   
   
DESCRIPTION
    Retrieves all messages in this network. Corresponds to the "Company Feed" tab on the website.

Get-YammerGroup

NAME
    Get-YammerGroup

SYNOPSIS
    Retrieve Yammer Groups.

SYNTAX
    Get-YammerGroup [[-Page] <Int32[]>] [-Letter <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

    Get-YammerGroup [-Mine] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
    Retrieve Yammer Groups. Maximum 50 Groups are shown at a time.


Send-YammerMessage

NAME
    Send-YammerMessage

SYNOPSIS
    Send Yammer Messages

SYNTAX
    Send-YammerMessage [-Message] <String[]> [[-GroupName] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
    Send Yammer Message to Network or to specified Yammer Group

 

Get-YammerUser

NAME
    Get-YammerUser

SYNOPSIS
    Get Yammer User Information


SYNTAX
    Get-YammerUser [-Email] <String> [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
    Get Yammer User Information using an email address as parameter

Last edited Oct 25, 2012 at 9:29 AM by sstranger, version 8