更新情報をお知らせいたします。
このたび、マネジメントAPIにメンバーの詳細情報を取得できる新しいエンドポイント /api/v1/members/{member_id}
を追加しました。
これにより、コンテンツの作成者や編集者の詳細情報をAPI経由で確認できるようになります。
追加された内容
以下の情報が新しいエンドポイントから取得可能です:
- メンバーID
- 名前
- メールアドレス
- MFA設定状況
API仕様
エンドポイント
GET /api/v1/members/{member_id}
リクエストヘッダー
x-microcms-api-key: {your-api-key}
レスポンス例
通常ユーザー
{
"id": "example_member_id",
"name": "example name",
"email": "example@microcms.co.jp",
"mfa": true
}
SAML連携ユーザー
{
"id": "example_member_id",
"name": "example name",
"email": "example@microcms.co.jp",
"mfa": false
}
権限について
このAPIを使用するには、APIキーに「メンバー詳細情報の取得」権限が付与されている必要があります。
権限がない場合は 403 Forbidden
エラーが返されます。
権限の設定は、APIキー管理画面から行うことができます。
使用例
例えば、コンテンツの作成者情報を取得したい場合、以下のように活用できます:
1. Webhookで content_id
を受け取る
2. GET /api/v1/contents/{endpoint}/{content_id}
でコンテンツ詳細を取得し、createdBy
や updatedBy
から member_id
を取得
3. 本APIで member_id
に基づいて詳細情報を取得
取得したメンバー情報は、たとえばコンテンツの更新者情報(名前やメールアドレス)を含んだ通知やログ出力を、ワークフローに組み込むといった形で活用できます。
エラーレスポンス
400 Bad Request
: 不正なmember_id
が指定された場合401 Unauthorized
: APIキーがリクエストに含まれていない場合等403 Forbidden
: APIキーに必要な権限が付与されていない場合等404 Not Found
: 指定されたメンバーが存在しない場合500 Internal Server Error
: サーバー内部でエラーが発生した場合
おわりに
今回のアップデートにより、作成者や編集者の詳細情報を動的に取得できるようになり、柔軟なワークフロー構築が可能になります。
今後もより便利なサービスを目指して改善を続けてまいります。
ご要望などございましたら、管理画面右下のチャットボタンよりご意見いただけますと幸いです。