Cato APIを用いた管理者の管理

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

addAdmin 管理者設定 API

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

addAdmin 入力パラメータ

  • accountId (必須)

addAdmin 引数

これらはaddAdmin設定APIの引数です。

  • firstName: 管理者の名 (最大255文字) - この項目は必須です
  • lastName: 管理者の姓 (最大255文字) - この項目は必須です
  • email: 管理者ごとにユニークなメールアドレス (最大255文字) - この項目は必須です
  • passwordNeverExpires: ブール値 (true/false) 値を true に設定すると管理者のパスワードは無期限に有効です - この項目は必須です
  • mfaEnabled: ブール値 (true/false) 値を true に設定した場合、管理者は Cato 管理アプリケーションにログインするために2要素認証コードを使用する必要があります - この項目は必須です
  • managedRoles: updateAdminRoleInputの配列。 管理者に割り当てられる1つ以上のロールを定義します。 リセラー管理者の場合、このフィールドは管理されたアカウントに割り当てられるロールを定義します。 このフィールドがAPI呼び出しに定義されていない場合、管理者にはビューアーロール (ID 2) が割り当てられます。

    • 管理者に編集者役割を割り当てるには、ID 1 を使用してください。
  • resellerRoles: updateAdminRoleInputの配列(リセラー管理者にのみ関連) 管理者がリセラーアカウントに割り当てられたロールを定義します。 このAPIコールで項目が定義されていない場合、管理者はリセラーアカウントの閲覧者ロールが割り当てられます。

管理者が作成されると、フローはCato管理アプリケーションで作成された場合と同様になります。

アカウントがユーザー名とパスワードで管理者ログインを許可するように定義されている場合、管理者はリンク付きの歓迎メールを受け取ります。アカウントをアクティブ化し、パスワードを設定します。

image1.png

addAdmin API 例

mutation  {
  admin(accountId:"xxxxxx") {
    addAdmin(input: {
      firstName :"dani2",
      lastName :"din2"
      email: "danidin5@4catonetworks.com",
      passwordNeverExpires: true,
      mfaEnabled: false,
      managedRoles: [{ role: { id: 2} }, {role: {id:3}}]
    }) {
        adminID
    }
  }
}
image2.png
image3.png

updateAdmin 管理者設定 API

updateAdmin設定APIは、管理者情報を更新できます (管理者のメールおよびIDは更新できません)。

updateAdmin 入力パラメータ

  • accountId (必須)

updateAdmin 引数

  • adminID (必須)
  • firstName: 管理者の名
  • lastName: 管理者の姓
  • passwordNeverExpires: ブール値 (true/false) 値をtrueに設定すると、管理者のパスワードは無期限に有効です
  • mfaEnabled: ブール値 (true/false) 値をtrueに設定すると、管理者はCato管理画面にログインするために2要素認証コードを使用する必要があります
  • managedRoles: updateAdminRoleInputの配列 管理者に割り当てられる1つまたは複数のロールを定義します。 リセラー管理者向けに、このフィールドは管理アカウントに割り当てられるロールを定義します。
  • resellerRoles: updateAdminRoleInputの配列(リセラー管理者にのみ関連) リセラーアカウントに割り当てられた管理者のロールを定義します。

updateAdmin API 例

mutation {
  admin(accountId: "26") {
    updateAdmin(
      adminID: "28876"
      input: {
        firstName: "sample"
        lastName: "admin"
        passwordNeverExpires: true
        managedRoles: [{ role: { id: 1 } }]
      }
    ) {
      adminID
    }
  }
}
updateAdmin.png

removeAdmin

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

removeAdmin 引数

  • accountId (必須)
  • adminID (必須)

removeAdmin API 例

mutation  {
  admin(accountId:"XXX") {
    removeAdmin(adminID:YYY
    ) {
        adminID
    }
  }
}

管理者 Read-Only API

admins読み取り専用APIクエリは、アカウントのすべての管理者に関するデータ(ID、メール、名前、姓、passwordNeverExpires、mfaEnabled、ロールを含む)を返します。

管理者 入力パラメータ

  • accountId (必須)

管理者 引数

  • id: 管理者のCato ID
  • firstName: 管理者の名
  • lastName: 管理者の姓
  • email: メールアドレス
  • passwordNeverExpires: ブール値 (true/false) 値をtrueに設定すると、管理者のパスワードは無期限に有効です
  • mfaEnabled: ブール値 (true/false) 値をtrueに設定すると、管理者はCato管理画面にログインするために2要素認証コードを使用する必要があります
  • managedRoles: updateAdminRoleInputの配列 管理者に割り当てられる1つまたは複数のロールを定義します。 リセラー管理者向けに、このフィールドは管理アカウントに割り当てられるロールを定義します。
  • resellerRoles: updateAdminRoleInputの配列(リセラー管理者にのみ関連) リセラーアカウントに割り当てられた管理者のロールを定義します。

管理者 API 例

query {
  admins(accountID: XXXX) {
    items {
      id
      email
      firstName
      lastName
      modifyDate
      creationDate
      passwordNeverExpires
      mfaEnabled
      managedRoles {
        role {
          id
          name
        }
	resellerRoles {
        role {
          id
          name
        }
      }
    }
  }
}
admins.png

getAdmin Read-Only API

getAdmin読み取り専用APIクエリは、単一アカウント管理者に関する情報(メール、名前、姓、passwordNeverExpires、mfaEnabled、ロールなど)を返します。

getAdmin 入力パラメータ

  • accountId (必須)
  • adminID (必須)

getAdmin 引数

  • firstName: 管理者の名
  • lastName: 管理者の姓
  • email: メールアドレス
  • passwordNeverExpires: ブール値 (true/false) 値を true に設定すると、管理者のパスワードは無期限に有効です
  • mfaEnabled: ブール値 (true/false) 値を true に設定すると、管理者は Cato 管理アプリケーションにログインするために2要素認証コードを使用する必要があります
  • managedRoles: updateAdminRoleInputの配列 管理者に割り当てられる1つまたは複数のロールを定義します。 リセラー管理者向けに、このフィールドは管理アカウントに割り当てられるロールを定義します。
  • resellerRoles: updateAdminRoleInputの配列(リセラー管理者にのみ関連) リセラーアカウントに割り当てられた管理者のロールを定義します。

getAdmin API 例

query {
  getAdmin(accountId: "XXX", adminID: YYY) {
    id
    firstName
    lastName
    email
    passwordNeverExpires
    mfaEnabled
    creationDate
    managedRoles {
      role {
        id
        name
      }
    }
    resellerRoles {
      role {
        id
        name
      }
    }
  }
}
getAdmin.png

accountRoles Read-Only API

accountRoles API読み取り専用クエリは、アカウントに定義されるすべてのロール(カスタムロールと事前定義されたもの)を返します。 addAdmin APIを使用する顧客にとって必要です。このAPIはロールIDを表示するためです (addAdmin APIで使用されます)。

accountRoles 入力パラメータ

  • accountId
  • accountType

    • 通常 (通常または管理対象アカウントの役割用)
    • リセラー (リセラーアカウントロール用)

accountRoles 引数

   id: ID! (ロールのid) 名: String! (ロールの名前) 説明: String (説明) isPredefined: Boolean! (それは定義済みかカスタムロールか)
image4.png

accountRoles クエリエキスル

query{
  accountRoles(accountID:XXX, accountType:REGULAR)
  {
    items
    {
      id
      name
      isPredefined
      description
    }
    total
  }
}

updateAdminRoleInput 設定 API

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

input updateAdminRoleInput {
  role: updateAccountRoleInput!
  allowedEntities: [entityInput!]
}

この記事は役に立ちましたか?

0人中0人がこの記事が役に立ったと言っています

0件のコメント