Retrieves user details. Either username or key query parameter must be present. The 'expand' parameter can be used to include additional data in the response. This can currently be set to 'attributes', to include the user's attributes in the response
string
string
the representation of the found user
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user' \
--header 'Accept: application/json'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser",
"rel": "self"
},
"name": "sampleuser",
"password": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser",
"rel": "edit"
}
},
"key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"attribute": [
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts",
"rel": "self"
},
"name": "invalidPasswordAttempts",
"values": [
"0"
]
},
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"name": "requiresPasswordChange",
"values": [
"false"
]
}
]
},
"first-name": "Sample",
"last-name": "User",
"display-name": "Sample User",
"email": "sample@user.cool"
}
Updates a user
string
user entity containing data to be updated
boolean
MultiValuedAttributeEntityList
string
integer
string
string
string
PasswordEntity
boolean
string
the user was successfully updated
any
1
2
3
4
5
curl --request PUT \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '"{\n \"name\" : \"sampleuser\",\n \"firstName\" : \"Sample\",\n \"lastName\" : \"User\",\n \"displayName\" : \"Sample User\",\n \"active\" : true,\n \"attributes\" : null,\n \"email\" : \"sample@user.cool\",\n}\n"'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser",
"rel": "self"
},
"name": "sampleuser",
"password": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser",
"rel": "edit"
}
},
"key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"attribute": [
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts",
"rel": "self"
},
"name": "invalidPasswordAttempts",
"values": [
"0"
]
},
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"name": "requiresPasswordChange",
"values": [
"false"
]
}
]
},
"first-name": "Sample",
"last-name": "User",
"display-name": "Sample User",
"email": "sample@user.cool"
}
Creates a new user
user entity to be created
boolean
MultiValuedAttributeEntityList
string
integer
string
string
string
PasswordEntity
boolean
string
the user was successfully created
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"link": null,
"name": "sampleuser",
"firstName": "Sample",
"lastName": "User",
"displayName": "Sample User",
"directoryId": null,
"password": {
"link": null,
"value": "secret"
},
"encryptedPassword": null,
"key": null,
"createdDate": null,
"updatedDate": null,
"directoryName": null,
"active": true,
"attributes": null,
"email": "sample@user.cool",
"expanded": true
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser",
"rel": "self"
},
"name": "sampleuser",
"password": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser",
"rel": "edit"
}
},
"key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"attribute": [
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts",
"rel": "self"
},
"name": "invalidPasswordAttempts",
"values": [
"0"
]
},
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"name": "requiresPasswordChange",
"values": [
"false"
]
}
]
},
"first-name": "Sample",
"last-name": "User",
"display-name": "Sample User",
"email": "sample@user.cool"
}
Removes a user
string
the user was successfully removed
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user'
Retrieves a list of user attributes
string
user attributes were successfully renamed
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/attribute' \
--header 'Accept: application/json'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"attribute": [
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts",
"rel": "self"
},
"name": "invalidPasswordAttempts",
"values": [
"0"
]
},
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"name": "requiresPasswordChange",
"values": [
"false"
]
}
]
}
Stores the user attributes. Attribute values will not be overwritten if not specified in attributes
string
authentication information
array<MultiValuedAttributeEntity>
ListWrapperCallbackMultiValuedAttributeEntity
boolean
Link
the attributes were successfully updated
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/attribute' \
--header 'Content-Type: application/json' \
--data '{
"attribute": [
{
"name": "invalidPasswordAttempts",
"values": [
"0"
]
},
{
"name": "requiresPasswordChange",
"values": [
"false"
]
}
]
}'
Deletes a user attribute
string
Requiredstring
Requiredthe attributes was successfully deleted, or the attribute was not defined for the user
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/attribute?username={username}&attributename={attributename}'
Returns the url of the user's avatar
string
Requiredinteger
the uri for the user's avatar (in the location header)
1
2
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/avatar?username={username}'
Expires all passwords for all directories which are part of this application, regardless of group mapping
boolean
Requiredpasswords were expired successfully
1
2
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/expire-all-passwords?confirm={confirm}'
Returns the a list of groups the user is a direct member of
string
Requiredstring
integer
integer
a list of groups was retrieved successfully
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/group/direct?username={username}' \
--header 'Accept: application/json'
1
2
3
4
5
6
7
8
9
10
11
{
"group": [
{
"link": {
"href": "https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators",
"rel": "self"
},
"name": "crowd-administrators"
}
]
}
Adds a user as a direct member of the group
string
Requiredparent group entity
boolean
MultiValuedAttributeEntityList
string
boolean
Link
string
string
the user was successfully added to the group
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/group/direct?username={username}' \
--header 'Content-Type: application/json' \
--data '{
"active": true,
"attributes": {
"attributes": [
{
"link": {},
"name": "<string>",
"value": "<string>",
"values": [
"<string>"
]
}
],
"callback": {},
"empty": true,
"link": {
"href": "<string>",
"rel": "<string>"
}
},
"description": "<string>",
"expanded": true,
"link": {
"href": "<string>",
"rel": "<string>"
},
"name": "<string>",
"type": "GROUP"
}'
Removes a user from a group
string
Requiredstring
Requiredthe user was successfully removed from the group
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/group/direct?username={username}&groupname={groupname}'
Retrieves the group that the user is a nested member of
string
Requiredstring
integer
integer
the user was successfully removed from the group
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/group/nested?username={username}' \
--header 'Accept: application/json'
1
2
3
4
5
6
7
8
9
10
11
{
"group": [
{
"link": {
"href": "https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators",
"rel": "self"
},
"name": "crowd-administrators"
}
]
}
Sends the user a password reset link to the user's email address
string
Requiredthe password was reset link was sent
1
2
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/mail/password?username={username}'
Requests an email to be sent containing usernames associated with the given email address
string
Requiredemail was sent successfully
1
2
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/mail/usernames?email={email}'
Updates a user password
string
Requiredupdate password entity
Link
string
the password was updated
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/password?username={username}' \
--header 'Content-Type: application/json' \
--data '{
"link": null,
"value": "hunter2"
}'
Deletes a user password. This will prevent the user from logging in using a password
string
Requiredthe password was deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/password?username={username}'
Renames a user
string
rename user entity
string
the user was successfully renamed
any
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/user/rename' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"newName": "sampleuser-brandnewname"
}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser",
"rel": "self"
},
"name": "sampleuser",
"password": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser",
"rel": "edit"
}
},
"key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"attribute": [
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts",
"rel": "self"
},
"name": "invalidPasswordAttempts",
"values": [
"0"
]
},
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange",
"rel": "self"
},
"name": "requiresPasswordChange",
"values": [
"false"
]
}
]
},
"first-name": "Sample",
"last-name": "User",
"display-name": "Sample User",
"email": "sample@user.cool"
}
Rate this page: