機械翻訳について

移動

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

GroupNameでグループを同期します。

post

/social/api/v1/groups/sync

Grouptype IDPのグループをGroupNameで同期します。

リクエスト

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

• application/json

本文()

リクエスト本文は、groupNamesをグループの配列として受け入れるリクエストの詳細を定義します。 1つのリクエストで最大20個のグループをサポートできます。

ルート・スキーマ : XV1GroupSyncInfo

型: object

V1グループ同期情報

Show Source

• groupNames(optional): array groupNames
  GroupType IDPと同期されるグループ名。 必須

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

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

型: array

GroupType IDPと同期されるグループ名。 必須

Show Source

• Array of: string
  IDPグループ・タイプの同期するグループ名。 必須

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : XV1GroupSyncResultInfo

型: object

V1同期され、同期されなかったグループ名を持つグループ同期結果情報。

Show Source

• sync(optional): object XV1SyncedGroupListInfo
  V1グループ同期またはグループ同期失敗リスト情報
• syncFailed(optional): object XV1SyncedGroupListInfo
  V1グループ同期またはグループ同期失敗リスト情報

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

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

型: object

V1グループ同期またはグループ同期失敗リスト情報

Show Source

• groups(optional): array groups
  同期または欠落したグループ名
• hasMore(optional): boolean
  trueの場合、他にも返すアイテムが存在します。
• nextURL(optional): string(url)
  リストの次のページのURL。 これが最後のページである場合はNull。
• previousURL(optional): string(url)
  リストの前のページのURL。 これが最初のページである場合はNull。
• status(optional): string
  同期または欠落したグループとしてのメッセージ
• total(optional): integer(int32)
  指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。

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

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

型: array

同期または欠落したグループ名

Show Source

• Array of: string
  同期または欠落したグループ名

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

トップに戻る