केटो एपीआई के साथ व्यवस्थापकों का प्रबंधन

यह लेख विभिन्न केटो एपीआई पर चर्चा करता है जो आपको केटो प्रबंधन आवेदन के लिए व्यवस्थापक और व्यवस्थापक भूमिकाएँ प्रबंधित करने देता है। यह एपीआई पुनर्विक्रेता खातों और नियमित खातों दोनों के लिए व्यवस्थापकों का प्रबंधन करने का समर्थन करती है।

addAdmin व्यवस्थापक कॉन्फ़िगरेशन API

addAdmin कॉन्फ़िगरेशन एपीआई केटो प्रबंधन एप्लिकेशन में खाता के लिए नए व्यवस्थापकों का निर्माण करती है।

addAdmin इनपुट पैरामीटर

  • accountId (आवश्यक)

addAdmin तर्क

ये हैं addAdmin कॉन्फ़िगरेशन एपीआई के तर्क:

  • firstName: व्यवस्थापक का पहला नाम (अधिकतम 255 वर्ण) – यह फ़ील्ड आवश्यक है
  • lastName: व्यवस्थापक का अंतिम नाम (अधिकतम 255 वर्ण) – यह फ़ील्ड आवश्यक है
  • email: ईमेल पता, प्रत्येक व्यवस्थापक के लिए अद्वितीय (अधिकतम 255 वर्ण) – यह फ़ील्ड आवश्यक है
  • passwordNeverExpires: बूलियन मान (true/false)। यदि मान true पर सेट है, तो व्यवस्थापक का पासवर्ड कभी समाप्त नहीं होता – यह फ़ील्ड आवश्यक है
  • mfaEnabled: बूलियन मान (true/false)। यदि मान true पर सेट है, तो व्यवस्थापक को Cato प्रबंधन अनुप्रयोग में लॉग इन करने के लिए MFA कोड का उपयोग करना होगा - यह फ़ील्ड आवश्यक है
  • managedRoles: updateAdminRoleInput की श्रृंखला। व्यवस्थापक को सौंपित की गई एक या अधिक भूमिकाओं को परिभाषित करता है। पुनर्विक्रेता व्यवस्थापक के लिए, यह फ़ील्ड उन भूमिकाओं को परिभाषित करता है जो प्रबंधित खातों के लिए व्यवस्थापक को सौंपित हैं। यदि एपीआई कॉल के लिए यह फ़ील्ड परिभाषित नहीं है, तो व्यवस्थापक को दर्शक भूमिका (आईडी 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 कॉन्फ़िगरेशन एपीआई आपको व्यवस्थापक जानकारी अपडेट करने देती है (व्यवस्थापक का ईमेल और आईडी अपडेट नहीं किए जा सकते)।

updateAdmin इनपुट पैरामीटर

  • accountId (आवश्यक)

updateAdmin तर्क

  • adminID (आवश्यक)
  • firstName: व्यवस्थापक का पहला नाम
  • lastName: व्यवस्थापक का अंतिम नाम
  • passwordNeverExpires: बूलियन मान (true/false)। यदि मान true पर सेट है, तो व्यवस्थापक का पासवर्ड कभी समाप्त नहीं होता
  • mfaEnabled: बूलियन मान (true/false)। यदि मान true पर सेट है, तो व्यवस्थापक को Cato प्रबंधन अनुप्रयोग में लॉग इन करने के लिए MFA कोड का उपयोग करना होगा
  • managedRoles: updateAdminRoleInput का संग्रहणी। एक या अधिक भूमिकाएँ परिभाषित करता है जो व्यवस्थापक को दी जाती हैं। रीसेलर व्यवस्थापकों के लिए, यह फ़ील्ड उनके प्रबंधित खातों के लिए व्यवस्थापक को सौंपा गया भूमिकाओं को परिभाषित करता है।
  • 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 कॉन्फ़िगरेशन एपीआई आपको खाता से व्यवस्थापक हटाने देती है।

removeAdmin तर्क

  • accountId (आवश्यक)
  • adminID (आवश्यक)

removeAdmin API उदाहरण

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

व्यवस्थापक केवल-पढ़ने के लिए API

admins केवल-पढ़ने योग्य एपीआई क्वेरी खाता के सभी व्यवस्थापकों के बारे में डेटा लौटाती है, जिनमें शामिल हैं: आईडी, ईमेल, पहला नाम, अंतिम नाम, passwordNeverExpires, mfaEnabled, और भूमिकाएँ।

व्यवस्थापक इनपुट पैरामीटर

  • accountId (आवश्यक)

व्यवस्थापक तर्क

  • id: व्यवस्थापक का Cato ID
  • firstName: व्यवस्थापक का पहला नाम
  • lastName: व्यवस्थापक का अंतिम नाम
  • email: ईमेल पता
  • passwordNeverExpires: बूलियन मान (true/false)। यदि मान true पर सेट है, तो व्यवस्थापक का पासवर्ड कभी समाप्त नहीं होता
  • mfaEnabled: बूलियन मान (true/false)। यदि मान true पर सेट है, तो व्यवस्थापक को Cato प्रबंधन अनुप्रयोग में लॉग इन करने के लिए MFA कोड का उपयोग करना होगा
  • managedRoles: updateAdminRoleInput का संग्रहणी। एक या अधिक भूमिकाएँ परिभाषित करता है जो व्यवस्थापक को दी जाती हैं। रीसेलर व्यवस्थापकों के लिए, यह फ़ील्ड उनके प्रबंधित खातों के लिए व्यवस्थापक को सौंपा गया भूमिकाओं को परिभाषित करता है।
  • 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 केवल-पढ़ने के लिए API

getAdmin केवल-पढ़ने योग्य एपीआई क्वेरी एकल खाता व्यवस्थापक के बारे में जानकारी लौटाती है, जैसे: ईमेल, पहला नाम, अंतिम नाम, passwordNeverExpires, mfaEnabled, और भूमिकाएँ

getAdmin इनपुट पैरामीटर

  • accountId (आवश्यक)
  • adminID (आवश्यक)

getAdmin तर्क

  • firstName: व्यवस्थापक का पहला नाम
  • lastName: व्यवस्थापक का अंतिम नाम
  • email: ईमेल पता
  • passwordNeverExpires: बूलियन मान (true/false)। यदि true पर सेट है, तो व्यवस्थापक का पासवर्ड कभी समाप्त नहीं होता
  • mfaEnabled: बूलियन मान (true/false)। यदि true पर सेट है, तो व्यवस्थापक को Cato प्रबंधन अनुप्रयोग में लॉग इन करने के लिए MFA कोड का उपयोग करना होगा
  • managedRoles: updateAdminRoleInput का संग्रहणी। एक या अधिक भूमिकाएँ परिभाषित करता है जो व्यवस्थापक को दी जाती हैं। रीसेलर व्यवस्थापकों के लिए, यह फ़ील्ड उनके प्रबंधित खातों के लिए व्यवस्थापक को सौंपा गया भूमिकाओं को परिभाषित करता है।
  • 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 केवल-पढ़ने के लिए API

accountRoles एपीआई केवल-पढ़ने की क्वेरी खाता के लिए परिभाषित सभी भूमिकाओं को लौटाती है (कस्टम भूमिकाएँ और पूर्वनिर्धारित भूमिकाएँ)। यह ग्राहकों के लिए आवश्यक है जो addAdmin एपीआई का उपयोग करते हैं, क्योंकि यह एपीआई भूमिकाओं के आईडी दिखाती है (जो कि addAdmin एपीआई द्वारा उपयोग की जाती है)।

accountRoles इनपुट पैरामीटर

  • accountId
  • accountType

    • नियमित (नियमित या प्रबंधित खातों की भूमिकाओं के लिए)
    • रिसेलर (रीसेलर खाता भूमिकाओं के लिए)

accountRoles तर्क

   id: ID! (भूमिका की id)
   name: String! (भूमिका का नाम)
   विवरण: String (विवरण)
   isPredefined: Boolean! (क्या यह एक पूर्वनिर्धारित या एक कस्टम भूमिका है)
image4.png

accountRoles क्वेरी उदाहरण

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

updateAdminRoleInput कॉन्फ़िगरेशन API

updateAdminRoleInput कॉन्फ़िगरेशन एपीआई आपको केटो प्रबंधन एप्लिकेशन के लिए व्यवस्थापक भूमिका की सेटिंग्स अपडेट करने देती है।

input updateAdminRoleInput {
  भूमिका: updateAccountRoleInput!
  allowedEntities: [entityInput!]
}

क्या यह लेख उपयोगी था?

0 में से 0 के लिए उपयोगी रहा

0 टिप्पणियां