Skip to content

Enable Sandbox

POST/web/v1/workspaces/{tenantWorkspaceBizId}/consumers/{consumerAccountBizId}/sandbox/enableJWT

Enables sandbox access for a consumer account within a tenant workspace.

Authentication

Auth Chain: WEB Chain — requires Authorization: Bearer <jwt> System-injected headers (frontend does nothing): X-PORTAL-ACCESS-CODE (Nginx), X-Request-Id (Gateway)

Request Parameters

NameTypeRequiredInDescription
tenantWorkspaceBizIdStringYespathBusiness ID of the tenant workspace
consumerAccountBizIdStringYespathBusiness ID of the consumer account

Request Body

JSON object of type SandboxWorkspaceAccessUpdateRequest.

Success Response

Success200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {}
}

Error Responses

Unauthorized401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Notes

  • Request body must conform to SandboxWorkspaceAccessUpdateRequest schema.
  • Sandbox access controls the consumer's ability to use test/sandbox environments.

Internal Documentation