Post
/api/users
新規ユーザーを作成して招待メールを送信します。
Security
API Key: ApiKeyAuth
Header parameter nameAuthorization
認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。
API KEYの作成方法は、TROCCO API KEYの作成を参照ください。
Body parameters
object
email
string Required
Eメールアドレス
Exampletrocco@example.com
password
string | null
初期パスワード。password_auto_generated が false の場合に必須です。
password_auto_generated が true の場合は送信しないでください。
ExampleFoobarbaz0123
password_auto_generated
boolean
初期パスワードを自動生成する。
true の場合、password は不要です。
false の場合は password を必ず指定してください。
Defaultfalse
Exampletrue
role
string Required
ユーザー権限
Valid values[
"admin",
"member"
]
Exampleadmin
can_use_audit_log
boolean
監査ログ機能の利用可否
監査ログ機能が利用できないアカウントの場合は指定しても反映されません。
Defaultfalse
Examplefalse
is_restricted_connection_modify
boolean
接続情報の作成・編集・削除の禁止
Defaultfalse
Examplefalse
Responses
201
作成したユーザーの詳細を返します。
object
id
integer (int64)
ユーザーID
Example1
email
string
ユーザーのEメールアドレス
Exampletrocco@example.com
role
string
ユーザーの権限
Valid values[
"super_admin",
"admin",
"member"
]
Exampleadmin
otp_required_for_login
boolean
二段階認証（TOTP）の設定有無
Exampletrue
can_use_basic_services
boolean
TROCCOの基本機能（転送機能等）の利用可否
Exampletrue
can_use_data_catalog
boolean
COMETA（データカタログ）の利用可否
Examplefalse
can_use_audit_log
boolean
監査ログ機能の利用可否
監査ログ機能が利用できないアカウントの場合はレスポンスに含まれません。
Exampletrue
is_restricted_connection_modify
boolean
接続情報の作成・編集・削除の禁止
Examplefalse
teams
Array of object
所属チーム一覧。所属チームがない場合は空配列（[]）を返します。
Example[
{
"id": 10,
"name": "データエンジニアリングチーム",
"role": "team_admin"
}
]
object
id
integer (int64)
チームID
Example10
name
string
チーム名
Exampleデータエンジニアリングチーム
role
string
チーム内ロール
Valid values[
"team_member",
"team_admin"
]
Exampleteam_admin
last_sign_in_at
string | null
最終ログイン日時
Example2023-08-22T18:00:00+00:00
created_at
string
ユーザーの登録日時
Example2023-08-22T18:00:00+00:00
updated_at
string
ユーザーの更新日時
Example2023-08-22T18:00:00+00:00
400
不正なリクエストです。
401
ユーザー作成権限がないか、API KEYが不正です。