共有アクセス許可を更新する
共有アクセス許可のプロパティを更新するには、アクセス許可リソースのパッチを適用します。
roles プロパティのみ、この方法で変更可能です。
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
アクセス許可の種類 | アクセス許可 (特権の小さいものから大きいものへ) |
---|---|
委任 (職場または学校のアカウント) | Files.ReadWrite、Files.ReadWrite.All、Sites.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | Files.ReadWrite、Files.ReadWrite.All |
アプリケーション | Files.ReadWrite.All、Sites.ReadWrite.All |
HTTP 要求
PATCH /drives/{drive-id}/items/{item-id}/permissions/{perm-id}
PATCH /groups/{group-id}/drive/items/{item-id}/permissions/{perm-id}
PATCH /me/drive/items/{item-id}/permissions/{perm-id}
PATCH /sites/{site-id}/drive/items/{item-id}/permissions/{perm-id}
PATCH /users/{user-id}/drive/items/{item-id}/permissions/{perm-id}
オプションの要求ヘッダー
名前 | 型 | 説明 |
---|---|---|
if-match | string | この要求ヘッダーが含まれていて、指定された eTag (または cTag) が項目の現在のタグに一致しない場合には、412 Precondition Failed 応答が返され、項目は削除されません。 |
要求本文
要求本文で、更新する関連フィールドの値を指定します。
要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。 最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。
プロパティ | 型 | 説明 |
---|---|---|
roles | 文字列コレクション | アクセス許可の種類の配列。 |
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で、更新されたアクセス許可オブジェクトを返します。
例
以下は、共有アクセス許可のロールを読み取り専用に変更する要求の例です。
PATCH /me/drive/items/{item-id}/permissions/{perm-id}
Content-type: application/json
{
"roles": [ "read" ]
}
応答
成功した場合、このメソッドは、応答本文でアクセス許可の更新された状態を表す Permission リソースを返します。
HTTP/1.1 200 OK
Content-type: application/json
{
"grantedTo": {
"user": {
"displayName": "Ryan Gregg",
"id": "efee1b77-fb3b-4f65-99d6-274c11914d12"
}
},
"id": "1",
"roles": [ "read" ]
}
エラー応答
エラーがどのような形で返されるかについては、「エラー応答」を参照してください。