機械翻訳について

移動

• リクエスト
• レスポンス

IDCSユーザーをUserNamesで同期します。

post

/social/api/v1/people/sync

IDCSユーザーをUserNamesで同期します。

リクエスト

サポートされているメディア・タイプ

• application/json

本文()

リクエスト本文は、リクエストの詳細を定義します。

ルート・スキーマ : XV1PeopleSyncInfo

型: object

V1個人情報同期情報には、同期するユーザーに関する情報が含まれます。

Show Source

• forceSyncAttribute(optional): boolean
  falseの場合、新しく作成されたIdcsのユーザーは、Trueの場合に同期され、既存のユーザーは同期されます。 必須。
• userNames(optional): array userNames
  同期するユーザーのUserNamesが渡されます。 必須。

{
    "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"
            }
        }
    }
}

ネストされたスキーマ : userNames

型: array

同期するユーザーのUserNamesが渡されます。 必須。

Show Source

• Array of: string
  同期するユーザーのUserName

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

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : XV1PeopleSyncResultInfo

型: object

V1個人同期結果情報には、同期済または同期済ユーザー・リストが表示されます。

Show Source

• sync(optional): object XV1SyncedUserListInfo
  V1同期ユーザー・リスト情報
• syncFailed(optional): object XV1SyncedUserListInfo
  V1同期ユーザー・リスト情報

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

ネストされたスキーマ : XV1SyncedUserListInfo

型: object

V1同期ユーザー・リスト情報

Show Source

• hasMore(optional): boolean
  trueの場合、他にも返すアイテムが存在します。
• nextURL(optional): string(url)
  リストの次のページのURL。 これが最後のページである場合はNull。
• previousURL(optional): string(url)
  リストの前のページのURL。 これが最初のページである場合はNull。
• status(optional): string
  同期が成功または同期に失敗しました。
• total(optional): integer(int32)
  指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。
• users(optional): array users
  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"
        }
    }
}

ネストされたスキーマ: users

型: array

userNamesを持つユーザーのリスト

Show Source

• Array of: string
  ユーザー名

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

トップに戻る