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)
}
زمینه های
name

string

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

value

string

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

duration

string ( Duration format)

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

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

expirationTimestamp

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

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

object ( User )

کاربر مرتبط با این رمز ثبت نام. اگر مشخص شود که رمز ثبت نام چه زمانی ایجاد می شود و کاربر وجود ندارد، کاربر ایجاد می شود. این فیلد نباید حاوی اطلاعات قابل شناسایی شخصی باشد. فقط باید قسمت accountIdentifier تنظیم شود.

allowPersonalUsage

enum ( AllowPersonalUsage )

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

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

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

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

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

مواد و روش ها

create

 یک نشانه ثبت نام برای یک شرکت معین ایجاد می کند.

delete

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

get

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

list

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