Create a user

POST 
/node/:hostname/user

Create a new user account on the target node.

Request

Path Parameters

hostname stringrequired

Possible values: non-empty

Target agent hostname, reserved routing value (_any, _all), or label selector (key:value).

application/json

Body

required

User account creation parameters.

name stringrequired

Username for the new account.

uid integer

Numeric user ID. If omitted, the system assigns one.

gid integer

Primary group ID. If omitted, a group matching the username is created.

home string

Home directory path.

shell string

Login shell path.

groups string[]

Supplementary group names.

password string

Initial password (plaintext, hashed by the agent).

system boolean

Create a system account.

Responses

200

User created.

application/json

Schema

Schema

job_id uuid

The job ID used to process this request.

results

object[]

required

Array [

hostname stringrequired

Hostname of the agent that processed this operation.

status stringrequired

Possible values: [ok, failed, skipped]

The status of the operation for this host.

name string

Username.

changed boolean

Whether the operation modified system state.

error string

Error message if the agent failed.

]

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": [
    {
      "hostname": "string",
      "status": "ok",
      "name": "string",
      "changed": true,
      "error": "string"
    }
  ]
}

400

Invalid request payload.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error creating user.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...