diff options
author | Francois Ferrand <thetypz@gmail.com> | 2015-01-16 17:08:48 +0100 |
---|---|---|
committer | Francois Ferrand <thetypz@gmail.com> | 2015-01-16 17:13:36 +0100 |
commit | 969d60ab416c075db27f7a0247f0c48ab519afa6 (patch) | |
tree | 5612bf783866291a24f7c5af913cbd584f7b7137 /docs/api-json-rpc.markdown | |
parent | fd22b955751075e4a69df9c1d24995f15b991be7 (diff) |
Add Json API to create LDAP user.
This allows setting up permissions before the LDAP users actually connect
to Kanboard, and even importing the permissions from other tools.
Diffstat (limited to 'docs/api-json-rpc.markdown')
-rw-r--r-- | docs/api-json-rpc.markdown | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown index ef013880..184739ad 100644 --- a/docs/api-json-rpc.markdown +++ b/docs/api-json-rpc.markdown @@ -1330,6 +1330,43 @@ Response example: } ``` +### createLdapUser + +- Purpose: **Create a new user authentified by LDAP** +- Parameters: + - **username** (string, optional if email is set) + - **email** (string, optional if username is set) + - **is_admin** Set the value 1 for admins or 0 for regular users (integer, optional) + - **default_project_id** (integer, optional) +- Result on success: **user_id** +- Result on failure: **false** + +The user will only be created if a matching is found on the LDAP server. +Username or email (or both) must be provided. + +Request example: + +```json +{ + "jsonrpc": "2.0", + "method": "createLdapUser", + "id": 1518863034, + "params": { + "username": "biloute", + } +} +``` + +Response example: + +```json +{ + "jsonrpc": "2.0", + "id": 1518863034, + "result": 22 +} +``` + ### getUser - Purpose: **Get user information** |