File tree Expand file tree Collapse file tree 1 file changed +100
-0
lines changed
Expand file tree Collapse file tree 1 file changed +100
-0
lines changed Original file line number Diff line number Diff line change 1+ ---
2+ contentId : get-member
3+ directory : management-api
4+ ---
5+
6+ # GET /api/v1/members/{member_id}
7+
8+ 任意のメンバーの詳細情報を取得できるAPIです。
9+
10+ リクエストヘッダー
11+ =========
12+
13+ X-MICROCMS-API-KEY
14+ ------------------
15+
16+ GET APIリクエストの際に必要な認証キーです。
17+ マネジメントAPIの権限で「メンバー詳細情報の取得」を有効にして、リクエストヘッダーに含めて送信してください。
18+
19+ ![ ] ( https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/31fffdcd930a4c6b840be1f24d300642/CleanShot%202025-08-07%20at%206%E2%80%AF.14.12.png )
20+
21+ X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「[ APIキー(APIの認証と権限管理)] ( https://document.microcms.io/content-api/x-microcms-api-key ) 」をご覧ください。
22+
23+ パスパラメータ
24+ =======
25+
26+ member\_ id
27+ ----------
28+
29+ 取得するメンバーのIDを指定してください。
30+ IDは管理画面のメンバー詳細画面や、各種マネジメントAPIのレスポンスの中で、確認可能です。
31+
32+ レスポンス
33+ =====
34+
35+ ステータスコード
36+ --------
37+
38+ ステータスコード
39+
40+ エラーメッセージ
41+
42+ 原因と対策
43+
44+ 200
45+
46+ \-
47+
48+ \-
49+
50+ 403
51+
52+ Forbidden
53+
54+ メンバー詳細情報の取得が許可されていません。[ APIキー設定] ( /content-api/x-microcms-api-key ) で権限が付与されていることを確認してください。
55+
56+ 404
57+
58+ Member not found
59+
60+ 取得しようとしたメンバーが存在していない、もしくは招待中です。サービス参加済みのメンバーを指定してください。
61+
62+ 429
63+
64+ Too Many Requests
65+
66+ マネジメントAPIの[ レートリミット] ( /manual/limitations#h0f65c647eb ) を超過しています。リクエスト間隔を空けて、リトライしてください。
67+
68+ レスポンスボディ
69+ --------
70+
71+ 正常に取得できた場合の、メンバー詳細のレスポンス例です。
72+
73+ {
74+ "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
75+ "name": "test-member",
76+ 77+ "mfa": true
78+ }
79+
80+ レスポンスには以下のデータが含まれます。
81+
82+ 値
83+
84+ 説明
85+
86+ ` id `
87+
88+ メンバーのIDです。
89+
90+ ` name `
91+
92+ メンバーの表示名です。未設定の場合は、空の文字列(` "" ` )となります。
93+
94+ ` email `
95+
96+ メンバーのメールアドレスです。
97+
98+ ` mfa `
99+
100+ 二要素認証の設定の有無です。(` true ` :有効、` false ` :無効)
You can’t perform that action at this time.
0 commit comments