ออบเจ็กต์

ApiKeyCreate

ฟิลด์

• namestringจำเป็น

  length ≥ 1, length ≤ 64

• rolestring

  ค่าเริ่มต้น: "editor"

• data_profilestring | null

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

• expires_atstring (date-time) | null

  เวลาหมดอายุของคีย์ (ISO 8601 เป็นเวลาในอนาคต) null หรือไม่มีค่าหมายถึงคีย์ไม่มีวันหมดอายุ

• scopesarray of ApiKeyScope | null

  ขอบเขตสิทธิ์ของคีย์ ถ้าไม่ระบุ ขอบเขตสิทธิ์จะเป็นไปตามบทบาท: admin ได้ read write และ admin ส่วน editor และ verifier ได้ read และ write และ viewer ได้ read ขอบเขตสิทธิ์ system ออกให้ได้โดยผู้ดูแลระบบของระบบที่ติดตั้งเท่านั้น ระบบยอมรับขอบเขตสิทธิ์แบบละเอียด resource:action (ApiKeyScope) ด้วย ส่วนขอบเขตสิทธิ์แบบเดิม read write และ admin จะขยายเป็นชุดของขอบเขตสิทธิ์

• collection_idsarray of integer | null

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

  items ≤ 100

• allowed_cidrsarray of string | null

  เครือข่ายที่ใช้คีย์ได้ เช่น 10.0.0.0/8 หรือ 2001:db8::/32 ที่อยู่เดี่ยวนับเป็นเครือข่ายที่มีที่อยู่เดียว คำขอจากที่อยู่อื่นได้รับ 403 api_keys.ip_not_allowed ไม่มีค่าหมายถึงไม่จำกัด

  items ≤ 50

ใช้โดย

• POST/v1/api-keysสร้างคีย์ API