KUFU
KUFU カスタム家族項目テンプレート API

カスタム家族項目テンプレートを操作します
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  title: SmartHR カスタム家族項目テンプレート API
  description: SmartHR の各種データを操作する API です
  license:
    name: SmartHR, Inc
  version: 0.0.1
host: app.smarthr.jp
basePath: /api
schemes:
- https
produces:
- application/json;charset=utf-8
tags:
- name: カスタム家族項目テンプレート
  description: カスタム家族項目テンプレートを操作します
paths:
  /v1/dependent_custom_field_templates:
    get:
      summary: リストの取得
      description: 'カスタム家族項目をリストで取得します。

        '
      produces:
      - application/json
      parameters:
      - in: query
        name: page
        description: Page of results to fetch.
        type: integer
        format: int32
        default: 1
        required: false
      - in: query
        name: per_page
        description: Number of results to return per page.
        type: integer
        format: int32
        default: 10
        required: false
      responses:
        '200':
          description: リストの取得
          schema:
            type: array
            items:
              $ref: '#/definitions/DependentCustomFieldTemplate'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1DependentCustomFieldTemplates
  /v1/crew_custom_field_template_groups/{id}:
    get:
      summary: 取得
      description: '指定した ID のカスタム従業員項目グループ情報を取得します。


        `embed=templates` を指定すると、そのグループに属するカスタム項目テンプレート情報も合わせて取得できます。

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: カスタム従業員項目グループID
        type: string
        required: true
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - templates
        required: false
      responses:
        '200':
          description: 取得
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplateGroup'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1CrewCustomFieldTemplateGroupsId
    put:
      summary: 更新
      description: "指定した ID のカスタム従業員項目グループ情報を更新します。\n未指定の属性は情報が削除されます。未指定の属性を消したくない場合は「部分更新」をご利用ください。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n  \"name\": \"string\",\n  \"position\": 0\n}\n```\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - in: path
        name: id
        description: カスタム従業員項目グループID
        type: string
        required: true
      - name: putV1CrewCustomFieldTemplateGroupsId
        in: body
        required: true
        schema:
          $ref: '#/definitions/putV1CrewCustomFieldTemplateGroupsId'
      responses:
        '200':
          description: 更新
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplateGroup'
      tags:
      - カスタム家族項目テンプレート
      operationId: putV1CrewCustomFieldTemplateGroupsId
    patch:
      summary: 部分更新
      description: "指定した ID のカスタム従業員項目グループ情報を部分更新します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n  \"name\": \"string\",\n  \"position\": 0\n}\n```\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - in: path
        name: id
        description: カスタム従業員項目グループID
        type: string
        required: true
      - name: patchV1CrewCustomFieldTemplateGroupsId
        in: body
        required: true
        schema:
          $ref: '#/definitions/patchV1CrewCustomFieldTemplateGroupsId'
      responses:
        '200':
          description: 部分更新
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplateGroup'
      tags:
      - カスタム家族項目テンプレート
      operationId: patchV1CrewCustomFieldTemplateGroupsId
    delete:
      summary: 削除
      description: '指定した ID のカスタム従業員項目グループ情報を削除します。


        **グループに属するカスタム項目テンプレート、およびそれらのテンプレートに対して設定されている値がすべて削除されます。**

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: カスタム従業員項目グループID
        type: string
        required: true
      responses:
        '204':
          description: (no content)
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplateGroup'
      tags:
      - カスタム家族項目テンプレート
      operationId: deleteV1CrewCustomFieldTemplateGroupsId
  /v1/crew_custom_field_template_groups:
    get:
      summary: リスト取得
      description: 'カスタム従業員項目グループをリストで取得します。


        `embed=templates` を指定すると、そのグループに属するカスタム項目テンプレート情報も合わせて取得できます。

        '
      produces:
      - application/json
      parameters:
      - in: query
        name: page
        description: Page of results to fetch.
        type: integer
        format: int32
        default: 1
        required: false
      - in: query
        name: per_page
        description: Number of results to return per page.
        type: integer
        format: int32
        default: 10
        required: false
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - templates
        required: false
      responses:
        '200':
          description: リスト取得
          schema:
            type: array
            items:
              $ref: '#/definitions/CrewCustomFieldTemplateGroup'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1CrewCustomFieldTemplateGroups
    post:
      summary: 登録
      description: "カスタム従業員項目グループを新規登録します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n  \"name\": \"string\",\n  \"position\": 0\n}\n```\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: postV1CrewCustomFieldTemplateGroups
        in: body
        required: true
        schema:
          $ref: '#/definitions/postV1CrewCustomFieldTemplateGroups'
      responses:
        '201':
          description: 登録
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplateGroup'
      tags:
      - カスタム家族項目テンプレート
      operationId: postV1CrewCustomFieldTemplateGroups
  /v1/crew_custom_field_templates:
    get:
      summary: リストの取得
      description: 'カスタム従業員項目をリストで取得します。


        `embed=group` を指定すると、属するカスタム項目グループ情報も合わせて取得できます。（ `group_id` が `group` に置き換わります）

        '
      produces:
      - application/json
      parameters:
      - in: query
        name: page
        description: Page of results to fetch.
        type: integer
        format: int32
        default: 1
        required: false
      - in: query
        name: per_page
        description: Number of results to return per page.
        type: integer
        format: int32
        default: 10
        required: false
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - group
        required: false
      responses:
        '200':
          description: リストの取得
          schema:
            type: array
            items:
              $ref: '#/definitions/CrewCustomFieldTemplate'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1CrewCustomFieldTemplates
    post:
      summary: 登録
      description: "カスタム従業員項目を新規登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n  \"name\": \"身長\",\n  \"type\": \"decimal\",\n  \"scale\": 1\n}\n```\n\nなお、種別がドロップダウンリスト項目（type: enum）の時のみ、 `elements` アトリビュートで要素を指定できます。\n\nJSON 例\n```\n{\n  \"name\": \"血液型\",\n  \"type\": \"enum\",\n  \"elements\": [\n    { \"name\": \"A型\", \"position\": 1 },\n    { \"name\": \"B型\", \"position\": 2 },\n    ...\n  ]\n}\n```\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: postV1CrewCustomFieldTemplates
        in: body
        required: true
        schema:
          $ref: '#/definitions/postV1CrewCustomFieldTemplates'
      responses:
        '201':
          description: 登録
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplate'
      tags:
      - カスタム家族項目テンプレート
      operationId: postV1CrewCustomFieldTemplates
  /v1/crew_custom_field_templates/{id}:
    get:
      summary: 取得
      description: '指定した ID のカスタム従業員項目情報を取得します。


        `embed=group` を指定すると、属するカスタム項目グループ情報も合わせて取得できます。（ `group_id` が `group` に置き換わります）

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: カスタム従業員項目ID
        type: string
        required: true
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - group
        required: false
      responses:
        '200':
          description: 取得
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplate'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1CrewCustomFieldTemplatesId
    put:
      summary: 更新
      description: "指定した ID のカスタム従業員項目情報を更新します。\n未指定の属性は情報が削除されます。未指定の属性を消したくない場合は「部分更新」をご利用ください。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n  \"name\": \"身長\",\n  \"type\": \"decimal\",\n  \"scale\": 1\n}\n```\n\nなお、種別がドロップダウンリスト項目（type: enum）の時のみ、 `elements` アトリビュートで要素を指定できます。\n\n既存の elements 要素を更新する場合は `id` を指定してください。この時、指定されなかった既存の要素はすべて削除されます。\n\nJSON 例\n```\n{\n  \"name\": \"血液型\",\n  \"type\": \"enum\",\n  \"elements\": [\n    { \"id\", 1, \"name\": \"A型\", \"position\": 1 },\n    { \"name\": \"AB型\", \"position\": 3 },\n    ...\n  ]\n}\n```\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - in: path
        name: id
        description: カスタム従業員項目ID
        type: string
        required: true
      - name: putV1CrewCustomFieldTemplatesId
        in: body
        required: true
        schema:
          $ref: '#/definitions/putV1CrewCustomFieldTemplatesId'
      responses:
        '200':
          description: 更新
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplate'
      tags:
      - カスタム家族項目テンプレート
      operationId: putV1CrewCustomFieldTemplatesId
    patch:
      summary: 部分更新
      description: "指定した ID のカスタム従業員項目情報を部分更新します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n  \"name\": \"身長\",\n  \"type\": \"decimal\",\n  \"scale\": 1\n}\n```\n\nなお、種別がドロップダウンリスト項目（type: enum）の時のみ、 `elements` アトリビュートで要素を指定できます。\n\n既存の elements 要素を更新する場合は `id` を指定してください。\n\nJSON 例\n```\n{\n  \"name\": \"血液型\",\n  \"type\": \"enum\",\n  \"elements\": [\n    { \"id\", 1, \"name\": \"A型\", \"position\": 1 },\n    { \"name\": \"AB型\", \"position\": 3 },\n    ...\n  ]\n}\n```\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - in: path
        name: id
        description: カスタム従業員項目ID
        type: string
        required: true
      - name: patchV1CrewCustomFieldTemplatesId
        in: body
        required: true
        schema:
          $ref: '#/definitions/patchV1CrewCustomFieldTemplatesId'
      responses:
        '200':
          description: 部分更新
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplate'
      tags:
      - カスタム家族項目テンプレート
      operationId: patchV1CrewCustomFieldTemplatesId
    delete:
      summary: 削除
      description: '指定した ID のカスタム従業員項目情報を削除します。


        **テンプレートに対して設定されている値がすべて削除されます。**

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: カスタム従業員項目ID
        type: string
        required: true
      responses:
        '204':
          description: (no content)
          schema:
            $ref: '#/definitions/CrewCustomFieldTemplate'
      tags:
      - カスタム家族項目テンプレート
      operationId: deleteV1CrewCustomFieldTemplatesId
  /v1/batch_jobs:
    get:
      summary: リストの取得
      description: 'バックグラウンド処理をリストで取得します。

        '
      produces:
      - application/json
      parameters:
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - attachments
        required: false
      - in: query
        name: sort
        description: 並び順
        type: string
        default: created_at
        enum:
        - created_at
        - -created_at
        - updated_at
        - -updated_at
        required: false
      - in: query
        name: page
        description: Page of results to fetch.
        type: integer
        format: int32
        default: 1
        required: false
      - in: query
        name: per_page
        description: Number of results to return per page.
        type: integer
        format: int32
        default: 10
        required: false
      responses:
        '200':
          description: リストの取得
          schema:
            type: array
            items:
              $ref: '#/definitions/BatchJob'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1BatchJobs
  /v1/batch_jobs/{id}:
    get:
      summary: 取得
      description: '指定した ID のバックグラウンド処理を取得します。

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: BatchJob ID
        type: string
        required: true
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - attachments
        required: false
      responses:
        '200':
          description: 取得
          schema:
            $ref: '#/definitions/BatchJob'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1BatchJobsId
  /v1/batch_jobs/job_types/crew_export:
    post:
      summary: 従業員情報ダウンロードの登録
      description: "バックグラウンド処理（従業員情報ダウンロード）を登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n  \"crew_export_format_id\": \"8d155019-0a3d-4c75-ab5e-8948a0d7b423\"\n}\n```\n\n事前にカスタムダウンロードフォーマットを作成し、その ID を指定してください。ID は URL のパスより確認が可能です。\n\n例: 「/admin/crew_export_formats/8d155019-0a3d-4c75-ab5e-8948a0d7b423」であれば「8d155019-0a3d-4c75-ab5e-8948a0d7b423」\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: postV1BatchJobsJobTypesCrewExport
        in: body
        required: true
        schema:
          $ref: '#/definitions/postV1BatchJobsJobTypesCrewExport'
      responses:
        '201':
          description: 従業員情報ダウンロードの登録
      tags:
      - カスタム家族項目テンプレート
      operationId: postV1BatchJobsJobTypesCrewExport
  /v1/batch_jobs/job_types/crew_import:
    post:
      summary: 従業員一括登録・更新の登録
      description: "バックグラウンド処理（従業員一括登録・更新）を登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n  \"mode\": \"insert\",\n  \"file\": {\n    \"name\": \"sample.csv\",\n    \"content\": \"5YiXMSzliJcyCmEsYgpjLGQKZSxmCg==\"\n  }\n}\n```\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: postV1BatchJobsJobTypesCrewImport
        in: body
        required: true
        schema:
          $ref: '#/definitions/postV1BatchJobsJobTypesCrewImport'
      responses:
        '201':
          description: 従業員一括登録・更新の登録
          schema:
            $ref: '#/definitions/BatchJob'
      tags:
      - カスタム家族項目テンプレート
      operationId: postV1BatchJobsJobTypesCrewImport
  /v1/batch_jobs/job_types/dependent_import:
    post:
      summary: 家族情報一括更新の登録
      description: "バックグラウンド処理（家族情報一括更新）を登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n  \"file\": {\n    \"name\": \"sample.csv\",\n    \"content\": \"5YiXMSzliJcyCmEsYgpjLGQKZSxmCg==\"\n  }\n}\n```\n"
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - name: postV1BatchJobsJobTypesDependentImport
        in: body
        required: true
        schema:
          $ref: '#/definitions/postV1BatchJobsJobTypesDependentImport'
      responses:
        '201':
          description: 家族情報一括更新の登録
          schema:
            $ref: '#/definitions/BatchJob'
      tags:
      - カスタム家族項目テンプレート
      operationId: postV1BatchJobsJobTypesDependentImport
  /v1/batch_job_attachments/{id}/file:
    get:
      summary: ファイル取得
      description: '指定した ID のバックグラウンド処理添付ファイルを取得します。


        取得してから5分後にファイルは削除され、アクセスできなくなります。

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: BatchJobAttachment ID
        type: string
        required: true
      responses:
        '200':
          description: ファイル取得
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1BatchJobAttachmentsIdFile
  /v1/mail_formats:
    get:
      summary: リストの取得
      description: 'メールフォーマット情報をリストで取得します。

        '
      produces:
      - application/json
      parameters:
      - in: query
        name: page
        description: Page of results to fetch.
        type: integer
        format: int32
        default: 1
        required: false
      - in: query
        name: per_page
        description: Number of results to return per page.
        type: integer
        format: int32
        default: 10
        required: false
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - crew_input_forms
        required: false
      responses:
        '200':
          description: リストの取得
          schema:
            type: array
            items:
              $ref: '#/definitions/MailFormat'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1MailFormats
  /v1/mail_formats/{id}:
    get:
      summary: 取得
      description: '指定した ID のメールフォーマット情報を取得します。

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: メールフォーマットID
        type: string
        required: true
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - crew_input_forms
        required: false
      responses:
        '200':
          description: 取得
          schema:
            $ref: '#/definitions/MailFormat'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1MailFormatsId
  /v1/users:
    get:
      summary: リストの取得
      description: "ユーザー情報をリストで取得します。\n\n**招待のステータスについて**\n\nユーザーに送信した招待は項目の値によって以下のように判定できます。\n\n- 従業員登録済み\n    - `invitation_answered_at` に値が入っている\n- ユーザー登録済み\n    - `invitation_created_at` が `null` である\n- 招待メール開封済み\n    - `invitation_opened_at` に値が入っている\n- 招待メール送信済み\n    - `invitation_created_at` に値が入っている\n\n**招待メールの送信エラーについて**\n\nメールフィルターやアドレス不備によって送信されない場合は `suppressed_email_logs` にエラー内容が記載されます。\n\n詳しくは [メールが届かない場合の原因は？](https://support.smarthr.jp/ja/help/articles/360026264593/) をご確認ください。\n\n- bounced\n    - バウンス\n- spam_reported\n    - スパムレポート\n- blocked\n    - ブロック\n- malformed\n    - 無効なメール\n"
      produces:
      - application/json
      parameters:
      - in: query
        name: sort
        description: 並び順
        type: string
        required: false
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - crew
        - biz_establishment
        - biz_establishment_company
        - department_company
        required: false
      - in: query
        name: page
        description: Page of results to fetch.
        type: integer
        format: int32
        default: 1
        required: false
      - in: query
        name: per_page
        description: Number of results to return per page.
        type: integer
        format: int32
        default: 10
        required: false
      responses:
        '200':
          description: リストの取得
          schema:
            type: array
            items:
              $ref: '#/definitions/User'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1Users
  /v1/users/{id}:
    get:
      summary: 取得
      description: '指定した ID のユーザー情報を取得します。

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: ユーザーID
        type: string
        required: true
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - crew
        - biz_establishment
        - biz_establishment_company
        - department_company
        required: false
      responses:
        '200':
          description: 取得
          schema:
            $ref: '#/definitions/User'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1UsersId
  /v1/users/{id}/saml_user:
    get:
      summary: SAML SSOアカウントを取得
      description: '指定した ID のユーザーの「SAML SSOアカウント」を取得します。

        利用には SAML/SSOオプションの契約が必要です。

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: ユーザーID
        type: string
        required: true
      responses:
        '200':
          description: SAML SSOアカウントを取得
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1UsersIdSamlUser
    post:
      summary: SAML SSOアカウントの作成
      description: '指定した ID のユーザーのSAML SSOアカウントを作成します。

        利用には SAML/SSOオプションの契約が必要です。

        '
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - in: path
        name: id
        description: ユーザーID
        type: string
        required: true
      - name: postV1UsersIdSamlUser
        in: body
        required: true
        schema:
          $ref: '#/definitions/postV1UsersIdSamlUser'
      responses:
        '201':
          description: SAML SSOアカウントの作成
          schema:
            $ref: '#/definitions/SamlUser'
      tags:
      - カスタム家族項目テンプレート
      operationId: postV1UsersIdSamlUser
    patch:
      summary: SAML SSOアカウントを更新
      description: '指定した ID のユーザーのSAML SSOアカウントを更新します。

        利用には SAML/SSOオプションの契約が必要です。

        '
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - in: path
        name: id
        description: ユーザーID
        type: string
        required: true
      - name: patchV1UsersIdSamlUser
        in: body
        required: true
        schema:
          $ref: '#/definitions/patchV1UsersIdSamlUser'
      responses:
        '200':
          description: SAML SSOアカウントを更新
          schema:
            $ref: '#/definitions/SamlUser'
      tags:
      - カスタム家族項目テンプレート
      operationId: patchV1UsersIdSamlUser
    delete:
      summary: SAML SSOアカウントを削除
      description: '指定した ID のユーザーのSAML SSOアカウントを削除します。

        利用には SAML/SSOオプションの契約が必要です。

        '
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: ユーザーID
        type: string
        required: true
      responses:
        '204':
          description: SAML SSOアカウントを削除
      tags:
      - カスタム家族項目テンプレート
      operationId: deleteV1UsersIdSamlUser
  /v1/users/{id}/saml_user/enable:
    patch:
      summary: SAML SSOアカウントを有効に変更
      description: '指定した ID のユーザーのSAML SSOアカウントを有効状態に変更します。

        利用には SAML/SSOオプションの契約が必要です。

        '
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - in: path
        name: id
        description: ユーザーID
        type: string
        required: true
      responses:
        '200':
          description: SAML SSOアカウントを有効に変更
      tags:
      - カスタム家族項目テンプレート
      operationId: patchV1UsersIdSamlUserEnable
  /v1/users/{id}/saml_user/disable:
    patch:
      summary: SAML SSOアカウントを無効に変更
      description: '指定した ID のユーザーのSAML SSOアカウントを無効状態に変更します。

        利用には SAML/SSOオプションの契約が必要です。

        '
      produces:
      - application/json
      consumes:
      - application/json
      parameters:
      - in: path
        name: id
        description: ユーザーID
        type: string
        required: true
      responses:
        '200':
          description: SAML SSOアカウントを無効に変更
      tags:
      - カスタム家族項目テンプレート
      operationId: patchV1UsersIdSamlUserDisable
  /v1/biz_establishments:
    get:
      summary: リストの取得
      description: '事業所情報をリストで取得します。

        '
      produces:
      - application/json
      parameters:
      - in: query
        name: page
        description: Page of results to fetch.
        type: integer
        format: int32
        default: 1
        required: false
      - in: query
        name: per_page
        description: Number of results to return per page.
        type: integer
        format: int32
        default: 10
        required: false
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - soc_ins_owner
        - lab_ins_owner
        - company
        required: false
      responses:
        '200':
          description: リストの取得
          schema:
            type: array
            items:
              $ref: '#/definitions/BizEstablishment'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1BizEstablishments
  /v1/companies:
    get:
      summary: リストの取得
      description: '会社情報をリストで取得します。

        '
      produces:
      - application/json
      parameters:
      - in: query
        name: page
        description: Page of results to fetch.
        type: integer
        format: int32
        default: 1
        required: false
      - in: query
        name: per_page
        description: Number of results to return per page.
        type: integer
        format: int32
        default: 10
        required: false
      - in: query
        name: embed
        description: 埋め込むオブジェクト
        type: string
        enum:
        - owner
        required: false
      responses:
        '200':
          description: リストの取得
          schema:
            type: array
            items:
              $ref: '#/definitions/Company'
      tags:
      - カスタム家族項目テンプレート
      operationId: getV1Companies
  /v1/bank_account_se

# --- truncated at 32 KB (315 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kufu/refs/heads/main/openapi/kufu-default-api-openapi.yml
KUFU カスタム家族項目テンプレート API

Documentation

Specifications

Other Resources

OpenAPI Specification
