github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/enterprise/api/users.html.md (about)

     1  ---
     2  layout: "enterprise"
     3  page_title: "Users - API - Terraform Enterprise"
     4  sidebar_current: "docs-enterprise-api-users"
     5  description: |-
     6    Users are both users and organizations in Terraform Enterprise. They are the parent resource of all resources.
     7  ---
     8  
     9  # Users API
    10  
    11  Users are both users and organizations in Terraform Enterprise. They are the
    12  parent resource of all resources.
    13  
    14  Currently, only the retrieval of users is available on the API. Additionally,
    15  only Vagrant box resources will be listed. Boxes will be returned based on
    16  permissions over the organization, or user.
    17  
    18  ## Read User
    19  
    20  This endpoint retrieves information about a single user.
    21  
    22  | Method | Path           |
    23  | :----- | :------------- |
    24  | `GET`  | `/user/:username` |
    25  
    26  ### Parameters
    27  
    28  - `:username` `(string: <required>)` - Specifies the username to search. This is
    29    specified as part of the URL.
    30  
    31  ### Sample Request
    32  
    33  ```text
    34  $ curl \
    35      --header "X-Atlas-Token: ..." \
    36      https://atlas.hashicorp.com/api/v1/user/my-user
    37  ```
    38  
    39  ### Sample Response
    40  
    41  ```json
    42  {
    43    "username": "sally-seashell",
    44    "avatar_url": "https://www.gravatar.com/avatar/...",
    45    "profile_html": "Sally is...",
    46    "profile_markdown": "Sally is...",
    47    "boxes": []
    48  }
    49  ```