initial-admin-user API endpoint

This topic provides reference information about the initial-admin-user API endpoint.

Introduction

Send a POST request to the /initial-admin-user API endpoint to create the initial admin user after deploying Terraform Enterprise. Refer to Create the initial admin user for additional information.

Query parameters

The following table describes the URL query parameters you can include in the request. If your client does not automatically encode URLs, use HTML URL-encoding characters to ensure that requests are successful.

Parameter	Description
`token`	Required. The IACT token retrieved via API or command

Request body

This POST endpoint requires a JSON object with the following properties as a request payload.

Key path	Type	Description
`username`	string	The username to assign the new user.
`email`	string	The email address of the new user.
`password`	string	The password of the new user.

Response body

The POST endpoint returns a JSON object with the following properties.

Key path	Type	Description
`status`	string	Either `"created"` or `"error"`.
`token`	string	If status is `"created"`, this contains a Terraform Enterprise user token for the new user.
`error`	string	If status is `"error"`, this contains the reason for the error.

Sample payload

{
  "username": "manage",
  "email": "it@mycompany.com",
  "password": "thisisabadpassword"
}

Sample request

curl \
  --header "Content-Type: application/json" \
  --request POST \
  --data @payload.json \
  https://${TFE_HOSTNAME}/admin/initial-admin-user?token=${IACT_TOKEN}

Sample response

{
  "status": "created",
  "token": "aabbccdd.v1.atlas.ddeeffgghhiijjkkllmmnnooppqqrrssttuuvvxxyyzz"
}