Jump to

• Request
• Response

Sync IDCS users by UserNames .

post

/social/api/v1/people/sync

Sync IDCS users by UserNames.

Request

Supported Media Types

• application/json

Body ()

The request body defines the details of the request.

Root Schema : XV1PeopleSyncInfo

Type: object

V1 People Sync Info will have information about Users to be synced.

Show Source

• forceSyncAttribute(optional): boolean
  If false then newly created Users in Idcs will be synced if True then existing users will be synced. Required.
• userNames(optional): array userNames
  UserNames of Users to be synced will be passed. Required.

{
    "description":"V1 People Sync Info will have information about Users to be synced.",
    "properties":{
        "forceSyncAttribute":{
            "description":"If false then newly created Users in Idcs will be synced if True then existing users will be synced. Required.",
            "type":"boolean"
        },
        "userNames":{
            "description":"UserNames of Users to be synced will be passed. Required.",
            "type":"array",
            "items":{
                "description":"UserName of User to be synced",
                "type":"string"
            }
        }
    }
}

Nested Schema : userNames

Type: array

UserNames of Users to be synced will be passed. Required.

Show Source

• Array of: string
  UserName of User to be synced

{
    "description":"UserNames of Users to be synced will be passed. Required.",
    "type":"array",
    "items":{
        "description":"UserName of User to be synced",
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1PeopleSyncResultInfo

Type: object

V1 People Sync Result Info will display Synced or syncfailed User list.

Show Source

• sync(optional): object XV1SyncedUserListInfo
  V1 Synced User List Info
• syncFailed(optional): object XV1SyncedUserListInfo
  V1 Synced User List Info

{
    "description":"V1 People Sync Result Info will display Synced or syncfailed User list.",
    "properties":{
        "sync":{
            "$ref":"#/definitions/XV1SyncedUserListInfo"
        },
        "syncFailed":{
            "$ref":"#/definitions/XV1SyncedUserListInfo"
        }
    }
}

Nested Schema : XV1SyncedUserListInfo

Type: object

V1 Synced User List Info

Show Source

• 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
  Status of Synced successful or sync failed .
• total(optional): integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.
• users(optional): array users
  List of Users with userNames

{
    "description":"V1 Synced User List Info",
    "properties":{
        "status":{
            "description":"Status of Synced successful or sync failed .",
            "type":"string"
        },
        "users":{
            "description":"List of Users with userNames",
            "type":"array",
            "items":{
                "description":"Username",
                "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 : users

Type: array

List of Users with userNames

Show Source

• Array of: string
  Username

{
    "description":"List of Users with userNames",
    "type":"array",
    "items":{
        "description":"Username",
        "type":"string"
    }
}

Back to Top