Тип ресурса invitation

  • Статья

Пространство имен: microsoft.graph

Представляет приглашение, которое используется для добавления внешних пользователей в организацию в рамках совместной работы Microsoft Entra "бизнес-бизнес" (Microsoft Entra B2B).

Процесс приглашения:

  • Создается приглашение.
  • Приглашение с соответствующей ссылкой отправляется пользователю.
  • Пользователь щелкает эту ссылку, выполняет вход и активирует приглашение. На этом создание объекта user, представляющего приглашенного пользователя, завершается.
  • После активации пользователь перенаправляется на определенную страницу.

При создании приглашения возвращается URL-адрес активации в ответе (inviteRedeemUrl). API-интерфейс создания приглашений может автоматически отправить сообщение электронной почты с URL-адресом активации приглашенного пользователя, задав для параметра sendInvitationMessage значение true. Вы также можете настроить сообщение, которое отправляется приглашенной пользователю. Вместо этого, если вы хотите отправить URL-адрес активации с помощью других средств, можно задать для sendInvitationMessage значение false и использовать URL-адрес активации из ответа для создания собственного сообщения. В настоящее время нет API для выполнения процесса активации. Приглашенный пользователь должен щелкнуть ссылку inviteRedeemUrl , отправленную на этапе взаимодействия, и пройти интерактивный процесс активации в браузере. После завершения приглашенный пользователь становится внешним пользователем в организации.

Методы

Метод Возвращаемый тип Описание
Создание приглашений invitation Запись свойств и отношений объекта приглашения.

Свойства

Свойство Тип Описание
invitedUserDisplayName String Отображаемое имя приглашаемого пользователя.
invitedUserEmailAddress String Адрес электронной почты приглашаемого пользователя. Обязательный атрибут. Следующие специальные символы запрещены в адресе электронной почты:
  • Тильда (~)
  • Восклицательный знак (!)
  • Решетка (#)
  • Знак доллара ($)
  • Процент (%)
  • Диакритический знак (^)
  • Амперсанд (&)
  • Звездочка (*)
  • Круглые скобки (( ))
  • Знак "плюс" (+)
  • Знак равенства (=)
  • Квадратные скобки ([ ])
  • Фигурные скобки ({ })
  • Обратная косая черта (\)
  • Косая черта (/)
  • Вертикальная черта (\|)
  • Точка с запятой (;)
  • Двоеточие (:)
  • Кавычки (")
  • Угловые скобки (< >)
  • Вопросительный знак (?)
  • Запятая (,)

Однако применяются следующие исключения:
  • Точка (.) и дефис (-) разрешены в любом месте имени пользователя, кроме его начала и конца.
  • Символ подчеркивания (_) разрешен в любом месте имени пользователя, в том числе в начале или конце имени.
invitedUserMessageInfo invitedUserMessageInfo Дополнительная конфигурация для сообщения, отправляемого приглашенного пользователю, включая настройку текста сообщения, языка и списка получателей cc.
invitedUserType String Элемент userType, связанный с приглашаемым пользователем. По умолчанию это значение равно Guest. Вы можете пригласить, как Member если бы вы являетесь администратором компании.
inviteRedirectUrl String URL-адрес, на который должен быть перенаправлен пользователь после активации приглашения. Обязательно.
inviteRedeemUrl Строка URL-адрес для активации приглашения. Только для чтения.
resetRedemption Логический Сбросьте состояние активации пользователя и повторно введите пользователя, сохраняя его идентификатор пользователя, членство в группах и назначения приложений. Это свойство позволяет пользователю входить в систему, используя адрес электронной почты, отличный от адреса электронной почты в предыдущем приглашении. Дополнительные сведения об использовании этого свойства см. в разделе Сброс состояния активации для гостевого пользователя.
sendInvitationMessage Boolean Указывает, следует ли отправлять письмо приглашаемому пользователю. Значение по умолчанию: false.
status String Состояние приглашения. Возможные значения: PendingAcceptance, Completed, InProgress и Error.

Связи

Связь Тип Описание
invitedUser User Пользователь, созданный в рамках создания приглашения. Только чтение
invitedUserSponsors Коллекция directoryObject Пользователи или группы, являющиеся спонсорами приглашенного пользователя. Спонсоры — это пользователи и группы, которые отвечают за привилегии гостевых пользователей в клиенте и за поддержание актуальности информации и доступа гостевых пользователей.

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "invitedUserDisplayName": "string",
  "invitedUserEmailAddress": "string",
  "invitedUserMessageInfo": {"@odata.type": "microsoft.graph.invitedUserMessageInfo"},
  "sendInvitationMessage": false,
  "inviteRedirectUrl": "string",
  "inviteRedeemUrl": "string",
  "resetRedemption": false,
  "status": "string",
  "invitedUser": {"@odata.type": "microsoft.graph.user"},
  "invitedUserType": "string"
}