Liking cljdoc? Tell your friends :D
Clojure only.

metabase.api.user

/api/user endpoints

/api/user endpoints
raw docstring

DELETE_:idclj

DELETE /api/user/:id

Disable a User. This does not remove the User from the DB, but instead disables their account.

You must be a superuser to do this.

PARAMS:
  • id
## `DELETE /api/user/:id`

Disable a `User`.  This does not remove the `User` from the DB, but instead disables their account.

You must be a superuser to do this.

##### PARAMS:

*  **`id`**
sourceraw docstring

GET_clj

GET /api/user/

Fetch a list of Users for the admin People page or for Pulses. By default returns only active users. If include_deactivated is true, return all Users (active and inactive). (Using include_deactivated requires superuser permissions.)

PARAMS:
  • include_deactivated value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
## `GET /api/user/`

Fetch a list of `Users` for the admin People page or for Pulses. By default returns only active users. If
  `include_deactivated` is true, return all Users (active and inactive). (Using `include_deactivated` requires
  superuser permissions.)

##### PARAMS:

*  **`include_deactivated`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
sourceraw docstring

GET_:idclj

GET /api/user/:id

Fetch a User. You must be fetching yourself or be a superuser.

PARAMS:
  • id
## `GET /api/user/:id`

Fetch a `User`. You must be fetching yourself *or* be a superuser.

##### PARAMS:

*  **`id`**
sourceraw docstring

GET_currentclj

GET /api/user/current

Fetch the current User.

## `GET /api/user/current`

Fetch the current `User`.
sourceraw docstring

POST_clj

POST /api/user/

Create a new User, return a 400 if the email address is already taken

You must be a superuser to do this.

PARAMS:

  • first_name value must be a non-blank string.

  • last_name value must be a non-blank string.

  • email value must be a valid email address.

  • password

  • group_ids value may be nil, or if non-nil, value must be an array. Each value must be an integer greater than zero.

  • login_attributes value may be nil, or if non-nil, value must be a map with each value either a string or number.

## `POST /api/user/`

Create a new `User`, return a 400 if the email address is already taken

You must be a superuser to do this.

##### PARAMS:

*  **`first_name`** value must be a non-blank string.

*  **`last_name`** value must be a non-blank string.

*  **`email`** value must be a valid email address.

*  **`password`** 

*  **`group_ids`** value may be nil, or if non-nil, value must be an array. Each value must be an integer greater than zero.

*  **`login_attributes`** value may be nil, or if non-nil, value must be a map with each value either a string or number.
sourceraw docstring

POST_:id_send_inviteclj

POST /api/user/:id/send_invite

Resend the user invite email for a given user.

You must be a superuser to do this.

PARAMS:
  • id
## `POST /api/user/:id/send_invite`

Resend the user invite email for a given user.

You must be a superuser to do this.

##### PARAMS:

*  **`id`**
sourceraw docstring

PUT_:idclj

PUT /api/user/:id

Update an existing, active User.

PARAMS:

  • id

  • email value may be nil, or if non-nil, value must be a valid email address.

  • first_name value may be nil, or if non-nil, value must be a non-blank string.

  • last_name value may be nil, or if non-nil, value must be a non-blank string.

  • group_ids value may be nil, or if non-nil, value must be an array. Each value must be an integer greater than zero.

  • is_superuser value may be nil, or if non-nil, value must be a boolean.

  • login_attributes value may be nil, or if non-nil, value must be a map with each value either a string or number.

## `PUT /api/user/:id`

Update an existing, active `User`.

##### PARAMS:

*  **`id`** 

*  **`email`** value may be nil, or if non-nil, value must be a valid email address.

*  **`first_name`** value may be nil, or if non-nil, value must be a non-blank string.

*  **`last_name`** value may be nil, or if non-nil, value must be a non-blank string.

*  **`group_ids`** value may be nil, or if non-nil, value must be an array. Each value must be an integer greater than zero.

*  **`is_superuser`** value may be nil, or if non-nil, value must be a boolean.

*  **`login_attributes`** value may be nil, or if non-nil, value must be a map with each value either a string or number.
sourceraw docstring

PUT_:id_passwordclj

PUT /api/user/:id/password

Update a user's password.

PARAMS:

  • id

  • password Insufficient password strength

  • old_password

## `PUT /api/user/:id/password`

Update a user's password.

##### PARAMS:

*  **`id`** 

*  **`password`** Insufficient password strength

*  **`old_password`**
sourceraw docstring

PUT_:id_qbnewbclj

PUT /api/user/:id/qbnewb

Indicate that a user has been informed about the vast intricacies of 'the' Query Builder.

PARAMS:
  • id
## `PUT /api/user/:id/qbnewb`

Indicate that a user has been informed about the vast intricacies of 'the' Query Builder.

##### PARAMS:

*  **`id`**
sourceraw docstring

PUT_:id_reactivateclj

PUT /api/user/:id/reactivate

Reactivate user at :id

You must be a superuser to do this.

PARAMS:
  • id
## `PUT /api/user/:id/reactivate`

Reactivate user at `:id`

You must be a superuser to do this.

##### PARAMS:

*  **`id`**
sourceraw docstring

routesclj

Ring routes for api/user: (POST_ PUT_:id PUT_:id_qbnewb GET_ PUT_:id_reactivate GET_current POST_:id_send_invite PUT_:id_password DELETE_:id GET_:id)

Ring routes for api/user:
(POST_ PUT_:id PUT_:id_qbnewb GET_ PUT_:id_reactivate GET_current POST_:id_send_invite PUT_:id_password DELETE_:id GET_:id)
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close