github.com/jrasell/terraform@v0.6.17-0.20160523115548-2652f5232949/website/source/docs/providers/github/r/membership.html.markdown (about)

     1  ---
     2  layout: "github"
     3  page_title: "GitHub: github_membership"
     4  sidebar_current: "docs-github-resource-membership"
     5  description: |-
     6    Provides a GitHub membership resource.
     7  ---
     8  
     9  # github\_membership
    10  
    11  Provides a GitHub membership resource.
    12  
    13  This resource allows you to add/remove users from your organization. When applied,
    14  an invitation will be sent to the user to become part of the organization. When
    15  destroyed, either the invitation will be cancelled or the user will be removed.
    16  
    17  ## Example Usage
    18  
    19  ```
    20  # Add a user to the organization
    21  resource "github_membership" "membership_for_some_user" {
    22      username = "SomeUser"
    23      role = "member"
    24  }
    25  ```
    26  
    27  ## Argument Reference
    28  
    29  The following arguments are supported:
    30  
    31  * `username` - (Required) The user to add to the organization.
    32  * `role` - (Optional) The role of the user within the organization. 
    33              Must be one of `member` or `admin`. Defaults to `member`.