رفتن به متن مستندات
✦ایران جمینایمستندات فارسی Gemini
فضای کاری
مستندات جمینای/مرجع API
۲۶۸ صفحهٔ کامل فارسینسخهٔ فارسی ذخیره‌شده · دریافت 2026-09-29 · ۱۳ پیوند نامعتبر در منبع
پوشش مجموعه

مرجع API اعتبارنامه‌ها

آخرین به‌روزرسانی منبع: 2026-09-28منبع Google

این متن دربارهٔ API رسمی Google است. نمونه‌کدها و آدرس‌ها بدون تغییر فنی حفظ شده‌اند؛ همهٔ امکانات Google الزاماً در API پل ایران‌جمینای ارائه نمی‌شوند. برای اتصال به پل، راهنمای «مستندات اتصال» فضای کاری را ببینید.

API اعتبارنامه‌ها امکان ایجاد، دریافت، به‌روزرسانی، فهرست‌کردن و حذف اعتبارنامه‌های مدیریت‌شده توسط سرور، مانند کلید API، توکن OAuth2، توکن HTTP Bearer و متغیر محیطی را برای احراز هویت فراخوانی ابزارها و سرورهای MCP فراهم می‌کند.

CreateCredential

post https://generativelanguage.googleapis.com/v1beta/credentials

یک اعتبارنامهٔ جدید ایجاد می‌کند.

بدنهٔ درخواست

ساختار بدنهٔ درخواست به حالت تعاملی انتخاب‌شده بستگی دارد:

EnvironmentVariableConfig

پیکربندی اعتبارنامه‌های مبتنی بر متغیر محیطی.

id string (الزامی)

توضیحی ارائه نشده است.

injection_location InjectionLocation or array (InjectionLocation) (الزامی)

الزامی. محل‌هایی که مقدار متغیر محیطی در درخواست‌های HTTP خروجی درج می‌شود. حداقل یک محل لازم است. یک محل مانند header یا آرایه‌ای از محل‌ها پذیرفته می‌شود.

مقادیر مجاز

  • header

    در هدرهای درخواست HTTP درج می‌شود.

  • query

    در پارامترهای پرس‌وجوی نشانی HTTP درج می‌شود.

  • body

    در بدنهٔ درخواست HTTP درج می‌شود.

trusted_domains array (string) (اختیاری)

اختیاری. فهرست دامنه‌هایی که مجازند مقدار این متغیر محیطی را در درخواست‌های HTTP دریافت کنند.

type object (الزامی)

توضیحی ارائه نشده است.

value string (الزامی)

الزامی و فقط ورودی. مقدار محرمانهٔ متغیر محیطی؛ فقط قابل نوشتن است و هرگز در پاسخ بازگردانده نمی‌شود.

HttpBearerConfig

پیکربندی اعتبارنامه‌های توکن HTTP Bearer.

header_name string (اختیاری)

اختیاری. نام هدر محل درج توکن؛ مقدار پیش‌فرض Authorization است.

id string (الزامی)

توضیحی ارائه نشده است.

prefix string (اختیاری)

اختیاری. پیشوندی که قبل از توکن قرار می‌گیرد؛ مقدار پیش‌فرض Bearer است. برای حذف پیشوند، رشتهٔ خالی قرار دهید.

token string (الزامی)

الزامی و فقط ورودی. توکن ثابت Bearer؛ فقط قابل نوشتن است و هرگز در پاسخ بازگردانده نمی‌شود.

type object (الزامی)

توضیحی ارائه نشده است.

OAuth2Config

پیکربندی اعتبارنامه‌های OAuth2 با نوسازی خودکار توکن.

client_id string (الزامی)

الزامی. شناسهٔ کلاینت OAuth2.

client_secret string (الزامی)

الزامی و فقط ورودی. رمز محرمانهٔ کلاینت OAuth2؛ فقط قابل نوشتن است و هرگز در پاسخ بازگردانده نمی‌شود.

id string (الزامی)

توضیحی ارائه نشده است.

refresh_token string (الزامی)

الزامی و فقط ورودی. توکن نوسازی OAuth2؛ فقط قابل نوشتن است و هرگز در پاسخ بازگردانده نمی‌شود.

scopes array (string) (اختیاری)

اختیاری. فهرست دامنه‌های دسترسی OAuth2.

token_url string (الزامی)

الزامی. نشانی endpoint توکن OAuth2 برای نوسازی توکن‌های دسترسی.

type object (الزامی)

توضیحی ارائه نشده است.

پاسخ

در صورت موفقیت، بدنهٔ پاسخ شامل داده‌ای با ساختار زیر است:

create_time string (اختیاری)

فقط خروجی. زمان ایجاد اعتبارنامه.

id string (اختیاری)

الزامی و فقط خروجی. شناسهٔ یکتای اعتبارنامه.

status enum (string) (اختیاری)

فقط خروجی. وضعیت فعلی اعتبارنامه.

مقادیر مجاز:

  • active

    اعتبارنامه فعال است و برای استفاده اعتبار دارد.

  • revoked

    اعتبارنامه لغو شده و دیگر معتبر نیست.

type enum (string) (اختیاری)

الزامی و فقط خروجی. نوع اعتبارنامه.

مقادیر مجاز:

  • bearer_token

    توکن ثابت در هدر درج می‌شود و سازوکار نوسازی ندارد.

  • oauth2

    توکن‌های دسترسی منقضی‌شده با استفاده از توکن نوسازی ذخیره‌شده، خودکار نوسازی می‌شوند.

  • environment_variable

    متغیر محیطی در کانتینر محیط ایزوله درج می‌شود.

update_time string (اختیاری)

فقط خروجی. زمان آخرین به‌روزرسانی اعتبارنامه.

مثال

رسانهٔ این بخش در منبع اصلی (مجوز جداگانه) ↗

نمونهٔ پاسخ

{
  "create_time": "string",
  "id": "string",
  "status": "active",
  "type": "bearer_token",
  "update_time": "string"
}

ListCredentials

get https://generativelanguage.googleapis.com/v1beta/credentials

اعتبارنامه‌ها را فهرست می‌کند.

پارامترهای مسیر و پرس‌وجو

page_size integer (اختیاری)

اختیاری. حداکثر تعداد اعتبارنامه‌های بازگردانده‌شده.

page_token string (اختیاری)

اختیاری. توکن صفحه‌بندی.

پاسخ

در صورت موفقیت، بدنهٔ پاسخ شامل داده‌ای با ساختار زیر است:

credentials array (Credential) (اختیاری)

توضیحی ارائه نشده است.

next_page_token string (اختیاری)

توضیحی ارائه نشده است.

مثال

رسانهٔ این بخش در منبع اصلی (مجوز جداگانه) ↗

نمونهٔ پاسخ

{
  "credentials": [
    {
      "create_time": "string",
      "id": "string",
      "status": "active",
      "type": "bearer_token",
      "update_time": "string"
    }
  ],
  "next_page_token": "string"
}

GetCredential

get https://generativelanguage.googleapis.com/v1beta/credentials/{id}

یک اعتبارنامه را با شناسهٔ آن دریافت می‌کند.

پارامترهای مسیر و پرس‌وجو

id string (الزامی)

الزامی. بخش شناسهٔ منبع که name منبع را تشکیل می‌دهد و آن را در مجموعهٔ والد مشخص می‌کند؛ مطابق توضیح https://google.aip.dev/122.

پاسخ

در صورت موفقیت، بدنهٔ پاسخ شامل داده‌ای با ساختار زیر است:

create_time string (اختیاری)

فقط خروجی. زمان ایجاد اعتبارنامه.

id string (اختیاری)

الزامی و فقط خروجی. شناسهٔ یکتای اعتبارنامه.

status enum (string) (اختیاری)

فقط خروجی. وضعیت فعلی اعتبارنامه.

مقادیر مجاز:

  • active

    اعتبارنامه فعال است و برای استفاده اعتبار دارد.

  • revoked

    اعتبارنامه لغو شده و دیگر معتبر نیست.

type enum (string) (اختیاری)

الزامی و فقط خروجی. نوع اعتبارنامه.

مقادیر مجاز:

  • bearer_token

    توکن ثابت در هدر درج می‌شود و سازوکار نوسازی ندارد.

  • oauth2

    توکن‌های دسترسی منقضی‌شده با استفاده از توکن نوسازی ذخیره‌شده، خودکار نوسازی می‌شوند.

  • environment_variable

    متغیر محیطی در کانتینر محیط ایزوله درج می‌شود.

update_time string (اختیاری)

فقط خروجی. زمان آخرین به‌روزرسانی اعتبارنامه.

مثال

رسانهٔ این بخش در منبع اصلی (مجوز جداگانه) ↗

نمونهٔ پاسخ

{
  "create_time": "string",
  "id": "string",
  "status": "active",
  "type": "bearer_token",
  "update_time": "string"
}

UpdateCredential

patch https://generativelanguage.googleapis.com/v1beta/credentials/{id}

یک اعتبارنامه را به‌روزرسانی می‌کند.

پارامترهای مسیر و پرس‌وجو

id string (الزامی)

الزامی. بخش شناسهٔ منبع که name منبع را تشکیل می‌دهد و آن را در مجموعهٔ والد مشخص می‌کند؛ مطابق توضیح https://google.aip.dev/122.

update_mask string (اختیاری)

اختیاری. فهرست فیلدهایی که باید به‌روزرسانی شوند.

بدنهٔ درخواست

ساختار بدنهٔ درخواست به حالت تعاملی انتخاب‌شده بستگی دارد:

EnvironmentVariableUpdateConfig

پیکربندی به‌روزرسانی اعتبارنامه‌های متغیر محیطی.

injection_location InjectionLocation or array (InjectionLocation) (اختیاری)

اختیاری. محل‌های درج متغیر محیطی در درخواست‌های HTTP خروجی؛ یک محل مانند header یا آرایه‌ای از محل‌ها پذیرفته می‌شود.

مقادیر مجاز

  • header

    در هدرهای درخواست HTTP درج می‌شود.

  • query

    در پارامترهای پرس‌وجوی نشانی HTTP درج می‌شود.

  • body

    در بدنهٔ درخواست HTTP درج می‌شود.

trusted_domains array (string) (اختیاری)

اختیاری. فهرست دامنه‌هایی که مجازند مقدار این متغیر محیطی را در درخواست‌های HTTP دریافت کنند.

type object (الزامی)

توضیحی ارائه نشده است.

value string (اختیاری)

اختیاری و فقط ورودی. مقدار محرمانهٔ متغیر محیطی؛ فقط قابل نوشتن است و هرگز در پاسخ بازگردانده نمی‌شود.

HttpBearerUpdateConfig

پیکربندی به‌روزرسانی اعتبارنامه‌های توکن HTTP Bearer.

header_name string (اختیاری)

اختیاری. نام هدر محل درج توکن؛ مقدار پیش‌فرض Authorization است.

prefix string (اختیاری)

اختیاری. پیشوندی که قبل از توکن قرار می‌گیرد؛ مقدار پیش‌فرض Bearer است. برای حذف پیشوند، رشتهٔ خالی قرار دهید.

token string (اختیاری)

اختیاری و فقط ورودی. توکن ثابت Bearer؛ فقط قابل نوشتن است و هرگز در پاسخ بازگردانده نمی‌شود.

type object (الزامی)

توضیحی ارائه نشده است.

OAuth2UpdateConfig

پیکربندی به‌روزرسانی اعتبارنامه‌های OAuth2.

client_id string (اختیاری)

اختیاری. شناسهٔ کلاینت OAuth2.

client_secret string (اختیاری)

اختیاری و فقط ورودی. رمز محرمانهٔ کلاینت OAuth2؛ فقط قابل نوشتن است و هرگز در پاسخ بازگردانده نمی‌شود.

refresh_token string (اختیاری)

اختیاری و فقط ورودی. توکن نوسازی OAuth2؛ فقط قابل نوشتن است و هرگز در پاسخ بازگردانده نمی‌شود.

scopes array (string) (اختیاری)

اختیاری. فهرست دامنه‌های دسترسی OAuth2.

token_url string (اختیاری)

اختیاری. نشانی endpoint توکن OAuth2 برای نوسازی توکن‌های دسترسی.

type object (الزامی)

توضیحی ارائه نشده است.

پاسخ

در صورت موفقیت، بدنهٔ پاسخ شامل داده‌ای با ساختار زیر است:

create_time string (اختیاری)

فقط خروجی. زمان ایجاد اعتبارنامه.

id string (اختیاری)

الزامی و فقط خروجی. شناسهٔ یکتای اعتبارنامه.

status enum (string) (اختیاری)

فقط خروجی. وضعیت فعلی اعتبارنامه.

مقادیر مجاز:

  • active

    اعتبارنامه فعال است و برای استفاده اعتبار دارد.

  • revoked

    اعتبارنامه لغو شده و دیگر معتبر نیست.

type enum (string) (اختیاری)

الزامی و فقط خروجی. نوع اعتبارنامه.

مقادیر مجاز:

  • bearer_token

    توکن ثابت در هدر درج می‌شود و سازوکار نوسازی ندارد.

  • oauth2

    توکن‌های دسترسی منقضی‌شده با استفاده از توکن نوسازی ذخیره‌شده، خودکار نوسازی می‌شوند.

  • environment_variable

    متغیر محیطی در کانتینر محیط ایزوله درج می‌شود.

update_time string (اختیاری)

فقط خروجی. زمان آخرین به‌روزرسانی اعتبارنامه.

مثال

رسانهٔ این بخش در منبع اصلی (مجوز جداگانه) ↗

نمونهٔ پاسخ

{
  "create_time": "string",
  "id": "string",
  "status": "active",
  "type": "bearer_token",
  "update_time": "string"
}

DeleteCredential

delete https://generativelanguage.googleapis.com/v1beta/credentials/{id}

یک اعتبارنامه را حذف می‌کند.

پارامترهای مسیر و پرس‌وجو

id string (الزامی)

الزامی. بخش شناسهٔ منبع که name منبع را تشکیل می‌دهد و آن را در مجموعهٔ والد مشخص می‌کند؛ مطابق توضیح https://google.aip.dev/122.

پاسخ

در صورت موفقیت، پاسخ خالی است.

منابع

Credential

منبع اعتبارنامهٔ مدیریت‌شده توسط سرور که در Secret Manager ذخیره می‌شود.

فیلدها

create_time string (اختیاری)

فقط خروجی. زمان ایجاد اعتبارنامه.

id string (اختیاری)

الزامی و فقط خروجی. شناسهٔ یکتای اعتبارنامه.

status enum (string) (اختیاری)

فقط خروجی. وضعیت فعلی اعتبارنامه.

مقادیر مجاز:

  • active

    اعتبارنامه فعال است و برای استفاده اعتبار دارد.

  • revoked

    اعتبارنامه لغو شده و دیگر معتبر نیست.

type enum (string) (اختیاری)

الزامی و فقط خروجی. نوع اعتبارنامه.

مقادیر مجاز:

  • bearer_token

    توکن ثابت در هدر درج می‌شود و سازوکار نوسازی ندارد.

  • oauth2

    توکن‌های دسترسی منقضی‌شده با استفاده از توکن نوسازی ذخیره‌شده، خودکار نوسازی می‌شوند.

  • environment_variable

    متغیر محیطی در کانتینر محیط ایزوله درج می‌شود.

update_time string (اختیاری)

فقط خروجی. زمان آخرین به‌روزرسانی اعتبارنامه.

منبع، ترجمه و مجوز

متن این صفحه از مستندات Google ترجمه شده است. ترجمهٔ فارسی این صفحه توسط ایران‌جمینای تهیه شده و ممکن است خطا داشته باشد؛ شناسه‌ها، نشانی‌های API و نمونه‌کدها بدون تغییر فنی حفظ شده‌اند.

بازنشر متن طبق CC BY 4.0 و نمونه‌کدها طبق Apache 2.0، با رعایت استثناهای سیاست‌های Google انجام شده است. تغییرات ما: پاک‌سازی اجزای اجرایی، قالب‌بندی راست‌به‌چپ و محلی‌سازی پیوندهای مستندات. تصاویر، صدا، ویدیو و علائم تجاری با مجوز مستقل بازنشر نشده‌اند؛ پیوند منبع رسانه باقی مانده است.

صفحهٔ اصلی: مرجع API اعتبارنامه‌ها

پوشش و وضعیت مجموعه

تمام صفحات HTML راهنماهای /gemini-api/docs و مرجع /api در نقشهٔ سایت رسمی Google، همراه پیوندهای داخلی مقالات؛ متن کامل فارسی و نمونه‌کدها. کتاب‌های آموزشی GitHub، گالری پرامپت، منابع خارجی، آرشیو قراردادهای حقوقی و رسانه‌های دارای مجوز جداگانه جزو بازنشر این مجموعه نیستند.

۲۶۸ صفحه از ۲۸۱ نشانی فهرست‌شده. نشانی‌های قدیمی ممکن است به محتوای یکسان هدایت شوند؛ تعداد بالا تعداد نشانی‌هاست، نه تعداد موضوعات یکتا. این مجموعه نسخهٔ ذخیره‌شده است و به‌روزرسانی زنده نیست.

۱۳ پیوند منبع که متن کامل آن قابل دریافت نیست