Seminar Help Contact us Login Free Trial Document DownloadDocument

ユーザー

ユーザー

ユーザー検索

GET /api/v1/users HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
status normal:現在のユーザー
deleted:削除済みユーザー 		normal
page ページ 1
per_page ページ毎の取得数 20 100

パラメータ値例

{
  "status": "normal", /* normal, deleted */
  "page": 1,
  "per_page": 20
}

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/users?status=normal&page=1&per_page=20' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 200 OK
{
  "users": [
    {
      "user_code": "0000000001",
      "name": "Aさん",
      "auth_class": "owner", /* owner, admin, user, guest, read_only */
      "email": "xxx@gmail.com",
      "two_step_verification_flag": true,
      "status" => "normal",
      "last_login_date": "2020-08-01T10:10:10+09:00",
      "created_at": "2020-08-01T10:10:10+09:00"
    },
    {
      "user_code": "0000000002",
      "name": "Bさん",
      "auth_class": "admin", /* owner, admin, user, guest, read_only */
      "email": "xxx@gmail.com",
      "two_step_verification_flag": false,
      "status" => "normal",
      "last_login_date": null,
      "created_at": "2020-08-01T10:10:10+09:00"
    }
  ],
  "meta": {
    "previous_page": null,
    "next_page": "https://projectmode.notepm.jp/api/v1/users?page=2&per_page=20&status=normal",
    "page": 1,
    "per_page": 20,
    "total": 100
  }
}

ユーザー詳細取得

GET /api/v1/users/:user_code HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/users/{ユーザーコード}' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 200 OK
{
  "user": [
    {
      "user_code": "0000000001",
      "name": "Aさん",
      "auth_class": "owner", /* owner, admin, user, guest, read_only */
      "email": "xxx@gmail.com",
      "two_step_verification_flag": true,
      "status" => "normal",
      "last_login_date": "2020-08-01T10:10:10+09:00",
      "created_at": "2020-08-01T10:10:10+09:00"
    }
  ],
  "meta": {
  }
}

自分のユーザー詳細取得

GET /api/v1/user/account HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl 'https://{チームドメイン}.notepm.jp/api/v1/user/account' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 200 OK
{
  "user": [
    {
      "user_code": "0000000001",
      "name": "Aさん",
      "auth_class": "owner", /* owner, admin, user, guest, read_only */
      "email": "xxx@gmail.com",
      "two_step_verification_flag": true,
      "status" => "normal",
      "last_login_date": "2020-08-01T10:10:10+09:00",
      "created_at": "2020-08-01T10:10:10+09:00"
    }
  ],
  "token": [
    {
      "read_flag": true,
      "write_flag": true,
    }
  ],
  "meta": {
  }
}

ユーザー招待

POST /api/v1/user HTTP/1.1

Request

パラメータ 内容 必須 デフォルト値 最大値
name ユーザー名 20文字
auth_class "owner": オーナー
"admin": 管理者
"user": ユーザー
"guest": ゲスト
"read_only": 参照専用ゲスト（無料枠）		 ○
email メールアドレス ○ 200文字
notification_create_page メール通知設定（ページ作成時）
※設定値を参照		 all
notification_update_page メール通知設定（ページ更新時）
※設定値を参照		 personal
notification_add_comment メール通知設定（コメント追加時）
※設定値を参照		 personal
notification_remind_page メール通知設定（ページ再通知時） on
notification_remind_file メール通知設定（ファイル通知時） on
notification_remind_board メール通知設定（掲示板通知時）
 on
notification_notepm メール通知設定（NotePMからのお知らせ） on
groups グループ名の配列を設定する。
draft_auto_save 下書き自動保存 on
file_preview ファイルプレビュー on
no_send_mail メール通知しない off
idp_account 連携IdPアカウント SSOオプション契約中の場合に任意項目
SSO有効を設定する場合必須		 255文字
sso_enabled SSO有効 SSOオプション契約中の場合に任意項目
連携IdPアカウントを設定する場合必須

※設定値
"off": 受け取らない
"all": すべて
"personal": お知らせしたい人に設定された場合

パラメータ値例

{
  "name": "Aさん",
  "auth_class": "admin",
  "email": "xxx@gmail.com",
  "notification_create_page": "all", /* off, all, personal */
  "notification_update_page": "personal", /* off, all, personal */
  "notification_add_comment": "off", /* off, all, personal */
  "notification_remind_page": "on", /* on, off */
  "notification_remind_file": "off", /* on, off */
  "notification_remind_board": "on", /* on, off */
  "notification_notepm": "off", /* on, off */
  "groups": [
    "グループA",
    "グループB"
  ],
  "draft_auto_save": "on", /* on, off */
  "file_preview": "off", /* on, off */
  "no_send_mail": "off", /* on, off */
  "idp_account": "idp-notepm",
  "sso_enabled": "on" /* on, off */
}

cURLでのリクエスト例

curl -X POST 'https://{チームドメイン}.notepm.jp/api/v1/user' \
-H 'Authorization: Bearer {アクセストークン}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "Aさん",
    "auth_class": "admin",
    "email": "xxx@gmail.com",
    "notification_create_page": "all",
    "notification_update_page": "personal",
    "notification_add_comment": "off",
    "notification_remind_page": "on",
    "notification_remind_file": "off",
    "notification_remind_board": "on",
    "notification_notepm": "off",
    "groups": [
        "グループA",
        "グループB"
    ],
    "draft_auto_save": "on",
    "file_preview": "off",
    "no_send_mail": "off",
    "idp_account": "idp-notepm",
    "sso_enabled": "on"
}'

Response

HTTP/1.1 201 OK
{
  "invite": {
    "email": "xxx@gmail.com",
    "auth_class": "admin",
    "email_send_date": "2020-08-01T10:10:10+09:00",
    "expiration_date": "2020-08-08T10:10:10+09:00"
  },
  "meta": {
  }
}

ユーザー削除

DELETE /api/v1/user/:user_code HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl -X DELETE 'https://{チームドメイン}.notepm.jp/api/v1/user/{ユーザーコード}' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 204 No Content

削除済みユーザーを復元

status: "deleted"のユーザーに対してのみ可能

PATCH /api/v1/user/:user_code/restoration HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl -X PATCH 'https://{チームドメイン}.notepm.jp/api/v1/user/{ユーザーコード}/restoration' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 204 No Content

ユーザー完全削除

status: "deleted"のユーザーに対してのみ可能

完全削除したユーザーは戻せません。
詳しくはこちらをご参照ください。

DELETE /api/v1/user/:user_code/completely HTTP/1.1

Request

パラメータなし

cURLでのリクエスト例

curl -X DELETE 'https://{チームドメイン}.notepm.jp/api/v1/user/{ユーザーコード}/completely' \
-H 'Authorization: Bearer {アクセストークン}'

Response

HTTP/1.1 204 No Content
Trial Document