目次 x
      ユーザ登録
        • 印刷する
        目次

        ユーザ登録

          • 印刷する
          記事の要約

          ユーザを登録する。

          HEADER PARAMETERS

          Content-Type

          required

          string
          Value: "application/json"
          リクエストの形式

          Authorization

          required

          string
          認証情報 (付録参照)

          Accept

          required

          string
          Value: "application/json"
          レスポンスの形式

          User-Agent

          required

          string
          ユーザーエージェント（接続元を表す文字列）

          REQUEST BODY SCHEMA: application/json

          login_id

          required

          string <email>

          サインインID (メールアドレス)

          is_external

          integer
          Default: 0
          外部IdPユーザフラグ

          1. iDoperationユーザ

          2. 外部IdPユーザ

          password

          string <= 256 characters
          パスワード
          (iDoperationユーザの場合は必須、外部IdPユーザの場合は無視)

          use_totp

          integer
          Default: 0
          多要素認証利用フラグ
          (外部IdPユーザの場合は無視)

          1. 多要素認証を利用しない

          2. 多要素認証を利用する

          is_password_expired

          integer
          Default: 0
          次回サインイン時パスワード変更要求フラグ
          (外部IdPユーザの場合は無視)

          1. 次回サインイン時にパスワード変更を要求しない

          2. 次回サインイン時にパスワード変更を要求する

          services

          Array of integers
          Default: [1]
          使えるサービス

          1. PAM

          2. EPM

          name

          required

          string <= 64 characters

          ユーザ名

          is_administrator

          integer
          Default: 0
          全権管理者フラグ

          1. 全権管理者でない

          2. 全権管理者である

          is_disabled

          integer
          Default: 0
          サインイン禁止フラグ

          1. サインイン可能

          2. サインイン禁止

          locale

          string
          Default: "ja"
          Enum: "ja" "en"
          通知メール言語

          is_notified

          integer
          Default: 1
          通知メール送信フラグ

          1. 通知メールを送信しない

          2. 通知メールを送信する

          memo

          string <= 512 characters
          メモ

          Array of objects
          ユーザグループ

          Array 

          name

          required

          string

          ユーザグループ名


          Responses

          RESPONSE SCHEMA: application/json

          id

          required

          string <uuid>
          ユーザID

          login_id

          required

          string <email>
          サインインID (メールアドレス)

          is_external

          required

          integer
          外部IdPユーザフラグ

          1. iDoperationのユーザ

          2. 外部アイデンティティプロバイダーのユーザ

          services

          required

          Array of integers
          使えるサービス

          1. PAM

          2. EPM

          name

          required

          string
          ユーザ名

          is_initial_user

          required

          integer
          初期ユーザフラグ

          1. 初期ユーザでない

          2. 初期ユーザである

          is_administrator

          required

          integer
          全権管理者フラグ

          1. 全権管理者でない

          2. 全権管理者である

          logged_in_at

          required

          string or null <date-time>
          最新サインイン日時

          is_disabled

          required

          integer
          サインイン禁止フラグ

          1. サインイン可能

          2. サインイン禁止

          locale

          required

          string
          Enum: "ja" "en"
          通知メール言語

          is_notified

          required

          integer
          通知メール送信フラグ

          1. 通知メールを送信しない

          2. 通知メールを送信する

          memo

          required

          string or null
          メモ

          required

          Array of objects
          ユーザグループ

          Array 

          id

          required

          string <uuid>
          ユーザグループID

          name

          required

          string
          ユーザグループ名


          RESPONSE SCHEMA: application/json

          message

          required

          string

          エラーメッセージ


          Request samples

          Content type

          application/json

          Example

          iDoperationユーザ登録


          {

          • "login_id": "user@example.com",

          • "is_external": 0,

          • "password": "P@ssword1",

          • "use_totp": 0,

          • "services": [

            • 1,

            • 2

            ],

            "is_password_expired": 0,

          • "name": "Sample User",

          • "is_administrator": 0,

          • "is_disabled": 0,

          • "locale": "ja",

          • "is_notified": 1,

          • "memo": "メモ",

          • "user_groups": [

            • {

              • "name": "Root"

              }

            ]

          }

          Content type

          application/json

          Example

          外部IdPユーザ登録

          {

          • "login_id": "idp_user@example.com",

          • "is_external": 1,

          • "name": "IdP User",

          • "is_administrator": 0,

          • "is_disabled": 0,

          • "locale": "ja",

          • "is_notified": 1,

          • "memo": "メモ",

          • "user_groups": [

            • {

              • "name": "Root"

              }

            ]

          }

          Response samples

          Content type

          application/json

          {

          • "id": "df87eb73-9135-41ad-95a7-6954f95e6302",

          • "login_id": "user@example.com",

          • "is_external": 0,

            "services": [

            • 1,

            • 2

            ],

          • "name": "Sample User",

          • "is_initial_user": 0,

          • "is_administrator": 0,

          • "logged_in_at": null,

          • "is_disabled": 0,

          • "locale": "ja",

          • "is_notified": 1,

          • "memo": "メモ",

          • "user_groups": [

            • {

              • "id": "43b8f00b-933f-4a87-b907-3fec64a41f6e",

              • "name": "Root"

              }

            ]

          }


          Content type

          application/json

          {

          • "message": "Error message",

          • "errors": {

            • "key1": [

              • "Error details for key1"

              ],

            • "key2": [

              • "Error details for key2"

              ]

            }

          }


          What's Next
          (c) 2023 - 2026 NTT TechnoCross Corporation