邀请

列出所有邀请

返回所有组织邀请的列表。

方法	路径
GET	/v1/organizations/{organizationId}/invitations

请求

路径参数

名称	类型	描述
organizationId	uuid	所请求组织的 ID。

响应

响应模式

名称	类型	描述
角色	字符串	成员在组织中的角色。
id	uuid	唯一的邀请 ID。
电子邮件	电子邮件	受邀用户的电子邮件。只有使用此电子邮件的用户才能使用邀请加入。电子邮件以小写形式存储。
createdAt	日期时间	邀请创建时间戳。ISO-8601。
expireAt	日期时间	邀请到期的时间戳。ISO-8601。

示例响应

{
  "role": "string",
  "id": "uuid",
  "email": "email",
  "createdAt": "date-time",
  "expireAt": "date-time"
}

创建邀请

创建组织邀请。

方法	路径
POST	/v1/organizations/{organizationId}/invitations

请求

路径参数

名称	类型	描述
organizationId	uuid	要邀请用户的组织的 ID。

正文参数

名称	类型	描述
电子邮件	字符串	受邀用户的电子邮件。只有使用此电子邮件的用户才能使用邀请加入。电子邮件以小写形式存储。
角色	字符串	成员在组织中的角色。

响应

响应模式

名称	类型	描述
角色	字符串	成员在组织中的角色。
id	uuid	唯一的邀请 ID。
电子邮件	电子邮件	受邀用户的电子邮件。只有使用此电子邮件的用户才能使用邀请加入。电子邮件以小写形式存储。
createdAt	日期时间	邀请创建时间戳。ISO-8601。
expireAt	日期时间	邀请到期的时间戳。ISO-8601。

示例响应

{
  "role": "string",
  "id": "uuid",
  "email": "email",
  "createdAt": "date-time",
  "expireAt": "date-time"
}

获取邀请详细信息

返回单个组织邀请的详细信息。

方法	路径
GET	/v1/organizations/{organizationId}/invitations/{invitationId}

请求

路径参数

名称	类型	描述
organizationId	uuid	所请求组织的 ID。
invitationId	uuid	所请求组织的 ID。

响应

响应模式

名称	类型	描述
角色	字符串	成员在组织中的角色。
id	uuid	唯一的邀请 ID。
电子邮件	电子邮件	受邀用户的电子邮件。只有使用此电子邮件的用户才能使用邀请加入。电子邮件以小写形式存储。
createdAt	日期时间	邀请创建时间戳。ISO-8601。
expireAt	日期时间	邀请到期的时间戳。ISO-8601。

示例响应

{
  "role": "string",
  "id": "uuid",
  "email": "email",
  "createdAt": "date-time",
  "expireAt": "date-time"
}

删除组织邀请

删除单个组织邀请。

方法	路径
DELETE	/v1/organizations/{organizationId}/invitations/{invitationId}

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有邀请的组织的 ID。
invitationId	uuid	所请求组织的 ID。