aherman
/
terraform
mirror of https://github.com/hashicorp/terraform
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd1c50efb01'
${ noResults }
terraform/website/source/docs/enterprise/api/users.html.md

1.2 KiB
Raw Blame History

layout page_title sidebar_current description
enterprise Users - API - Terraform Enterprise docs-enterprise-api-users Users are both users and organizations in Terraform Enterprise. They are the parent resource of all resources.

Users API

Users are both users and organizations in Terraform Enterprise. They are the parent resource of all resources.

Currently, only the retrieval of users is available on the API. Additionally, only Vagrant box resources will be listed. Boxes will be returned based on permissions over the organization, or user.

Read User

This endpoint retrieves information about a single user.

Method Path
GET /user/:username

Parameters

  • :username (string: <required>) - Specifies the username to search. This is specified as part of the URL.

Sample Request

$ curl \
    --header "X-Atlas-Token: ..." \
    https://atlas.hashicorp.com/api/v1/user/my-user

Sample Response

{
  "username": "sally-seashell",
  "avatar_url": "https://www.gravatar.com/avatar/...",
  "profile_html": "Sally is...",
  "profile_markdown": "Sally is...",
  "boxes": []
}