移動

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

ユーザー・グループの置換

put

http://{host}:{port}/veridata/v1/services/admin/usergroups/{Id}

必要なロール: Administrator、CommandLineOperator

ユーザー・グループの置換

リクエスト

パス・パラメータ

• Id(必須): integer(int64)
  グループID

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• accessIds: array accessIds
  グループにマップされるアクセス権の配列。
• description: string
• userIds: array userIds
  グループにマップされるユーザーの配列。

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "accessIds":{
            "type":"array",
            "description":"Array of access to be mapped to group.",
            "items":{
                "type":"integer",
                "description":"access ID.",
                "format":"int64"
            }
        },
        "userIds":{
            "type":"array",
            "description":"Array of users to be mapped to group.",
            "items":{
                "type":"integer",
                "description":"user ID.",
                "format":"int64"
            }
        }
    },
    "example":{
        "description":"value",
        "accessIds":[
            0
        ],
        "userIds":[
            0
        ]
    }
}

例:

{
    "description":"value",
    "accessIds":[
        0
    ],
    "userIds":[
        0
    ]
}

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

タイプ: array

グループにマップされるアクセス権の配列。

ソースの表示

• 配列: integer(int64)
  アクセスID。

{
    "type":"array",
    "description":"Array of access to be mapped to group.",
    "items":{
        "type":"integer",
        "description":"access ID.",
        "format":"int64"
    }
}

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

タイプ: array

グループにマップされるユーザーの配列。

ソースの表示

• 配列: integer(int64)
  ユーザーID。

{
    "type":"array",
    "description":"Array of users to be mapped to group.",
    "items":{
        "type":"integer",
        "description":"user ID.",
        "format":"int64"
    }
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ユーザー・グループが正常に更新されました

400 レスポンス

不正なリクエスト。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 レスポンス

権限がありません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 レスポンス

見つかりません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 レスポンス

サーバー・エラー。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

先頭に戻る