准备原生CLI产品身份

使用UC原生登录access token准备产品身份,并查询或发起默认工作区准备。该请求会写入身份映射,并可能提交工作区创建作业。

POST https://api.moi.matrixorigin.cn/v5/auth/cli/bootstrap

调用前准备

MOI_ENDPOINT 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。

使用UC原生登录签发的access token。只提供单个Authorization: Bearer,不发送会话Cookie或X-API-Key。仅在允许身份初始化和默认工作区创建的环境执行。

请求

curl --fail-with-body -X POST "$MOI_ENDPOINT/auth/cli/bootstrap" \
  -H "Authorization: Bearer $UC_ACCESS_TOKEN"

参数

位置

是否必填

说明

Authorization

header

是

单个Bearer凭据,scheme大小写不敏感;token非空、最多16KiB且不含空格、回车、换行或制表符

无业务请求体。不把X-API-Key模式的account bootstrap-native命令当作有效原生登录方式。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "issuer": "https://uc.example.test",
    "subject": "subject-example",
    "session_id": "session-example",
    "principal_id": "principal-example",
    "catalog_user_id": "catalog-user-example",
    "workspaces": [],
    "workspace_initialization": {
      "status": "failed",
      "code": "ErrNativeWorkspacePreparation",
      "message": "示例工作区准备失败"
    }
  }
}

字段

类型

说明

data.issuer / subject / session_id

string

上游原生身份断言中的签发者、主体和会话

data.principal_id

string

产品身份ID

data.catalog_user_id

string

Catalog/IAM用户映射ID,不与principal_id或subject互换

data.workspaces

array(对象数组)

当前已可见工作区与待邀请选择项;完整嵌套Workspace对象合同另待核验

workspaces[].invitation_id

string

邀请选择项可带该标识,PENDING_INVITATION/access_status=pending不表示已接受邀请

data.workspace_initialization

object

独立的准备结果,身份成功不保证工作区已就绪

workspace_initialization.status

string

ready、pending、running、succeeded或failed;失败也能与外层OK同时返回

workspace_initialization.job_id / code / message

string

有值时输出,分别用于作业交接、失败分类和提示

准备预算当前三秒,不等待工作区DDL。已有已加入工作区时可返回ready;只有邀请项仍可能触发默认工作区作业。没有JobID的准备错误可返回failed/ErrNativeWorkspacePreparation,示例展示该分支,不能据外层OK进入工作区操作。完整作业状态、轮询交接和清理尚未验收。

错误响应

HTTP

code

条件

400

ErrMultipleAuthCredentials

混入产品会话Cookie、X-API-Key或多个Authorization

401

ErrNativeSessionInvalid

凭据格式或上游原生凭据无效

403

ErrUserNotSynced

凭据主体尚未映射

503

ErrNativeSessionUnavailable

上游身份服务不可用

503

ErrNativeProvisioningFailed

映射歧义或身份准备失败

500

ErrServer

本地化或DTO转换失败

错误文本经过本地化,不以固定msg匹配重试。外层HTTP200的工作区准备失败另看成功响应中的准备对象。

最后更新于