コンテンツにスキップ
commentor API
Esc
↑↓移動↵開く⌘Jプレビュー

組織のメンバーを読む

組織管理者が、社外・クライアントの台帳と、登録済みの社内メンバーを読む。個人トークンは org の範囲が必要。

GET/api/org/members
Authorization
AuthorizationBearer token · headerrequired

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

Responses
200

読めた。

membersOrganizationMember[]required
Show properties
Array of OrganizationMember
emailstring<email>required
kindstringrequired
Allowed:externalclient
statusstringrequired
Allowed:activedisabledremoved
registeredAtstring<date-time>required
updatedAtstring<date-time>required
internalobject[]required
Show properties
Array of object
emailstring<email>required
disabledbooleanrequired
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。

Request
curl -X GET 'https://comment-review.fsmarketing.workers.dev/api/org/members' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "members": [
    {
      "email": "user@example.com",
      "kind": "external",
      "status": "active",
      "registeredAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "internal": [
    {
      "email": "user@example.com",
      "disabled": true
    }
  ]
}