此结构在哪里使用
以下链接根据协议快照中的直接引用生成。认证、可写字段和运行行为应以调用操作为准;可复用资源结构本身并不是完整的写入请求。
- POSTCreate Space Invitation
/api/v1/spaces/{space}/invitations - GETGet Space Invitation
/api/v1/spaces/{space}/invitations/{invitation}
被以下组件结构引用:
结构与字段
object
SpaceInvitation is a pending invitation for an existing user to join a space.
| 字段 | 类型 / 是否必需 | 描述 |
|---|---|---|
name | string | The resource name. Format: spaces/{space}/invitations/{username}. |
invitee | string 必需 | Required. The invited user. Format: users/{username}. |
role | string (enum)ROLE_UNSPECIFIED · ADMIN · USER必需 | Required. The role the user will receive after accepting the invitation. |
space | allOf Space | Output only. The Space the user is invited to. This lets an invitee understand the invitation without granting membership-based GetSpace access. |
完整结构
约束与嵌套结构请以这份完整 JSON 定义为准。字段出现在这里,并不意味着每位调用者都能修改它。
{
"required": [
"invitee",
"role"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The resource name. Format: spaces/{space}/invitations/{username}."
},
"invitee": {
"type": "string",
"description": "Required. The invited user. Format: users/{username}."
},
"role": {
"enum": [
"ROLE_UNSPECIFIED",
"ADMIN",
"USER"
],
"type": "string",
"description": "Required. The role the user will receive after accepting the invitation.",
"format": "enum"
},
"space": {
"readOnly": true,
"allOf": [
{
"$ref": "#/components/schemas/Space"
}
],
"description": "Output only. The Space the user is invited to. This lets an invitee\n understand the invitation without granting membership-based GetSpace access."
}
},
"description": "SpaceInvitation is a pending invitation for an existing user to join a space."
}