823 B
Executable File
823 B
Executable File
layout | page_title | sidebar_current | description |
---|---|---|---|
enterprise | Users API | 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.
Actions
The following actions can be performed on this resource.
- Show
- GET /api/v1/user/:username
Examples
Retrieve a user
$ curl %{ATLAS_URL}/api/v1/user/%{DEFAULT_USERNAME} \
-H "X-Atlas-Token: $ATLAS_TOKEN"