REST Resource: enterprises.enrollmentTokens

منبع: EnrollmentToken

یک توکن ثبت نام.

نمایش JSON 
{
  "name": string,
  "value": string,
  "duration": string,
  "expirationTimestamp": string,
  "policyName": string,
  "additionalData": string,
  "qrCode": string,
  "oneTimeOnly": boolean,
  "user": {
    object (User)
  },
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "googleAuthenticationOptions": {
    object (GoogleAuthenticationOptions)
  }
}
فیلدها
name

string

نام توکن ثبت نام، که توسط سرور در حین ایجاد، به شکل enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId} تولید می‌شود.

value

string

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

duration

string ( Duration format)

مدت زمانی که توکن ثبت نام معتبر است، از ۱ دقیقه تا Durations.MAX_VALUE ، تقریباً ۱۰۰۰۰ سال، متغیر است. در صورت عدم تعیین، مدت زمان پیش‌فرض ۱ ساعت است. لطفاً توجه داشته باشید که اگر مدت زمان درخواستی باعث شود که expirationTimestamp حاصل از Timestamps.MAX_VALUE بیشتر شود، expirationTimestamp به Timestamps.MAX_VALUE تغییر می‌کند.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

expirationTimestamp

string ( Timestamp format)

زمان انقضای توکن. این یک فیلد فقط خواندنی است که توسط سرور تولید می‌شود.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

policyName

string

نام سیاستی که در ابتدا برای دستگاه ثبت‌شده اعمال شده است، به شکل enterprises/{enterpriseId}/policies/{policyId} . در صورت عدم مشخص شدن، policyName برای کاربر دستگاه اعمال می‌شود. اگر userName نیز مشخص نشده باشد، enterprises/{enterpriseId}/policies/default به طور پیش‌فرض اعمال می‌شود. هنگام به‌روزرسانی این فیلد، می‌توانید فقط policyId مشخص کنید، مشروط بر اینکه policyId حاوی هیچ اسلشی نباشد. بقیه نام سیاست استنباط خواهد شد.

additionalData

string

داده‌های اختیاری و دلخواه مرتبط با توکن ثبت نام. این می‌تواند شامل، به عنوان مثال، شناسه یک واحد سازمانی باشد که دستگاه پس از ثبت نام به آن اختصاص داده شده است. پس از ثبت نام یک دستگاه با توکن، این داده‌ها در فیلد enrollmentTokenData از منبع Device نمایش داده می‌شوند. داده‌ها باید 1024 کاراکتر یا کمتر باشند. در غیر این صورت، درخواست ایجاد با شکست مواجه خواهد شد.

qrCode

string

یک رشته JSON که نمایش UTF-8 آن می‌تواند برای تولید یک کد QR جهت ثبت دستگاه با این توکن ثبت استفاده شود. برای ثبت دستگاه با استفاده از NFC، رکورد NFC باید حاوی یک نمایش سریالی java.util.Properties از ویژگی‌های موجود در JSON باشد.

oneTimeOnly

boolean

آیا توکن ثبت نام فقط برای یک بار استفاده است یا خیر. اگر پرچم روی true تنظیم شده باشد، فقط یک دستگاه می‌تواند از آن برای ثبت نام استفاده کند.

user
(deprecated)

object ( User )

این فیلد منسوخ شده و مقدار آن نادیده گرفته می‌شود.

allowPersonalUsage

enum ( AllowPersonalUsage )

کنترل می‌کند که آیا استفاده شخصی در دستگاهی که با این توکن ثبت نام ارائه شده است، مجاز است یا خیر.

برای دستگاه‌های متعلق به شرکت:

  • فعال کردن حالت استفاده شخصی به کاربر اجازه می‌دهد تا یک پروفایل کاری روی دستگاه تنظیم کند.
  • غیرفعال کردن استفاده شخصی مستلزم آن است که کاربر دستگاه را به عنوان یک دستگاه کاملاً مدیریت‌شده ارائه دهد.

برای دستگاه‌های شخصی:

  • فعال کردن حالت استفاده شخصی به کاربر اجازه می‌دهد تا یک پروفایل کاری روی دستگاه تنظیم کند.
  • غیرفعال کردن استفاده شخصی مانع از ارائه خدمات به دستگاه می‌شود. امکان غیرفعال کردن استفاده شخصی در دستگاه شخصی وجود ندارد.
googleAuthenticationOptions

object ( GoogleAuthenticationOptions )

اختیاری. گزینه‌های مربوط به احراز هویت گوگل در طول ثبت‌نام.

گزینه‌های احراز هویت گوگل

گزینه‌های احراز هویت گوگل در طول ثبت‌نام.

هنگام فعال‌سازی ثبت‌نام با SigninDetail ، این گزینه‌ها پس از تکمیل ورود به سیستم شخص ثالث توسط کاربر و ایجاد EnrollmentToken اعمال می‌شوند. اگر authenticationRequirement این توکن روی REQUIRED تنظیم شده باشد، این گزینه‌ها با SigninDetail.googleAuthenticationOptions که جریان را آغاز کرده است، به روش‌های زیر تعامل می‌کنند: - اگر کاربر قبلاً از ورود به سیستم با گوگل صرف‌نظر کرده باشد (که توسط SigninDetail.googleAuthenticationOptions مجاز است)، خطایی رخ می‌دهد و از کاربر خواسته می‌شود دوباره وارد سیستم شود. - اگر requiredAccountEmail روی این توکن تنظیم شده باشد و کاربر قبلاً با ایمیل دیگری وارد سیستم شده باشد، خطایی رخ می‌دهد و از کاربر خواسته می‌شود دوباره با حساب صحیح وارد سیستم شود.

نمایش JSON 
{
  "authenticationRequirement": enum (AuthenticationRequirement),
  "requiredAccountEmail": string
}
فیلدها
authenticationRequirement

enum ( AuthenticationRequirement )

اختیاری. مشخص می‌کند که آیا کاربر باید در طول ثبت‌نام با گوگل احراز هویت شود یا خیر. اگر این مقدار روی هر مقداری غیر از AUTHENTICATION_REQUIREMENT_UNSPECIFIED تنظیم شود، تنظیم سطح سازمانی googleAuthenticationSettings برای دستگاه‌های ثبت‌نام‌شده با این توکن نادیده گرفته می‌شود.

requiredAccountEmail

string

اختیاری. حساب گوگل مدیریت‌شده‌ای را که کاربر باید در طول ثبت‌نام از آن استفاده کند، مشخص می‌کند. این فیلد فقط در صورتی قابل تنظیم است که AuthenticationRequirement روی REQUIRED تنظیم شده باشد.

الزامات احراز هویت

مشخص می‌کند که آیا کاربر باید در طول ثبت‌نام با گوگل احراز هویت شود یا خیر. این تنظیم سطح سازمانی googleAuthenticationSettings را لغو می‌کند.

انوم‌ها
AUTHENTICATION_REQUIREMENT_UNSPECIFIED تنظیمات googleAuthenticationSettings برای سازمانی که این توکن ثبت‌نام به آن تعلق دارد، برای تعیین اینکه آیا کاربر در طول ثبت‌نام نیاز به احراز هویت با گوگل دارد یا خیر، استفاده می‌شود.
OPTIONAL احراز هویت گوگل برای کاربر اختیاری است. این بدان معناست که کاربر می‌تواند در هنگام ثبت‌نام، احراز هویت گوگل را نادیده بگیرد.
REQUIRED احراز هویت گوگل برای کاربر الزامی است. این بدان معناست که کاربر برای ادامه باید با یک حساب گوگل احراز هویت شود.

روش‌ها

create

 یک توکن ثبت نام برای یک شرکت مشخص ایجاد می‌کند.

delete

 یک توکن ثبت نام را حذف می‌کند.

get

 یک توکن ثبت‌نام فعال و منقضی نشده دریافت می‌کند.

list

 توکن‌های ثبت‌نام فعال و منقضی نشده برای یک شرکت مشخص را فهرست می‌کند.