オーガニゼーションメンバーに所属するユーザーの一覧
オーガニゼーションにメンバーとして所属するユーザーの一覧を取得します。
GET
/api/v0/users
APIキーに必要な権限
- Read
応答
{ "users": [<user>, <user>, ...] }
<user>
は以下のキーを持つオブジェクト
KEY | TYPE | DESCRIPTION |
---|---|---|
id |
string | ユーザーのid。 |
screenName |
string | ユーザーアカウントの表示名。 |
email |
string | ユーザーのメールアドレス。 |
authority |
string | ユーザーの権限(owner , manager , collaborator , viewer )。 |
isInRegistrationProcess |
boolean | ユーザーが仮登録かどうか。 |
isMFAEnabled |
boolean | ユーザーの2段階認証が有効かどうか。 |
authenticationMethods |
array[string] | ユーザーが利用している認証方式(password , github , idcf , google , nifty , kddi )。 |
joinedAt |
number | ユーザーがオーガニゼーションのメンバーに参加した日時 (epoch秒) |
オーガニゼーションメンバーに所属するユーザーの削除
オーガニゼーションのメンバーに所属するユーザーを削除します。
DELETE
/api/v0/users/<userId>
APIキーに必要な権限
- Read
- Write
応答
成功時
オーガニゼーションのメンバーから削除されたユーザーの情報が返却されます。 形式はオーガニゼーションメンバーに所属するユーザーの一覧で取得できるユーザー形式と同様です。
失敗時
STATUS CODE | DESCRIPTION |
---|---|
400 | JSON のフォーマットが不正であるとき |
403 | APIキーに書き込み権限がないとき / オーガニゼーション作成者を<userId> に指定したとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
404 | 指定された<userId> がオーガニゼーションのメンバーに所属していなかったとき |