Skip to content

Retrieve a basic auth user

GET
/api/zones/{zoneId}/basic-auth-users/{id}

Returns a single basic auth user belonging to the zone. The password is never exposed.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

zoneId*

Zone identifier

Type
string
Required
id*

basic-auth-user identifier

Type
string
Required

Responses

basic-auth-user resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "9f8b2c1a-4d3e-4f5a-8b6c-7d8e9f0a1b2c",
  
"zone": "https://example.com/",
  
"username": "jdoe",
  
"comment": "Read-only access for the analytics team",
  
"createdAt": "2026-01-15T09:30:00+00:00",
  
"updatedAt": "2026-01-16T14:05:00+00:00"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI