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

GET/.well-known/oauth-authorization-server

ดึงข้อมูลเมตาของเซิร์ฟเวอร์การอนุญาต

get_oauth_server_metadata

ข้อมูลเมตาของเซิร์ฟเวอร์การอนุญาต OAuth 2.0 (RFC 8414): issuer คือที่อยู่หลักของระบบที่ติดตั้ง หน้าขอความยินยอมอยู่บนที่อยู่หลัก ส่วนเอนด์พอยต์ออกโทเค็นและเอนด์พอยต์เพิกถอนโทเค็นอยู่บนที่อยู่ API เฉพาะเมื่อมีการตั้งค่าไว้ แสดงประเภทการให้สิทธิ์ (grant type) วิธี PKCE วิธียืนยันตัวตนของไคลเอ็นต์ และขอบเขตสิทธิ์ที่รองรับ เพิ่มใน 1.62.0

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

ไม่ต้องใช้ข้อมูลรับรอง

การตอบกลับ

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

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

  • 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

ออบเจ็กต์: OAuthServerMetadata

  • issuerstringจำเป็น
  • authorization_endpointstringจำเป็น
  • token_endpointstringจำเป็น
  • revocation_endpointstringจำเป็น
  • response_types_supportedarray of stringจำเป็น
  • grant_types_supportedarray of stringจำเป็น
  • code_challenge_methods_supportedarray of stringจำเป็น
  • token_endpoint_auth_methods_supportedarray of stringจำเป็น
  • revocation_endpoint_auth_methods_supportedarray of stringจำเป็น
  • scopes_supportedarray of stringจำเป็น
  • service_documentationstring

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

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

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