組織メンバーを変更する

組織管理者が、社外・クライアントの種別、またはメンバーの有効・停止状態を変更する。個人トークンは org の範囲が必要。

PATCH/api/org/members

Authorization

AuthorizationBearer token · headerrequired

本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。

Request body

requiredapplication/json

emailstring<email>required

kindstring

Allowed:externalclient

statusstring

Allowed:activedisabled

Responses

200

変更した。

okbooleanrequired

400

メールアドレス、種別、状態、または社内メンバーへの種別変更が不正（invalid_member）。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

401

トークンが無いか、この文書を読む権限が無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

403

組織管理者でない（forbidden）か、個人トークンの範囲が不足している（insufficient_scope）。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

404

台帳に対象の社外・クライアントがいない（not_found）。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

Request

curl -X PATCH 'https://comment-review.fsmarketing.workers.dev/api/org/members' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "external@example.com",
  "status": "disabled"
}'

const response = await fetch("https://comment-review.fsmarketing.workers.dev/api/org/members", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"external@example.com\",\n  \"status\": \"disabled\"\n}"
});

import requests

response = requests.patch(
    "https://comment-review.fsmarketing.workers.dev/api/org/members",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"email\": \"external@example.com\",\n  \"status\": \"disabled\"\n}",
)

Response

{
  "ok": true
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}

{
  "error": "string",
  "status": 0,
  "currentRevision": 0,
  "latestVersionId": "string"
}