Press CTRL+K to open search

Cato APIで管理者の管理

  • 更新日 Jul 30, 2026
  • 公開日 Jun 24, 2026
  • 1 分で読めます
Prev Next

この記事では、管理者およびCato管理アプリケーションの管理者ロールを管理するためのさまざまなCato APIについて説明します。 このAPIは、リセラーアカウントと通常のアカウントの両方の管理者の管理をサポートします。

addAdmin構成API

addAdmin構成APIは、Cato管理アプリケーションのアカウントに対して新しい管理者を作成します。

addAdmin入力パラメーター

  • アカウントID（必須）

addAdmin引数

これらはaddAdmin構成APIの引数です：

  • firstName: 管理者の名（最大255文字） - このフィールドは必須

  • lastName: 管理者の姓（最大255文字） - このフィールドは必須

  • email: 電子メールアドレス、管理者ごとに一意（最大255文字） - このフィールドは必須

  • passwordNeverExpires: ブール値（true/false）。 値がtrueに設定されている場合、管理者のパスワードは期限切れになりません - このフィールドは必須

  • mfaEnabled: ブール値（true/false）。 値がtrueに設定されている場合、管理者はCato管理アプリケーションにログインするためにMFAコードを使用する必要があります - このフィールドは必須

  • managedRoles: updateAdminRoleInputの配列。 管理者に割り当てられた一つまたは複数のロールを定義します。 リセラー管理者の場合、このフィールドは管理対象アカウントに割り当てられたロールを定義します。 このフィールドがAPIコールで定義されていない場合、管理者には閲覧者ロール（ID 2）が割り当てられます

    • ID 1を使用して管理者に編集者ロールを割り当てます

  • resellerRoles: updateAdminRoleInputの配列（リセラー管理者にのみ関連があります）。 リセラーアカウントに割り当てられたロールを定義します。 このフィールドがAPIコールで定義されていない場合、管理者にはリセラーアカウントの閲覧者ロールが割り当てられます。

管理者が作成されると、その流れはCato管理アプリケーションに作成された場合と同じです。

アカウントがユーザ名とパスワードで管理者がログインできるように設定されている場合、管理者はアカウントを有効化してパスワードを設定するリンクが記載されたウェルカムメールを受け取ります。

image1.png

addAdmin APIの例

mutation  {
  管理者(accountId:"xxxxxx") {
    addAdmin(input: {
      firstName :"dani2",
      lastName :"din2"
      電子メール: "danidin5@4.catoneworks.com",
      passwordNeverExpires: true,
      mfaEnabled: false,
      managedRoles: [{ ロール: { id: 2} }, {ロール: {id:3}}]
    }) {
        adminID
    }
  }
}

image2.png

image3.png

updateAdmin構成API

updateAdmin構成APIを使用すると、管理者情報を更新できます（管理者の電子メールおよびIDは更新できません）。

updateAdmin入力パラメーター

  • アカウントID（必須）

updateAdmin引数

  • adminID（必須）

  • firstName: 管理者の名

  • lastName: 管理者の姓

  • passwordNeverExpires: ブール値（true/false）。 値がtrueに設定されている場合、管理者のパスワードは期限切れになりません

  • mfaEnabled: ブール値（true/false）。 値がtrueに設定されている場合、管理者はCato管理アプリケーションにログインするためにMFAコードを使用する必要があります

  • managedRoles: updateAdminRoleInputの配列。 管理者に割り当てられた一つまたは複数のロールを定義します。 リセラー管理者の場合、このフィールドは管理対象アカウントに割り当てられたロールを定義します。

  • resellerRoles: updateAdminRoleInputの配列（リセラー管理者にのみ関連があります）。 リセラーアカウントに割り当てられたロールを定義します。

updateAdmin APIの例

mutation {
  管理者(accountId: "26") {
    updateAdmin(
      adminID: "28876"
      input: {
        firstName: "sample"
        lastName: "admin"
        passwordNeverExpires: true
        managedRoles: [{ ロール: { id: 1 } }]
      }
    ) {
      adminID
    }
  }
}

updateAdmin.png

removeAdmin

removeAdmin構成APIを使用すると、アカウントから管理者を削除できます。

removeAdmin引数

  • アカウントID（必須）

  • adminID（必須）

removeAdmin APIの例

mutation  {
  管理者(accountId:"XXX") {
    removeAdmin(adminID:YYY
    ) {
        adminID
    }
  }
}

adminsリードオンリーAPI

adminsリードオンリーAPIクエリは、アカウントのすべての管理者に関するデータを返します。具体的には、ID、電子メール、名、姓、passwordNeverExpires、mfaEnabled、およびロールを含みます。

admins入力パラメーター

  • アカウントID（必須）

admins引数

  • id: 管理者のCato ID

  • firstName: 管理者の名

  • lastName: 管理者の姓

  • email: 電子メールアドレス

  • passwordNeverExpires: ブール値（true/false）。 値がtrueに設定されている場合、管理者のパスワードは期限切れになりません

  • mfaEnabled: ブール値（true/false）。 値がtrueに設定されている場合、管理者はCato管理アプリケーションにログインするためにMFAコードを使用する必要があります

  • managedRoles: updateAdminRoleInputの配列。 管理者に割り当てられた一つまたは複数のロールを定義します。 リセラー管理者の場合、このフィールドは管理対象アカウントに割り当てられたロールを定義します。

  • resellerRoles: updateAdminRoleInputの配列（リセラー管理者にのみ関連があります）。 リセラーアカウントに割り当てられたロールを定義します。

admins APIの例

query {
  管理者(accountID: XXXX) {
    アイテム {
      ID
      電子メール
      First Name
      Last Name
      modifyDate
      creationDate
      passwordNeverExpires
      mfaEnabled
      managedRoles {
        ロール {
          ID
          名前
        }
	resellerRoles {
        ロール {
          ID
          名前
        }
      }
    }
  }
}

admins.png

getAdminリードオンリーAPI

getAdmin読み取り専用APIクエリは、単一のアカウントの管理者についての情報を返します。具体例としては、電子メール、名、姓、passwordNeverExpires、mfaEnabled、およびロールが含まれます。

getAdmin入力パラメーター

  • アカウントID（必須）

  • adminID（必須）

getAdmin引数

  • firstName: 管理者の名

  • lastName: 管理者の姓

  • email: 電子メールアドレス

  • passwordNeverExpires: ブール値（true/false）。 設定がtrueの場合、管理者のパスワードは期限切れになりません

  • mfaEnabled: ブール値（true/false）。 設定がtrueの場合、管理者はCato管理アプリケーションにログインするためにMFAコードを使用する必要があります

  • managedRoles: updateAdminRoleInputの配列。 管理者に割り当てられた一つまたは複数のロールを定義します。 リセラー管理者の場合、このフィールドは管理対象アカウントに割り当てられたロールを定義します。

  • resellerRoles: updateAdminRoleInputの配列（リセラー管理者にのみ関連があります）。 リセラーアカウントに割り当てられたロールを定義します。

getAdmin APIの例

query {
  管理者取得(accountId: "XXX", adminID: YYY) {
    ID
    名
    姓
    電子メール
    passwordNeverExpires
    mfaEnabled
    creationDate
    managedRoles {
      ロール {
        ID
        名前
      }
    }
    resellerRoles {
      ロール {
        ID
        名前
      }
    }
  }
}

getAdmin.png

accountRolesリードオンリーAPI

accountRolesAPIリードオンリークエリは、アカウントに定義されたすべてのロールを返します（カスタムロールと事前定義のもの）。 addAdmin APIを使用する顧客に必須で、これによりロールID（addAdmin APIで使用される）が表示されます。

accountRoles入力パラメーター

  • アカウントID

  • アカウントタイプ

    • 通常（通常または管理されたアカウントロール用）

    • リセラー（リセラーアカウントロール用）

accountRoles引数

   id: ID！ （ロールのID)
   名: String！ （ロールの名前）
   説明: String（説明）
   isPredefined: Boolean！ （これは事前定義されたロールかカスタムロールか）

image4.png

accountRolesクエリの例

query{
  accountRoles(accountID:XXX, accountType:REGULAR)
  {
    アイテム
    {
      ID
      名前
      isPredefined
      説明
    }
    合計
  }
}

updateAdminRoleInput構成API

updateAdminRoleInput構成APIを使用すると、Cato管理アプリケーションの管理者ロール用設定を更新できます。

input updateAdminRoleInput {
  ロール: updateAccountRoleInput！
  allowedEntities: [entityInput！]
}

関連記事