> ## Documentation Index
> Fetch the complete documentation index at: https://documents.trocco.io/llms.txt
> Use this file to discover all available pages before exploring further.
# ユーザー作成
> 新規ユーザーを作成して招待メールを送信します。
## OpenAPI
````json POST /api/users
{
"openapi": "3.0.3",
"info": {
"title": "trocco APIリファレンス",
"description": "trocco APIリファレンス",
"version": "0.0.1"
},
"servers": [
{
"url": "https://trocco.io"
}
],
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
{
"name": "users",
"description": "ユーザー",
"externalDocs": {
"url": "https://documents.trocco.io/docs/about-account-user"
}
},
{
"name": "teams",
"description": "チーム",
"externalDocs": {
"url": "https://documents.trocco.io/docs/team"
}
},
{
"name": "connections",
"description": "接続情報",
"externalDocs": {
"url": "https://documents.trocco.io/docs/connection-configurations"
}
},
{
"name": "custom_connectors",
"description": "カスタムコネクタ定義"
},
{
"name": "datamart_definitions",
"description": "データマート定義",
"externalDocs": {
"url": "https://documents.trocco.io/docs/data-mart"
}
},
{
"name": "environment_groups",
"description": "環境グループ"
},
{
"name": "environments",
"description": "環境"
},
{
"name": "jobs",
"description": "転送ジョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/etl-configuration"
}
},
{
"name": "pipeline_jobs",
"description": "ワークフロージョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/about-workflow"
}
},
{
"name": "resource_groups",
"description": "リソースグループ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/resource-group"
}
},
{
"name": "dbt_git_repositories",
"description": "dbt Gitリポジトリ"
},
{
"name": "dbt_job_definitions",
"description": "dbtジョブ設定",
"externalDocs": {
"url": "https://documents.trocco.io/docs/dbt-job-configuration"
}
},
{
"name": "dbt_jobs",
"description": "dbtジョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/dbt-job-configuration"
}
},
{
"name": "notification_destinations",
"description": "通知先",
"externalDocs": {
"url": "https://documents.trocco.io/docs/trocco-tutorial-additional-settings"
}
}
],
"externalDocs": {
"description": "trocco APIについて",
"url": "https://documents.trocco.io/docs/trocco-api"
},
"paths": {
"/api/users": {
"post": {
"summary": "ユーザー作成",
"description": "新規ユーザーを作成して招待メールを送信します。",
"operationId": "createUser",
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"description": "Eメールアドレス",
"type": "string",
"example": "trocco@example.com"
},
"password": {
"description": "初期パスワード。`password_auto_generated` が `false` の場合に必須です。
\n`password_auto_generated` が `true` の場合は送信しないでください。\n",
"type": "string",
"example": "Foobarbaz0123",
"nullable": true
},
"password_auto_generated": {
"description": "初期パスワードを自動生成する。
\n`true` の場合、`password` は不要です。
\n`false` の場合は `password` を必ず指定してください。\n",
"type": "boolean",
"example": true,
"default": false
},
"role": {
"description": "ユーザー権限",
"type": "string",
"enum": [
"admin",
"member"
],
"example": "admin"
},
"can_use_audit_log": {
"description": "監査ログ機能の利用可否
\n監査ログ機能が利用できないアカウントの場合は指定しても反映されません。\n",
"type": "boolean",
"example": false,
"default": false
},
"is_restricted_connection_modify": {
"description": "接続情報の作成・編集・削除の禁止",
"type": "boolean",
"example": false,
"default": false
}
},
"required": [
"email",
"role"
]
}
}
}
},
"responses": {
"201": {
"description": "作成したユーザーの詳細を返します。",
"content": {
"application/json": {
"schema": {
"title": "User",
"type": "object",
"properties": {
"id": {
"description": "ユーザーID",
"type": "integer",
"format": "int64",
"example": 1
},
"email": {
"description": "ユーザーのEメールアドレス",
"type": "string",
"example": "trocco@example.com"
},
"role": {
"description": "ユーザーの権限",
"type": "string",
"enum": [
"super_admin",
"admin",
"member"
],
"example": "admin"
},
"otp_required_for_login": {
"description": "二段階認証（TOTP）の設定有無",
"type": "boolean",
"example": true
},
"can_use_basic_services": {
"description": "TROCCOの基本機能（転送機能等）の利用可否",
"type": "boolean",
"example": true
},
"can_use_data_catalog": {
"description": "COMETA（データカタログ）の利用可否",
"type": "boolean",
"example": false
},
"can_use_audit_log": {
"description": "監査ログ機能の利用可否
\n監査ログ機能が利用できないアカウントの場合はレスポンスに含まれません。\n",
"type": "boolean",
"example": true
},
"is_restricted_connection_modify": {
"description": "接続情報の作成・編集・削除の禁止",
"type": "boolean",
"example": false
},
"teams": {
"description": "所属チーム一覧。所属チームがない場合、またはアカウントでチーム機能が無効な場合は空配列（[]）を返します。\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "チームID",
"type": "integer",
"format": "int64",
"example": 10
},
"name": {
"description": "チーム名",
"type": "string",
"example": "データエンジニアリングチーム"
},
"role": {
"description": "チーム内ロール",
"type": "string",
"enum": [
"team_member",
"team_admin"
],
"example": "team_admin"
}
},
"required": [
"id",
"name",
"role"
]
},
"example": [
{
"id": 10,
"name": "データエンジニアリングチーム",
"role": "team_admin"
}
]
},
"last_sign_in_at": {
"description": "最終ログイン日時",
"type": "string",
"example": "2023-08-22T18:00:00+00:00",
"nullable": true
},
"created_at": {
"description": "ユーザーの登録日時",
"type": "string",
"example": "2023-08-22T18:00:00+00:00"
},
"updated_at": {
"description": "ユーザーの更新日時",
"type": "string",
"example": "2023-08-22T18:00:00+00:00"
}
},
"required": [
"id",
"email",
"role",
"otp_required_for_login",
"can_use_basic_services",
"can_use_data_catalog",
"is_restricted_connection_modify",
"teams",
"last_sign_in_at",
"created_at",
"updated_at"
]
}
}
}
},
"400": {
"description": "不正なリクエストです。\n"
},
"401": {
"description": "ユーザー作成権限がないか、API KEYが不正です。\n"
}
}
}
}
},
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
\nAPI KEYがabc123の場合は、Authorization: Token abc123とします。
\nAPI KEYの作成方法は、TROCCO API KEYの作成を参照ください。\n"
}
}
}
}
````