diff options
author | Frederic Guillot <fred@kanboard.net> | 2015-01-19 21:42:11 -0500 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2015-01-19 21:42:11 -0500 |
commit | 525d31d1bf485552330222049b630345814c9b44 (patch) | |
tree | 4f0ad2156e11f0e9e1db2691e4959faa4c472c1e /docs | |
parent | a5b6ac2b6a5277ec0bbb5ec73078330ed5043877 (diff) | |
parent | 969d60ab416c075db27f7a0247f0c48ab519afa6 (diff) |
Merge pull-request #524
Diffstat (limited to 'docs')
-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** |