Skip to content

Commit 984fd86

Browse files
author
Hubot
committed
Sync changes from upstream repository
1 parent d7f5104 commit 984fd86

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

content/v3/users/administration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@ http(s)://<em>hostname</em>/api/v3
1818

1919
## Create a new user
2020

21+
{{#warning}}
22+
23+
If an external authentication mechanism is used, the login name should match the
24+
login name in the external system. If you are using LDAP authentication, you should also
25+
[update the LDAP mapping](/v3/enterprise/ldap/#update-ldap-mapping-for-a-user)
26+
for the user.
27+
28+
{{/warning}}
29+
2130
POST /admin/users
2231

2332
### Parameters
@@ -27,6 +36,12 @@ Name | Type | Description
2736
`login`|`string` | **Required.** The user's username.
2837
`email`|`string` | **Required.** The user's email address.
2938

39+
The login name will be normalized to only contain alphanumeric characters or
40+
single hyphens. For example, if you send `"octo_cat"` as the login, a user named
41+
`"octo-cat"` will be created.
42+
43+
If the login name or email address is already associated with an account, the server will return a `422` response.
44+
3045
#### Example
3146

3247
<%= json \

0 commit comments

Comments
 (0)