Sync Groups by GroupName.
post
/social/api/v1/groups/sync
Sync Groups of Grouptype IDP by GroupName.
Request
Supported Media Types
- application/json
The request body defines the details of the request which accepts groupNames as an array of groups. Maximum 20 groups can be supported in one request.
Root Schema : XV1GroupSyncInfo
Type:
object
V1 Group Sync Information
Show Source
-
groupNames(optional):
array groupNames
Group Names to be Synced of GroupType IDP. Required
Nested Schema : groupNames
Type:
array
Group Names to be Synced of GroupType IDP. Required
Show Source
-
Array of:
string
Group Names to be synced of IDP Group Type. Required .
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1GroupSyncResultInfo
Type:
object
V1 Group Sync Result Information having group names which got synced and which did not sync.
Show Source
-
sync(optional):
object XV1SyncedGroupListInfo
V1 Group Synced or Group Sync Failed List Info
-
syncFailed(optional):
object XV1SyncedGroupListInfo
V1 Group Synced or Group Sync Failed List Info
Nested Schema : XV1SyncedGroupListInfo
Type:
object
V1 Group Synced or Group Sync Failed List Info
Show Source
-
groups(optional):
array groups
Group Names which got synced or missing
-
hasMore(optional):
boolean
If true, there are more items to be returned.
-
nextURL(optional):
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL(optional):
string(url)
Previous page URL for the list. Null if this is the first page.
-
status(optional):
string
message as synced or missing groups
-
total(optional):
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
Nested Schema : groups
Type:
array
Group Names which got synced or missing
Show Source
-
Array of:
string
Group Name which got synced or missing