metabase.api.session

Liking cljdoc? Tell your friends :D

Clojure only.

DELETE_
GET_password_reset_token_valid
GET_properties
google-auth-auto-create-accounts-domain
google-auth-client-id
POST_
POST_forgot_password
POST_google_auth
POST_reset_password
routes

/api/session endpoints

/api/session endpoints

raw docstring

DELETE_^clj

`DELETE /api/session/`

Logout.

PARAMS:

metabase-session-id

## `DELETE /api/session/`

Logout.

##### PARAMS:

*  **`metabase-session-id`**

source raw docstring

GET_password_reset_token_valid^clj

`GET /api/session/password_reset_token_valid`

Check is a password reset token is valid and isn't expired.

PARAMS:

token value must be a string.

## `GET /api/session/password_reset_token_valid`

Check is a password reset token is valid and isn't expired.

##### PARAMS:

*  **`token`** value must be a string.

source raw docstring

GET_properties^clj

`GET /api/session/properties`

Get all global properties and their values. These are the specific Settings which are meant to be public.

## `GET /api/session/properties`

Get all global properties and their values. These are the specific `Settings` which are meant to be public.

source raw docstring

google-auth-auto-create-accounts-domain^clj

(google-auth-auto-create-accounts-domain)

(google-auth-auto-create-accounts-domain new-value)

When set, allow users to sign up on their own if their Google account email address is from this domain.

google-auth-auto-create-accounts-domain is a string Setting. You can get its value by calling:

(google-auth-auto-create-accounts-domain)

and set its value by calling:

(google-auth-auto-create-accounts-domain <new-value>)

You can also set its value with the env var MB_GOOGLE_AUTH_AUTO_CREATE_ACCOUNTS_DOMAIN.

Clear its value by calling:

(google-auth-auto-create-accounts-domain nil)

Its default value is nil.

When set, allow users to sign up on their own if their Google account email address is from this domain.

`google-auth-auto-create-accounts-domain` is a string Setting. You can get its value by calling:

    (google-auth-auto-create-accounts-domain)

and set its value by calling:

    (google-auth-auto-create-accounts-domain <new-value>)

You can also set its value with the env var `MB_GOOGLE_AUTH_AUTO_CREATE_ACCOUNTS_DOMAIN`.

Clear its value by calling:

    (google-auth-auto-create-accounts-domain nil)

Its default value is `nil`.

source raw docstring

google-auth-client-id^clj

(google-auth-client-id)

(google-auth-client-id new-value)

Client ID for Google Auth SSO. If this is set, Google Auth is considered to be enabled.

google-auth-client-id is a string Setting. You can get its value by calling:

(google-auth-client-id)

and set its value by calling:

(google-auth-client-id <new-value>)

You can also set its value with the env var MB_GOOGLE_AUTH_CLIENT_ID.

Clear its value by calling:

(google-auth-client-id nil)

Its default value is nil.

Client ID for Google Auth SSO. If this is set, Google Auth is considered to be enabled.

`google-auth-client-id` is a string Setting. You can get its value by calling:

    (google-auth-client-id)

and set its value by calling:

    (google-auth-client-id <new-value>)

You can also set its value with the env var `MB_GOOGLE_AUTH_CLIENT_ID`.

Clear its value by calling:

    (google-auth-client-id nil)

Its default value is `nil`.

source raw docstring

POST_^clj

`POST /api/session/`

PARAMS:

username value must be a non-blank string.
password value must be a non-blank string.
remote-address
request

## `POST /api/session/`

Login.

##### PARAMS:

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

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

*  **`remote-address`** 

*  **`request`**

source raw docstring

POST_forgot_password^clj

`POST /api/session/forgot_password`

Send a reset email when user has forgotten their password.

PARAMS:

server-name
email value must be a valid email address.
remote-address

## `POST /api/session/forgot_password`

Send a reset email when user has forgotten their password.

##### PARAMS:

*  **`server-name`** 

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

*  **`remote-address`**

source raw docstring

POST_google_auth^clj

`POST /api/session/google_auth`

PARAMS:

token value must be a non-blank string.
remote-address
request

## `POST /api/session/google_auth`

Login with Google Auth.

##### PARAMS:

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

*  **`remote-address`** 

*  **`request`**

source raw docstring

POST_reset_password^clj

`POST /api/session/reset_password`

Reset password with a reset token.

PARAMS:

token value must be a non-blank string.
password Insufficient password strength
request

## `POST /api/session/reset_password`

Reset password with a reset token.

##### PARAMS:

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

*  **`password`** Insufficient password strength

*  **`request`**

source raw docstring

routes^clj

Ring routes for api/session: (POST_ GET_password_reset_token_valid POST_forgot_password GET_properties POST_reset_password DELETE_ POST_google_auth)

Ring routes for api/session:
(POST_ GET_password_reset_token_valid POST_forgot_password GET_properties POST_reset_password DELETE_ POST_google_auth)

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close