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

GET/v1/groups

แสดงรายการกลุ่มขององค์กร

list_groups

เมื่อไม่มี kind จะส่งคืนกลุ่มทั่วไป “All members” และกลุ่มตามบทบาท กลุ่มส่วนตัว (single_user) ส่งคืนเฉพาะเมื่อระบุ kind=single_user อย่างชัดเจน สมาชิกของกลุ่ม all_members role และ single_user คำนวณจากผู้ใช้ขององค์กร และ members_count ของกลุ่มเหล่านี้ก็เช่นกัน

การยืนยันตัวตน

ส่งคีย์ API ในเฮดเดอร์ Authorization: Authorization: Bearer <คีย์>

พารามิเตอร์คิวรี

  • kindGroupKind
  • limitinteger

    ขนาดหน้า ถ้าไม่มี limit และ cursor จะส่งคืนรายการทั้งหมด ถ้ามีจะส่งคืนไม่เกิน limit รายการ และแจ้งหน้าถัดไปในเฮดเดอร์ Link (rel="next") และ X-Next-Cursor

    ≥ 1, ≤ 200

  • cursorstring

    เคอร์เซอร์ของหน้าถัดไปจาก X-Next-Cursor หรือ next_cursor ของการตอบกลับก่อนหน้าที่ใช้ตัวกรองเดียวกัน เคอร์เซอร์มีขนาดหน้าอยู่ในตัว ถ้าใช้ร่วมกับ offset: 422 validation.failed ถ้าเป็นเคอร์เซอร์ของรายการอื่น ของตัวกรองอื่น หรือมีรูปแบบผิด: 400 api.cursor_invalid

    length ≤ 512

  • updated_sincestring (date-time)

    เฉพาะออบเจ็กต์ที่มี updated_at ตรงกับหรือหลังเวลานี้ (RFC 3339 พร้อมออฟเซ็ต) สำหรับการซิงก์ เมื่อระบุพารามิเตอร์นี้ รายการจะเรียงตาม updated_at จากน้อยไปมาก แล้วตาม id และเคอร์เซอร์จะไล่ต่อตามลำดับนั้น ออบเจ็กต์ที่ลบแล้วไม่อยู่ในรายการ: การลบแจ้งมาเป็นอีเวนต์

    length ≤ 512

การตอบกลับ

200การตอบกลับเมื่อสำเร็จ

เฮดเดอร์การตอบกลับ

  • Link

    ที่อยู่ของหน้าถัดไป <…>; rel="next" ถ้าไม่มีเฮดเดอร์นี้แสดงว่าเป็นหน้าสุดท้าย

  • X-Next-Cursor

    เคอร์เซอร์ของหน้าถัดไปสำหรับพารามิเตอร์ cursor ถ้าไม่มีเฮดเดอร์นี้แสดงว่าเป็นหน้าสุดท้าย

  • RateLimit-Policy

    ขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค "<name>";q=<quota>;w=<window in seconds> โดย key คืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือ user และเมื่อไม่มีข้อมูลรับรองคือ ip) ส่วน minute day และ month คือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTC

  • RateLimit

    ส่วนที่เหลือของแต่ละขีดจำกัดใน RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>

  • X-RateLimit-Limit

    ขีดจำกัดของรายการที่เข้มงวดที่สุดใน RateLimit-Policy (รายการที่เหลือคำขอน้อยที่สุด)

  • X-RateLimit-Remaining

    จำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด

  • X-RateLimit-Reset

    จำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต

application/json

ออบเจ็กต์: GroupList

array of Group
  • idintegerจำเป็น
  • org_idintegerจำเป็น
  • keystringจำเป็น

    คีย์ที่คงที่: all role:<role> user:<id> หรือคีย์ของกลุ่มปกติ หน้าจอแปลชื่อกลุ่มในตัวตามคีย์

  • titlestringจำเป็น
  • kindGroupKindจำเป็น
  • user_idinteger | nullจำเป็น

    เฉพาะกลุ่มส่วนตัว

  • role_keyRole | nullจำเป็น

    เฉพาะกลุ่มตามบทบาท

  • managed_byGroupManagedByจำเป็น
  • members_countintegerจำเป็น

    จำนวนสมาชิกที่ใช้งานอยู่ ผู้ใช้ที่ปิดการใช้งานแล้วไม่ได้เป็นสมาชิกของกลุ่ม

  • disabledbooleanจำเป็น

    กลุ่มส่วนตัวของผู้ใช้ที่ปิดการใช้งานแล้ว: การกำหนดสิทธิ์ของกลุ่มยังคงอยู่แต่ไม่มีผลขณะที่ผู้ใช้ไม่ได้ใช้งาน เป็น false สำหรับกลุ่มอื่นทั้งหมด

  • created_atstring (date-time)จำเป็น
  • updated_atstring (date-time)จำเป็น
401ไม่ได้ส่งข้อมูลรับรอง (ไม่มีทั้งคุกกี้เซสชันและคีย์ API) หรือไม่พบคีย์

เฮดเดอร์การตอบกลับ

  • RateLimit-Policy

    ขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค "<name>";q=<quota>;w=<window in seconds> โดย key คืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือ user และเมื่อไม่มีข้อมูลรับรองคือ ip) ส่วน minute day และ month คือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTC

  • RateLimit

    ส่วนที่เหลือของแต่ละขีดจำกัดใน RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>

  • X-RateLimit-Limit

    ขีดจำกัดของรายการที่เข้มงวดที่สุดใน RateLimit-Policy (รายการที่เหลือคำขอน้อยที่สุด)

  • X-RateLimit-Remaining

    จำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด

  • X-RateLimit-Reset

    จำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต

application/json

ออบเจ็กต์: Error

422ข้อผิดพลาดในการตรวจความถูกต้องของข้อมูล: เนื้อหาหรือพารามิเตอร์ไม่ตรงกับสคีมา (`detail` เป็นรายการข้อผิดพลาดในการตรวจความถูกต้อง) หรือค่าพารามิเตอร์อยู่นอกช่วงที่กำหนด (`detail` เป็นข้อความ)

เฮดเดอร์การตอบกลับ

  • RateLimit-Policy

    ขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค "<name>";q=<quota>;w=<window in seconds> โดย key คืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือ user และเมื่อไม่มีข้อมูลรับรองคือ ip) ส่วน minute day และ month คือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTC

  • RateLimit

    ส่วนที่เหลือของแต่ละขีดจำกัดใน RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>

  • X-RateLimit-Limit

    ขีดจำกัดของรายการที่เข้มงวดที่สุดใน RateLimit-Policy (รายการที่เหลือคำขอน้อยที่สุด)

  • X-RateLimit-Remaining

    จำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด

  • X-RateLimit-Reset

    จำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต

application/json

ออบเจ็กต์: Error

429คำขอมากเกินไป (`api.rate_limited`) โควตาขององค์กรสำหรับนาที วัน หรือเดือนหมดแล้ว (`api.quota_exceeded` โดย `error.details` มี `quota` `limit` และ `reset_at`) องค์กรใช้ถึงขีดจำกัดแล้ว หรือบริการคำตอบไม่ว่าง (`answers.engine_busy`) รอตามเวลาในเฮดเดอร์ `Retry-After`

เฮดเดอร์การตอบกลับ

  • Retry-After

    จำนวนวินาทีที่ต้องรอก่อนลองส่งคำขอใหม่

  • RateLimit-Policy

    ขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค "<name>";q=<quota>;w=<window in seconds> โดย key คืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือ user และเมื่อไม่มีข้อมูลรับรองคือ ip) ส่วน minute day และ month คือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTC

  • RateLimit

    ส่วนที่เหลือของแต่ละขีดจำกัดใน RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>

  • X-RateLimit-Limit

    ขีดจำกัดของรายการที่เข้มงวดที่สุดใน RateLimit-Policy (รายการที่เหลือคำขอน้อยที่สุด)

  • X-RateLimit-Remaining

    จำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด

  • X-RateLimit-Reset

    จำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต

application/json

ออบเจ็กต์: Error

รหัสข้อผิดพลาด

รหัสที่เอนด์พอยต์นี้อาจส่งคืนใน error.code นอกเหนือจากรหัสทั่วไปของทุกคำขอ

ขีดจำกัดอัตราการเรียก

การตอบกลับมีเฮดเดอร์ RateLimit และ RateLimit-Policy รวมถึงเฮดเดอร์แบบเดิม X-RateLimit-Limit X-RateLimit-Remaining และ X-RateLimit-Reset การตอบกลับ 429 มี Retry-After เป็นวินาที ให้รอตามนั้นแล้วลองใหม่

← groups · เอกสารอ้างอิง API