Skip to content
v0.5.1GitHub

Using

Creates a new user with the `User` role. The API key is returned **only in this response** and is not stored afterward. Only admins may call this endpoint.

applies to v0.5.1
POST
/store-api/auth/users
curl --request POST \
--url https://example.com/store-api/auth/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example" }'
Media typeapplication/json
object
name
required

Username (1-50 chars, only [a-zA-Z0-9_-]).

string

Example generated

{
"name": "example"
}

User created. API key is shown once in the response.

Media typeapplication/json
object
api_key
required

API key (visible only once — cannot be retrieved afterward).

string
name
required
string
role
required
string

Example generated

{
"api_key": "example",
"name": "example",
"role": "example"
}

Invalid name

Media typetext/plain
string

User already exists

Media typetext/plain
string