Organization の操作¶

このページでは、Mapray Cloud API を使った Organization の作成・更新・削除と、Organization メンバーの招待・更新・削除について説明します。

Organization についての詳細は、Organization のドキュメントをご参照ください。

Organization の操作には User Token を、Organization メンバーの操作には Organization Token をそれぞれ利用するので事前に作成しておいてください。各 Token の作成方法と利用方法は以下をご参照ください。

Organization の作成¶

Organization 作成 API を利用すると、新たに Organization を作成することができます。

Organization を作成すると、作成者が管理者として Organization に所属している状態になります。

リクエスト例¶

curl --request POST 'https://api.mapray.com/organizations/v2/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <User Token>' \
--data-raw '{
    "name": "organization name",
}'

Organization の更新¶

Organization 更新 API を利用すると、Organization の情報を更新することができます。

使用する User Token の持ち主は、対象 Organization の管理者である必要があります。

リクエスト例¶

curl --request PATCH 'https://api.mapray.com/organizations/v2/<Organization ID>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <User Token>' \
--data-raw '{
    "name": "new organization name",
}'

Organization の削除¶

Organization 削除 API を利用すると、Organization を削除することができます。

使用する User Token の持ち主は、対象 Organization の管理者である必要があります。

Organization を削除すると、Organization に紐づくデータセットと Organization Token が全て削除されます。復旧はできないのでご注意ください。

リクエスト例¶

curl --request DELETE 'https://api.mapray.com/organizations/v2/<Organization ID>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <User Token>'

Organization メンバー¶

Organization Token を利用すると、Organization のメンバーを管理することができます。

Organization メンバーの招待¶

Organization メンバー招待 API を利用すると、Organization にメンバーを招待することができます。招待時には対象のユーザー ID と Organization におけるロールを指定する必要があります。

招待されたメンバーは Mapray Cloud の UI 上から招待を承諾することで、Organization に参加することができます。

リクエスト例¶

curl --request POST 'https://api.mapray.com/organizations/v2/members' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Organization Token>' \
--data-raw '{
    "role": "user",
    "user_id": "1234567890123456"
}'

Organization メンバーの更新¶

Organization メンバー更新 API を利用すると、Organization メンバーのロールを変更することができます。

ロールをadminからuserへ変更する場合は、そのメンバーが唯一のadminではないことを確認してください。他のadminメンバーが存在しない場合は、ロールの更新はできません。

リクエスト例¶

curl --request PATCH 'https://api.mapray.com/organizations/v2/members/<User ID>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Organization Token>' \
--data-raw '{
    "role": "admin",
}'

Organization メンバーの削除¶

Organization メンバー削除 API を利用すると、Organization メンバーを Organization から脱退させることができます。

対象のメンバーが唯一のadminである場合は、脱退させることができません。他のメンバーをadminに変更してから、脱退させてください。

リクエスト例¶

curl --request DELETE 'https://api.mapray.com/organizations/v2/members/<User ID>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <Organization Token>'