Баримт бичиг / API лавлах
Урилга
Ажлын орчинд хүн урих.
GET/v1/workspaces/{workspaceId}/allowed-domains
The email-domain allow-list.
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 AllowedDomains
PUT/v1/workspaces/{workspaceId}/allowed-domains
Replace the allow-list (owner only, max 10, no free-mail domains, rule 39).
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (AllowedDomains)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
domains | string[] | тийм | |
autoJoin | boolean | | |
Хариу: 200 AllowedDomains
GET/v1/workspaces/{workspaceId}/invite-link
The active invite link (without its secret).
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 InviteLinkDto
POST/v1/workspaces/{workspaceId}/invite-link
Create or regenerate the invite link; the previous one stops working.
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (CreateLink)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
role | string | | `member` (default) or `viewer`. |
expiresInDays | integer (int64) | | 1-30, default 7. |
Хариу: 201 InviteLinkDto
DELETE/v1/workspaces/{workspaceId}/invite-link
Disable the invite link.
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 204
GET/v1/workspaces/{workspaceId}/invites
Pending and past invites.
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 InviteDto[]
POST/v1/workspaces/{workspaceId}/invites
Invite one or more addresses. Re-inviting a pending address refreshes it.
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (CreateInvites)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
emails | string[] | тийм | |
role | string | тийм | |
Хариу: 201 InviteDto[]
DELETE/v1/workspaces/{workspaceId}/invites/{inviteId}
Revoke a pending invite.
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
inviteId | path | string | тийм | |
Хариу: 204
POST/v1/workspaces/{workspaceId}/invites/{inviteId}/resend
Resend with a new token (once per hour, 5 times in total, rule 36).
Нэвтэрсэн сессийг (cookie) мөн хүлээн авна
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
inviteId | path | string | тийм | |
Хариу: 200 InviteDto