Documentation Powered by ReDoc

eden APIドキュメント (0.1.11)

Download OpenAPI specification:Download

edenを外部サービスと連携させるためのAPI仕様についてのドキュメントです。（現在ベータ版のため、今後仕様が変更される可能性が高いことをご了承ください）

Authentication

ApiKeyAuth

「token accesskey secretkey」の形式

Security Scheme Type API Key
Header parameter name: Authorization

ユーザーの取得

Authorizations:
ApiKeyAuth
path Parameters
userid
required
string

ユーザーIDを指定します。システムID（数値）で指定する場合はそのまま、ユーザーIDを指定する場合はuserid:xxx@example.comという形式になります。（「/users/123」あるいは「users/userid:xxx@example.com」のいずれかということです）

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "usergroups": [
    ],
  • "folder": {
    },
  • "userid": "string",
  • "name": "string",
  • "memo": "string",
  • "activity_permission": "",
  • "locked": true,
  • "active_start_date": "string",
  • "active_end_date": "string",
  • "language": "",
  • "mfa_required": true,
  • "password_change_required": true,
  • "mailaddress": "string"
}

ユーザー一覧の取得

Authorizations:
ApiKeyAuth
query Parameters
include_fullpath_usergroup
boolean

ユーザーグループを常にフルパスで出力するかどうか（trueでない場合は、名前が重複しているユーザーグループのみフルパスで出力される）

include_fullpath_userfolder
boolean

フォルダを常にフルパスで出力するかどうか（trueでない場合は、名前が重複しているフォルダのみフルパスで出力される）

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ユーザーの一括追加・更新・削除

Authorizations:
ApiKeyAuth
query Parameters
dry_run
required
boolean

trueの場合はDBを更新しない（戻り値等は更新したときと同じように戻ってくる）

create_user_if_not_exists
string
Value: true

現状のユーザーDBに存在しないユーザーがアップロードしたリストに含まれている場合に、ユーザーDBに追加するかどうか

create_usergroup_if_not_exists
string
Value: true

現状のユーザーグループDBに存在しないユーザーグループがアップロードしたリストの所属ユーザーグループに含まれている場合に、ユーザーグループDBに追加するかどうか

get_non_listed_existing_users
string
Value: true

「現在のDBには存在するが、アップロードしたリストに存在しないユーザーの一覧」を戻り値に含めるかどうか

Request Body schema:
application/json
application/json
application/ms-excel
Array ()
userid
required
string

ユーザーID（既定ではメールアドレス、アカウント設定によっては半角英数字）。
@edenid:xxxxというフォーマットでeden側で付与しているIDを指定することも可能

password
string

パスワード。新規作成のときは必須、既存ユーザーの場合は変更時のみ指定する。以下の文字列を指定した場合は、リクエスト処理後、それに応じた動作を行う。（新規作成、既存ユーザー変更時のいずれでも利用可能）
@:generate-and-notify - 自動的に仮パスワードを付与し、仮パスワードをメールにて通知する
@:generate-and-notify-if-new - 新規登録時のみ、自動的に仮パスワードを付与し、仮パスワードをメールにて通知する
@:reset-and-notify - パスワードをリセットし（=いったんパスワードでのログインができなくなる）、ログイン画面からパスワードリセットを行うようメールにて通知する
@:reset-and-notify-if-new - 新規登録時のみ、パスワードをリセットし（=いったんパスワードでのログインができなくなる）、ログイン画面からパスワードリセットを行うようメールにて通知する
@:disabled - パスワードによるログインを禁止する（シングルサインオンのみ行ないたい場合等に使用します）

folder
string

フォルダの名前を指定します。

delete
boolean

削除フラグ。trueの場合はユーザーIDを削除する

new_userid
string

ユーザーIDを変更する場合のみ、新しい値を指定する

usergroups
Array of strings

所属ユーザーグループ。ユーザーグループの名称を文字列の配列で指定する（フルパスで指定する場合は「フォルダ名/ユーザーグループ名」とする）

name
string

氏名

memo
string

管理者メモ

activity_permission
string
Enum: "" "read"

フォルダ階層に合わせた履歴アクセス権限を指定します。

locked
boolean

アカウントロック

active_start_date
string

有効期間の開始日

active_end_date
string

有効期間の終了日

language
string
Enum: "" "en-us" "zh-cn"

利用言語

mfa_required
boolean

二要素認証を必須とする

password_change_required
boolean

次回ログイン時にパスワード変更を強制する

mailaddress
string

メールアドレス（ログインID種別が半角英数字のときのみ利用）

Responses

Request samples

Content type
application/json
application/json
application/ms-excel
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "added_users": [
    ],
  • "added_userfolders": [
    ],
  • "added_usergroups": [
    ],
  • "updated_users": [
    ],
  • "deleted_users": [
    ],
  • "non_listed_existing_users": [
    ]
}