OpenAPI を使用して組織のメンバー一覧を取得します。
|
対応エディション |
Enterprise Dedicated Edition |
サービスエンドポイント
サービスエンドポイントを取得し、API リクエスト構文内の {domain}
をご利用の
エンドポイント
に置き換えます。
認可
製品 | リソース | 必要な権限 |
組織設定 | 組織メンバー | 読み取り専用 |
リクエスト構文
GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/membersリクエスト | メンバー一覧の照会 |
リクエストヘッダー | |
アクセストークンです。詳細については、「 アクセストークン 」をご参照ください。 例:pt-0fh3****0fbG_35af****0484。 | |
リクエストパラメーター | |
organizationId 組織の ID です。この ID は、組織設定 の 基本情報 ページで確認できます。 | |
page ページ番号です。 | |
perPage 1 ページあたりに返されるエントリ数です。有効な値: |
レスポンスパラメーター | レスポンス例 |
deptIds メンバーが所属する部門の ID です。 | |
id メンバーの ID です。 | |
joined メンバーが組織に参加したタイムスタンプです。この値は、データベース内でのレコード作成時刻です。 | |
name メンバーの氏名です。 | |
email メンバーのメールアドレスです。 | |
organizationId 組織の ID です。 | |
roleIds メンバーに割り当てられたロールの ID です。 | |
status メンバーのステータスです。 有効な値: | |
userId ユーザーの ID です。 | |
visited メンバーの最終アクセスタイムスタンプです。 |
レスポンスヘッダー
パラメーター | 説明 | 例 |
x-next-page | 次のページ番号です。 | 1 |
x-page | 現在のページ番号です。 | 2 |
x-per-page | 1 ページあたりのエントリ数です。 | 1 |
x-prev-page | 前のページ番号です。 | 2 |
x-total | エントリの合計数です。 | 1 |
x-total-pages | ページの合計数です。 | 3 |
エラーコード
詳細については、「エラーコード」をご参照ください。