Retrieves a group
string
the operation succeeded and the group is retrieved
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
}Updates an existing group
string
the update data
boolean
MultiValuedAttributeEntityList
string
boolean
Link
string
string
returned if the group previously existed and is now updated
any
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"link": null,
"name": "newgroupname",
"description": "description",
"type": "GROUP",
"active": null,
"attributes": null,
"expanded": true
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
}Adds a new group
the group to create
boolean
MultiValuedAttributeEntityList
string
boolean
Link
string
string
the operation succeeded and the group is successfully created
any
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"link": null,
"name": "newgroupname",
"description": "description",
"type": "GROUP",
"active": null,
"attributes": null,
"expanded": true
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
}Deletes a group
string
returned if the group was found and deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group'Retrieves a list of group attributes
string
returned if the group attribute was found
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/attribute' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?username=sampleuser",
"rel": "self"
},
"attribute": [
{
"link": {
"href": "https://crowdserver/crowd",
"rel": "self"
},
"name": "attribute",
"values": [
"value1",
"value2"
]
}
]
}Stores the group attributes
string
the attributes to store
array<MultiValuedAttributeEntity>
ListWrapperCallbackMultiValuedAttributeEntity
boolean
Link
returned if the group attributes are successfully set
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/attribute' \
--header 'Content-Type: application/json' \
--data '{
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?username=sampleuser",
"rel": "self"
},
"attribute": [
{
"link": {
"href": "https://crowdserver/crowd",
"rel": "self"
},
"name": "attribute",
"values": [
"value1",
"value2"
]
}
]
}'Deletes a group attribute
string
string
returned if the group attribute is successfully deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/attribute'Retrieves the groups that are direct children of the specified group or a single direct child of that group with the specified name
string
Requiredstring
integer
integer
returned if the group was found
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/child-group/direct?groupname={groupname}' \
--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
{
"group": [
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
},
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
}
]
}Adds a direct child group membership
string
Requiredthe child group
boolean
MultiValuedAttributeEntityList
string
boolean
Link
string
string
returned if the group was found
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/child-group/direct?groupname={groupname}' \
--header 'Content-Type: application/json' \
--data '{
"link": null,
"name": "groupname",
"description": null,
"type": null,
"active": null,
"attributes": null,
"expanded": true
}'Deletes a child group membership
string
Requiredstring
Requiredreturned if the child group membership is deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/child-group/direct?groupname={groupname}&child-groupname={child-groupname}'Retrieves nested children of the specified group or a single nested child of that group with the specified name
string
Requiredstring
integer
integer
returned if the group was found
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/child-group/nested?groupname={groupname}' \
--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
{
"group": [
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
},
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
}
]
}Retrieves full details of all group memberships, with users and nested groups. This resource is optimised for streaming XML responses, and does not support JSON responses
This request has no parameters.
returned if memberships are retrieved
1
2
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/membership'Retrieves the groups that are direct parents of the specified group or a direct parent group of the specified child group
string
Requiredstring
integer
integer
returned if the group is found
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/parent-group/direct?groupname={groupname}' \
--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
{
"group": [
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
},
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
}
]
}Adds a direct parent group membership
string
the user to add to the group
boolean
MultiValuedAttributeEntityList
string
boolean
Link
string
string
returned if the parent group membership is successfully added
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/parent-group/direct' \
--header 'Content-Type: application/json' \
--data '{
"link": null,
"name": "sampleuser",
"firstName": null,
"lastName": null,
"displayName": null,
"directoryId": null,
"password": null,
"encryptedPassword": null,
"key": null,
"createdDate": null,
"updatedDate": null,
"directoryName": null,
"active": null,
"attributes": null,
"email": null,
"expanded": true
}'Retrieves the groups that are nested parents of the specified group or a single nested parent of that group with the specified name
string
Requiredstring
integer
integer
returned if the group was found
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/parent-group/nested?groupname={groupname}' \
--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
{
"group": [
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
},
{
"link": {
"href": "link_to_group",
"rel": "self"
},
"name": "groupname",
"description": "Group Description",
"type": "GROUP",
"active": true,
"attributes": {
"link": {
"href": "https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname",
"rel": "self"
},
"attribute": []
}
}
]
}Retrieves the users that are direct members of the specified group or a specified user who is a direct member of that group
string
Requiredstring
integer
integer
returned if the group is found
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/user/direct?groupname={groupname}' \
--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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
"user": [
{
"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"
},
{
"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"
}
]
}Adds a user as a direct member of the specified group
string
Requiredthe user to add to the group
boolean
MultiValuedAttributeEntityList
string
integer
string
string
string
PasswordEntity
boolean
string
returned if the user is successfully added as a member of the group
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --request POST \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/user/direct?groupname={groupname}' \
--header 'Content-Type: application/json' \
--data '{
"link": null,
"name": "sampleuser",
"firstName": null,
"lastName": null,
"displayName": null,
"directoryId": null,
"password": null,
"encryptedPassword": null,
"key": null,
"createdDate": null,
"updatedDate": null,
"directoryName": null,
"active": null,
"attributes": null,
"email": null,
"expanded": true
}'Removes the user membership
string
Requiredstring
Requiredreturned if the user membership is successfully deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/user/direct?groupname={groupname}&username={username}'Retrieves the users that are nested members of the specified group or a single user who is a nested member of the specified group
string
Requiredstring
integer
integer
returned if the group is found
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/rest/usermanagement/1/group/user/nested?groupname={groupname}' \
--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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
"user": [
{
"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"
},
{
"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: