github.com/vtorhonen/terraform@v0.9.0-beta2.0.20170307220345-5d894e4ffda7/website/source/docs/providers/ns1/r/apikey.html.markdown (about)

     1  ---
     2  layout: "ns1"
     3  page_title: "NS1: ns1_apikey"
     4  sidebar_current: "docs-ns1-resource-apikey"
     5  description: |-
     6    Provides a NS1 Api Key resource.
     7  ---
     8  
     9  # ns1\_apikey
    10  
    11  Provides a NS1 Api Key resource. This can be used to create, modify, and delete api keys.
    12  
    13  ## Example Usage
    14  
    15  ```
    16  resource "ns1_team" "example" {
    17    name = "Example team"
    18  }
    19  
    20  resource "ns1_apikey" "example" {
    21    name  = "Example key"
    22    teams = ["${ns1_team.example.id}"]
    23  
    24    permissions = {
    25      dns_view_zones       = false
    26      account_manage_users = false
    27    }
    28  }
    29  ```
    30  
    31  ## Argument Reference
    32  
    33  The following arguments are supported:
    34  
    35  * `name` - (Required) The free form name of the apikey.
    36  * `key` - (Required) The apikeys authentication token.
    37  * `teams` - (Required) The teams that the apikey belongs to.
    38  * `permissions` - (Optional) The allowed permissions of the apikey. Permissions documented below.
    39  
    40  Permissions (`permissions`) support the following:
    41  
    42  * `dns_view_zones` - (Optional) Whether the apikey can view the accounts zones.
    43  * `dns_manage_zones` - (Optional) Whether the apikey can modify the accounts zones.
    44  * `dns_zones_allow_by_default` - (Optional) If true, enable the `dns_zones_allow` list, otherwise enable the `dns_zones_deny` list.
    45  * `dns_zones_allow` - (Optional) List of zones that the apikey may access.
    46  * `dns_zones_deny` - (Optional) List of zones that the apikey may not access.
    47  * `data_push_to_datafeeds` - (Optional) Whether the apikey can publish to data feeds.
    48  * `data_manage_datasources` - (Optional) Whether the apikey can modify data sources.
    49  * `data_manage_datafeeds` - (Optional) Whether the apikey can modify data feeds.
    50  * `account_manage_users` - (Optional) Whether the apikey can modify account users.
    51  * `account_manage_payment_methods` - (Optional) Whether the apikey can modify account payment methods.
    52  * `account_manage_plan` - (Optional) Whether the apikey can modify the account plan.
    53  * `account_manage_teams` - (Optional) Whether the apikey can modify other teams in the account.
    54  * `account_manage_apikeys` - (Optional) Whether the apikey can modify account apikeys.
    55  * `account_manage_account_settings` - (Optional) Whether the apikey can modify account settings.
    56  * `account_view_activity_log` - (Optional) Whether the apikey can view activity logs.
    57  * `account_view_invoices` - (Optional) Whether the apikey can view invoices.
    58  * `monitoring_manage_lists` - (Optional) Whether the apikey can modify notification lists.
    59  * `monitoring_manage_jobs` - (Optional) Whether the apikey can modify monitoring jobs.
    60  * `monitoring_view_jobs` - (Optional) Whether the apikey can view monitoring jobs.
    61