Jump to

• Request
• Response

Sync Groups by GroupName.

post

/social/api/v1/groups/sync

Sync Groups of Grouptype IDP by GroupName.

Request

Supported Media Types

• application/json

Body ()

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

{
    "description":"V1 Group Sync Information",
    "properties":{
        "groupNames":{
            "description":"Group Names to be Synced of GroupType IDP. Required",
            "type":"array",
            "items":{
                "description":"Group Names to be synced of IDP Group Type.  Required .",
                "type":"string"
            }
        }
    }
}

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 .

{
    "description":"Group Names to be Synced of GroupType IDP. Required",
    "type":"array",
    "items":{
        "description":"Group Names to be synced of IDP Group Type.  Required .",
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

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

{
    "description":"V1 Group Sync Result Information having group names which got synced and which did not sync.",
    "properties":{
        "sync":{
            "$ref":"#/definitions/XV1SyncedGroupListInfo"
        },
        "syncFailed":{
            "$ref":"#/definitions/XV1SyncedGroupListInfo"
        }
    }
}

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.

{
    "description":"V1 Group Synced or Group Sync Failed List Info",
    "properties":{
        "status":{
            "description":"message as synced or missing groups",
            "type":"string"
        },
        "groups":{
            "description":"Group Names  which got synced or missing",
            "type":"array",
            "items":{
                "description":"Group Name which got synced or missing",
                "type":"string"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : groups

Type: array

Group Names which got synced or missing

Show Source

• Array of: string
  Group Name which got synced or missing

{
    "description":"Group Names  which got synced or missing",
    "type":"array",
    "items":{
        "description":"Group Name which got synced or missing",
        "type":"string"
    }
}

Back to Top