Create User

POST

/api/v1/permissions/users

curl --request POST \
  --url https://example.com/api/v1/permissions/users \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "password": "example", "login_name": "example", "display_name": "example", "first_name": "example", "last_name": "example", "email": "example", "default_warehouse": "example", "default_namespace": "example", "comment": "example" }'

Create a new user.

Args: request: User creation details

Returns: PermissionOperationResponse with operation result

Raises: HTTPException: If user creation fails

Parameters

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

CreateUserRequest

Request to create a new user.

object

name

required

Name

User name

string

password

required

Password

User password

string

login_name

Any of:

string

string

null

null

display_name

Any of:

string

string

null

null

first_name

Any of:

string

string

null

null

last_name

Any of:

string

string

null

null

email

Any of:

string

string

null

null

default_warehouse

Any of:

string

string

null

null

default_namespace

Any of:

string

string

null

null

comment

Any of:

string

string

null

null

Example^generated

{
  "name": "example",
  "password": "example",
  "login_name": "example",
  "display_name": "example",
  "first_name": "example",
  "last_name": "example",
  "email": "example",
  "default_warehouse": "example",
  "default_namespace": "example",
  "comment": "example"
}

Responses

200

Successful Response

Media typeapplication/json

PermissionOperationResponse

Response for permission operations.

object

success

required

Success

Whether the operation was successful

boolean

message

required

Message

Operation result message

string

details

Any of:

object

object

key

additional properties

any

null

null

Example^generated

{
  "success": true,
  "message": "example",
  "details": {}
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}