ข้ามไปยังเนื้อหา
Sursa Developers

ออบเจ็กต์

ApiKeyUpdate

การเปลี่ยนแปลงของคีย์ ฟิลด์ที่ไม่ได้ส่งมาจะคงเดิม และ data_profile ไม่บังคับ รายการ scopes ที่ว่างหมายถึงขอบเขตสิทธิ์ตามบทบาท collection_ids และ allowed_cidrs ที่ว่างหมายถึงไม่จำกัด และ expires_at ที่เป็น null หมายถึงคีย์ไม่มีวันหมดอายุ คีย์ที่มีข้อจำกัดคอลเลกชันเองไม่สามารถยกเลิกหรือขยายข้อจำกัดคอลเลกชัน (collection_ids) ได้

ฟิลด์

  • data_profilestring

    โปรไฟล์ข้อมูลใหม่ของคีย์ โปรไฟล์ข้อมูลไม่มีผลกับบทบาท admin ดังนั้นสำหรับคีย์ของผู้ดูแลระบบ โปรไฟล์อื่นที่ไม่ใช่ full จะส่งคืน 400 api_keys.data_profile_not_applicable

  • scopesarray of ApiKeyScope

    ขอบเขตสิทธิ์ของคีย์ API ไม่ออกขอบเขตสิทธิ์ system ให้

  • collection_idsarray of integer

    จำกัดคีย์ให้ใช้ได้เฉพาะในคอลเลกชันเหล่านี้ รายการว่างหมายถึงไม่จำกัด คีย์ที่เรียกซึ่งมีข้อจำกัดคอลเลกชันเองจะเห็นและเปลี่ยนได้เฉพาะคีย์ที่อยู่ในคอลเลกชันของตน (คีย์อื่นส่งคืน 404 api_keys.not_found) และตั้งค่าได้เฉพาะรายการคอลเลกชันของตนเองที่ไม่ว่าง รายการว่างหรือคอลเลกชันที่อยู่นอกรายการของคีย์ที่เรียกจะส่งคืน 400 api_keys.invalid_collections หากไม่ระบุฟิลด์นี้ คอลเลกชันของคีย์จะคงเดิม

    items ≤ 100

  • allowed_cidrsarray of string

    เครือข่ายที่ใช้คีย์ได้

    items ≤ 50

  • expires_atstring (date-time) | null

    เวลาหมดอายุ (ในอนาคต) null หมายถึงคีย์ไม่มีวันหมดอายุ

ใช้โดย