Received Shares - Activate Tenant Email Registration

服务:

Purview

API 版本:

2023-02-15-preview

使用收到的激活代码激活租户和电子邮件组合。
激活当前租户的电子邮件注册

POST {endpoint}/emails:activate?api-version=2023-02-15-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	purview 帐户的共享终结点。 示例：https://{accountName}.purview.azure.com/share
api-version	query	True	string	要使用的 API 版本

请求头

名称	必需	类型	说明
repeatability-request-id		string	如果指定，客户端将指示请求可重复;也就是说，客户端可以使用相同的可重复性-Request-Id 多次发出请求并返回适当的响应，而无需服务器多次执行请求。 Repeatability-Request-Id 的值是一个不透明的字符串，表示客户端生成、全局唯一的、请求的标识符。 建议使用版本 4（随机）UUID。

请求正文

名称	类型	说明
properties	TenantEmailRegistrationProperties	租户电子邮件注册属性包。

响应

名称	类型	说明
200 OK	TenantEmailRegistration	成功
Other Status Codes	PurviewShareError	默认错误响应。 标头 x-ms-error-code: string

安全性

azureAuth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://purview.azure.net/.default	Purview 服务范围

示例

ReceivedShares_ActivateTenantEmailRegistration

示例请求

HTTP

POST accountName.purview.azure.com/share/emails:activate?api-version=2023-02-15-preview

{
  "properties": {
    "activationCode": "15ee7153fe0df5a3a449a897d6cec836"
  }
}

示例响应

状态代码:

200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
repeatability-request-id: b470712a-ffbc-4d9f-ab99-6640db8bbcb8

{
  "properties": {
    "activationCode": "15ee7153fe0df5a3a449a897d6cec836",
    "activationExpiration": "2022-08-16T22:35:17.2093506Z",
    "email": "john.smith@contoso.com",
    "registrationStatus": "Activated",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "state": "Succeeded"
  },
  "id": "cb817140-a0cf-464f-8a82-0a9627a026ab",
  "type": "tenantEmailRegistration"
}

定义

名称	说明
PurviewShareError	purview 共享错误模型。
PurviewShareErrorInfo	purview 共享错误正文模型。
State	资源的状态
TenantEmailRegistration	租户电子邮件注册数据传输对象。
TenantEmailRegistrationProperties	租户电子邮件注册属性包。
TenantEmailRegistrationStatus	定义注册支持的类型。

PurviewShareError

Object

purview 共享错误模型。

名称	类型	说明
error	PurviewShareErrorInfo	purview 共享错误正文模型。

PurviewShareErrorInfo

Object

purview 共享错误正文模型。

名称	类型	说明
code	string	错误的代码
details	PurviewShareErrorInfo[]	错误模型的嵌套详细信息
message	string	错误的消息
target	string	错误目标

State

枚举

资源的状态

值	说明
Unknown	资源的状态为“未知”
Succeeded	资源的状态为“Succeeded”
Creating	资源的状态为“正在创建”
Deleting	资源的状态为“正在删除”
Moving	资源的状态为“移动”
Failed	资源的状态为“Failed”

TenantEmailRegistration

Object

租户电子邮件注册数据传输对象。

名称	类型	说明
id	string	资源的唯一 ID。
properties	TenantEmailRegistrationProperties	租户电子邮件注册属性包。
type	string	资源的类型。

TenantEmailRegistrationProperties

Object

租户电子邮件注册属性包。

名称	类型	说明
activationCode	string	注册的激活代码。
activationExpiration	string (date-time)	激活到期日期。 以 RFC 3339 定义的标准日期时间格式表示
email	string	要注册的电子邮件。
registrationStatus	TenantEmailRegistrationStatus	定义注册支持的类型。
state	State	资源的状态
tenantId	string	要注册的租户 ID。

TenantEmailRegistrationStatus

枚举

定义注册支持的类型。

值	说明
ActivationPending	租户电子邮件注册处于挂起状态
Activated	租户电子邮件注册已完成且已激活
ActivationAttemptsExhausted	租户电子邮件注册已耗尽最大尝试次数