Batch view grantable resources¶
Confirm grant information for specified resources in a batch. Only resources visible to the current identity for the selected action are returned.
POST https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/iam/permissions/resources:batchDescribe
Preparation before calling¶
Collect the resources and grant action to confirm. Prepare a personal access token with required workspace permissions and the target workspace ID.
Request parameters¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/iam/permissions/resources:batchDescribe" -H "X-API-Key: $AI_STUDIO_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID" -H "Content-Type: application/json" -d '{"resource_type":"catalog","resource_ids":["catalog-001"],"action_id":"catalog.read","purpose":"role_configuration"}'
Path parameters
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Target workspace ID. |
Request body
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
string array |
Yes |
Resource IDs; contains 1–100 items. |
|
string |
Yes |
Resource type to view. |
|
string |
Yes |
Action identifier to evaluate. |
|
string |
No |
Purpose of this lookup. |
Successful response¶
Returns visible, resolvable resources after permission filtering. If multiple inputs map to the same root resource, the results are deduplicated.
{"code":"OK","msg":"OK","data":{"items":[],"capability_status":"ready","reason_code":"","request_id":"req-001","trace_id":"trace-001"}}
Field |
Type |
Description |
|---|---|---|
|
string |
|
|
string |
|
|
object array |
Visible, resolvable resources. |
|
string |
Resource-adapter state: |
|
string |
Reason code when the adapter is unavailable or unsupported. |
|
string |
Request correlation ID. |
|
string |
Trace ID. |
Error response¶
{"code":"ErrParamInvalid","msg":"Invalid request parameters","data":null}
Field |
Type |
Description |
|---|---|---|
|
string |
Error code. |
|
string |
Error message. |
|
null |
— |