GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PITHUB::ORGS::MEMBERS (3)

.ds Aq ’

NAME

Pithub::Orgs::Members - Github v3 Org Members API

CONTENTS

VERSION

version 0.01033

METHODS

    conceal

o Conceal a user’s membership



    DELETE /orgs/:org/public_members/:user



Examples:



    my $m = Pithub::Orgs::Members->new;
    my $result = $m->conceal(
        org  => CPAN-API,
        user => plu,
    );



    delete

o Removing a user from this list will remove them from all teams and they will no longer have any access to the organization’s repositories.



    DELETE /orgs/:org/members/:user



Examples:



    my $m = Pithub::Orgs::Members->new;
    my $result = $m->delete(
        org  => CPAN-API,
        user => plu,
    );



    is_member

o Check if a user is a member of an organization



    GET /orgs/:org/members/:user



Examples:



    my $m = Pithub::Orgs::Members->new;
    my $result = $m->is_member(
        org  => CPAN-API,
        user => plu,
    );



    is_public

o Get if a user is a public member



    GET /orgs/:org/public_members/:user



Examples:



    my $m = Pithub::Orgs::Members->new;
    my $result = $m->is_public(
        org  => CPAN-API,
        user => plu,
    );



    list

o List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. Otherwise only public members are returned.



    GET /orgs/:org/members



Examples:



    my $m = Pithub::Orgs::Members->new;
    my $result = $m->list( org => CPAN-API );



    list_public

o Members of an organization can choose to have their membership publicized or not.



    GET /orgs/:org/public_members



Examples:



    my $m = Pithub::Orgs::Members->new;
    my $result = $m->list_public( org => CPAN-API );



    publicize

o Publicize a user’s membership



    PUT /orgs/:org/public_members/:user



Examples:



    my $m = Pithub::Orgs::Members->new;
    my $result = $m->publicize(
        org  => CPAN-API,
        user => plu,
    );



AUTHOR

Johannes Plunien <plu@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Johannes Plunien.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PITHUB::ORGS::MEMBERS (3) 2016-01-22

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.