Method: verificationCodes.list

הפונקציה מחזירה את הקבוצה הנוכחית של קודי אימות לגיבוי התקפים של המשתמש שצוין.

בקשת HTTP

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}/verificationCodes

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
userKey

string

מזהה את המשתמש בבקשת ה-API. הערך יכול להיות כתובת האימייל הראשית של המשתמש, כתובת אימייל חלופית או מזהה משתמש ייחודי.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

תבנית תגובה בפורמט JSON לפעולת הצגת רשימה של קודי אימות ב-Directory API.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (VerificationCode)
    }
  ]
}
שדות
kind

string

סוג המשאב. הערך הזה הוא תמיד admin#directory#verificationCodesList.

etag

string

ה-ETag של המשאב.

items[]

object (VerificationCode)

רשימה של מקורות מידע על קודי אימות.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/admin.directory.user.security

מידע נוסף זמין במדריך ההרשאות.

VerificationCode

באמצעות Directory API אפשר להציג, ליצור ולבטל קודי אימות לגיבוי של משתמש.

ייצוג ב-JSON
{
  "userId": string,
  "verificationCode": string,
  "kind": string,
  "etag": string
}
שדות
userId

string

המזהה הייחודי המעורפל של המשתמש.

verificationCode

string

קוד אימות נוכחי של המשתמש. קודי אימות שבוטלו או שנעשה בהם שימוש לא מוחזרים כחלק מהתוצאה.

kind

string

סוג המשאב. הערך הזה הוא תמיד admin#directory#verificationCode.

etag

string

ה-ETag של המשאב.