Apps API · Approvals
Approvals: 7 个接口
GET /api/v1/approvals
List approval requests
权限(scope): work:approval:read · 调用方式: appToken · operationId: list-approval-requests
Required app scope: work:approval:read.
Lists approval requests for the active organization. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
status |
query | string | Filter by approval status | |
kind |
query | string | Filter by approval kind; several kinds comma-separated (e.g. app_publish,app_install) | |
scope_type |
query | string | Filter by scope type | |
scope_id |
query | string (uuid) | Filter by scope UUID | |
action |
query | string | Filter by action | |
page |
query | integer (int32) | Page number (default: 1) | |
page_size |
query | integer (int32) | Items per page (default: 20, max: 100) | |
order_by |
query | string | Sort expression, e.g. created_at:desc |
回包
200OK —application/json·PageListResponseApprovalItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/approvals
Create approval request
权限(scope): work:approval:write · 调用方式: appToken · operationId: create-approval-request
Required app scope: work:approval:write.
Creates a resource authorization or external share approval request. Response wrapped in standard envelope.
请求体
application/json · CreateApprovalRequestBody
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
action |
string | Requested action | |
approver_member_id |
string (uuid) | Approver member UUID | |
detail |
any | Approval request detail | |
kind |
string: resource_grant, external_share |
是 | Approval request kind |
policy_id |
string (uuid) | Approval policy UUID | |
request_expires_at |
string (date-time) | Request expiry time | |
request_reason |
string | Request reason | |
scope_id |
string (uuid) | 是 | Scope/resource UUID |
scope_type |
string | 是 | Scope/resource type |
回包
200OK —application/json·DataResponseApprovalItemBodydefaultError —application/problem+json·D8Error
GET /api/v1/approvals/{approval_id}
Get approval request
权限(scope): work:approval:read · 调用方式: appToken · operationId: get-approval-request
Required app scope: work:approval:read.
Returns one approval request. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
approval_id |
path | string (uuid) | 是 | Approval request UUID |
回包
200OK —application/json·DataResponseApprovalItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/approvals/{approval_id}/cancel
Cancel approval request
权限(scope): work:approval:write · 调用方式: appToken · operationId: cancel-approval-request
Required app scope: work:approval:write.
Cancels a pending approval request. app_publish / app_install requests answer 400: the submitter withdraws a version with withdraw-app-version. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
approval_id |
path | string (uuid) | 是 | Approval request UUID |
请求体
application/json · CancelApprovalRequestBody
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
reason |
string | Cancellation reason |
回包
200OK —application/json·DataResponseApprovalItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/approvals/{approval_id}/decide
Decide approval request
权限(scope): work:approval:decide · 调用方式: appToken · operationId: decide-approval-request
Required app scope: work:approval:decide.
Approves or rejects a pending approval request. app_publish / app_install requests are decided only by a human member holding app.manage who is not the requester (403 APP_PRINCIPAL_KIND_INVALID for Agents, 403 APP_SELF_APPROVAL_FORBIDDEN for the requester); approving publishes the version or installs the app in the same transaction (409 APP_VERSION_STATE_INVALID when the submission no longer matches, or when the app of an install request is no longer published, which also cancels that request). Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
approval_id |
path | string (uuid) | 是 | Approval request UUID |
请求体
application/json · DecideApprovalRequestBody
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
reason |
string | Decision reason | |
status |
string: approved, rejected |
是 | Decision status |
回包
200OK —application/json·DataResponseApprovalItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/approvals/{approval_id}/expire
Expire approval request
权限(scope): work:approval:write · 调用方式: appToken · operationId: expire-approval-request
Required app scope: work:approval:write.
Expires a pending approval request. app_publish / app_install requests never expire and answer 400. Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
approval_id |
path | string (uuid) | 是 | Approval request UUID |
请求体
application/json · ExpireApprovalRequestBody
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
reason |
string | Expiry reason |
回包
200OK —application/json·DataResponseApprovalItemBodydefaultError —application/problem+json·D8Error
POST /api/v1/approvals/{approval_id}/revoke
Revoke approval grant
权限(scope): work:approval:write · 调用方式: appToken · operationId: revoke-approval-grant
Required app scope: work:approval:write.
Revokes the authorization effect of an approved resource grant and records an approval.revoked audit event. app_publish / app_install requests answer 400 (an app is stopped by suspending or uninstalling it). Response wrapped in standard envelope.
参数
| 名字 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
approval_id |
path | string (uuid) | 是 | Approval request UUID |
请求体
application/json · RevokeApprovalRequestBody
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
reason |
string | Revoke reason |
回包
200OK —application/json·DataResponseApprovalItemBodydefaultError —application/problem+json·D8Error
