Skip to content

Commit

Permalink
add warning to NameCom docs about two-step verification setting (#556)
Browse files Browse the repository at this point in the history
  • Loading branch information
rmbolger committed Jul 17, 2024
1 parent 309b809 commit 6fe18a6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Posh-ACME/Plugins/NameCom.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ function Remove-DnsTxt {
Write-Verbose "Removing TXT record for $RecordName with value $TxtValue"
$url = "$apiRoot/domains/$($domainName)/records/$($rec.id)"
Write-Debug "DELETE $url"
Invoke-RestMethod $url -Method Delete @restParams @script:UseBasic -EA Stop | Out-Null
Invoke-RestMethod $url -Method Delete @restParams @script:UseBasic | Out-Null
} catch { throw }
} else {
Write-Debug "Record $RecordName with value $TxtValue doesn't exist. Nothing to do."
Expand Down
3 changes: 3 additions & 0 deletions docs/Plugins/NameCom.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ This plugin works against the [name.com](https://www.name.com/) domain registrar

First, go to the [Account API Settings](https://www.name.com/account/settings/api) page and create a new API token for your account. Make a note of both the token value and the username associated with the token. If the username is blank immediately following the token creation, try refreshing the page.

!!! warning
If you have two-step verification enabled on your account, there is an additional step to allow the API token to be used. Go to the [Security Settings](https://www.name.com/account/settings/security) page and scroll to the bottom. There is a section called `Name.com API Access` with a slider that need to be set to the "on" position which is to the right. It should be green when set properly. Without it, the API will generate errors about two-step verification not being supported by the API.

## Using the Plugin

The username is used with the `NameComUsername` parameter and the token is used with the `NameComTokenSecure` SecureString parameter. If you are using name.com's API testing environment, you'll also need to include `NameComUseTestEnv=$true` in your plugin arguments.
Expand Down

0 comments on commit 6fe18a6

Please sign in to comment.