Import Unix user

POST

/auth/users/import

curl --request POST \
  --url https://sylve.lan:8181/api/auth/users/import \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "admin": true, "password": "example", "username": "example" }'

Adopt an existing Unix account as a managed PAM-backed Sylve user without changing its Unix password or group membership

Authorizations

• BearerAuth

Request Body

Import user settings

Media typeapplication/json

object

admin

required

boolean

password

string

>= 8 characters <= 128 characters

username

required

string

>= 3 characters <= 128 characters

Example^generated

{
  "admin": true,
  "password": "example",
  "username": "example"
}

Responses

201

User Imported

Media typeapplication/json

object

data

object

id

integer

username

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "id": 1,
    "username": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Not Found

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}