Lattice Hub 文档
HTTP OpenAPI鉴权

角色

角色 CRUD。

角色 CRUD。

默认 Base URL:http://127.0.0.1:8090。管理面接口需 Authorization(登录返回的 token)。

鉴权 · 角色

角色 CRUD。

GET/auth/v1/roles需要鉴权

查询角色

查询角色。

  • Authorizationheader · string必填

    登录返回的 token。

  • idquery · string可选

    id

  • namequery · string可选

    name

  • offsetquery · integer可选

    offset

  • limitquery · integer可选

    limit

请求示例
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/roles' \
  -H "Authorization: $TOKEN"
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/roles需要鉴权

创建角色

创建角色。

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · Role[]必填

    请求体为 Role 的 JSON 数组;下列为单条字段。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • ownerbody · string可选

    owner

  • sourcebody · string可选

    source

  • default_rolebody · bool可选

    default_role

  • metadatabody · map<string,string>可选

    metadata

  • commentbody · string可选

    comment

  • usersbody · User[]可选

    users

    • idbody · string可选

      id

    • namebody · string可选

      name

    • passwordbody · string可选

      password

    • ownerbody · string可选

      owner

    • sourcebody · string可选

      source

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • user_typebody · string可选

      user_type

    • mobilebody · string可选

      mobile

    • emailbody · string可选

      email

    • metadatabody · map<string,string>可选

      metadata

  • user_groupsbody · UserGroup[]可选

    user_groups

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • relationbody · UserGroupRelation可选

      relation

      • group_idbody · string可选

        group_id

      • usersbody · User[]可选

        users

        • idbody · string可选

          id

        • namebody · string可选

          name

        • passwordbody · string可选

          password

        • ownerbody · string可选

          owner

        • sourcebody · string可选

          source

        • auth_tokenbody · string可选

          auth_token

        • token_enablebody · bool可选

          token_enable

        • commentbody · string可选

          comment

        • user_typebody · string可选

          user_type

        • mobilebody · string可选

          mobile

        • emailbody · string可选

          email

        • metadatabody · map<string,string>可选

          metadata

    • user_countbody · uint32可选

      user_count

    • sourcebody · string可选

      source

    • metadatabody · map<string,string>可选

      metadata

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • Rolebody · Role可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • sourcebody · string可选

      source

    • default_rolebody · bool可选

      default_role

    • metadatabody · map<string,string>可选

      metadata

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • usersbody · User[]可选

      users

      • idbody · string可选

        id

      • namebody · string可选

        name

      • passwordbody · string可选

        password

      • ownerbody · string可选

        owner

      • sourcebody · string可选

        source

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • ctimebody · string可选

        ctime

      • mtimebody · string可选

        mtime

      • user_typebody · string可选

        user_type

      • mobilebody · string可选

        mobile

      • emailbody · string可选

        email

      • metadatabody · map<string,string>可选

        metadata

    • user_groupsbody · UserGroup[]可选

      user_groups

      • idbody · string可选

        id

      • namebody · string可选

        name

      • ownerbody · string可选

        owner

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • ctimebody · string可选

        ctime

      • mtimebody · string可选

        mtime

      • relationbody · UserGroupRelation可选

        relation

        • group_idbody · string可选

          group_id

        • usersbody · User[]可选

          users

          • idbody · string可选

            id

          • namebody · string可选

            name

          • passwordbody · string可选

            password

          • ownerbody · string可选

            owner

          • sourcebody · string可选

            source

          • auth_tokenbody · string可选

            auth_token

          • token_enablebody · bool可选

            token_enable

          • commentbody · string可选

            comment

          • ctimebody · string可选

            ctime

          • mtimebody · string可选

            mtime

          • user_typebody · string可选

            user_type

          • mobilebody · string可选

            mobile

          • emailbody · string可选

            email

          • metadatabody · map<string,string>可选

            metadata

      • user_countbody · uint32可选

        user_count

      • sourcebody · string可选

        source

      • metadatabody · map<string,string>可选

        metadata

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/roles' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
PUT/auth/v1/roles需要鉴权

更新角色

更新角色。

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · Role[]必填

    请求体为 Role 的 JSON 数组;下列为单条字段。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • ownerbody · string可选

    owner

  • sourcebody · string可选

    source

  • default_rolebody · bool可选

    default_role

  • metadatabody · map<string,string>可选

    metadata

  • commentbody · string可选

    comment

  • usersbody · User[]可选

    users

    • idbody · string可选

      id

    • namebody · string可选

      name

    • passwordbody · string可选

      password

    • ownerbody · string可选

      owner

    • sourcebody · string可选

      source

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • user_typebody · string可选

      user_type

    • mobilebody · string可选

      mobile

    • emailbody · string可选

      email

    • metadatabody · map<string,string>可选

      metadata

  • user_groupsbody · UserGroup[]可选

    user_groups

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • relationbody · UserGroupRelation可选

      relation

      • group_idbody · string可选

        group_id

      • usersbody · User[]可选

        users

        • idbody · string可选

          id

        • namebody · string可选

          name

        • passwordbody · string可选

          password

        • ownerbody · string可选

          owner

        • sourcebody · string可选

          source

        • auth_tokenbody · string可选

          auth_token

        • token_enablebody · bool可选

          token_enable

        • commentbody · string可选

          comment

        • user_typebody · string可选

          user_type

        • mobilebody · string可选

          mobile

        • emailbody · string可选

          email

        • metadatabody · map<string,string>可选

          metadata

    • user_countbody · uint32可选

      user_count

    • sourcebody · string可选

      source

    • metadatabody · map<string,string>可选

      metadata

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • Rolebody · Role可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • sourcebody · string可选

      source

    • default_rolebody · bool可选

      default_role

    • metadatabody · map<string,string>可选

      metadata

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • usersbody · User[]可选

      users

      • idbody · string可选

        id

      • namebody · string可选

        name

      • passwordbody · string可选

        password

      • ownerbody · string可选

        owner

      • sourcebody · string可选

        source

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • ctimebody · string可选

        ctime

      • mtimebody · string可选

        mtime

      • user_typebody · string可选

        user_type

      • mobilebody · string可选

        mobile

      • emailbody · string可选

        email

      • metadatabody · map<string,string>可选

        metadata

    • user_groupsbody · UserGroup[]可选

      user_groups

      • idbody · string可选

        id

      • namebody · string可选

        name

      • ownerbody · string可选

        owner

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • ctimebody · string可选

        ctime

      • mtimebody · string可选

        mtime

      • relationbody · UserGroupRelation可选

        relation

        • group_idbody · string可选

          group_id

        • usersbody · User[]可选

          users

          • idbody · string可选

            id

          • namebody · string可选

            name

          • passwordbody · string可选

            password

          • ownerbody · string可选

            owner

          • sourcebody · string可选

            source

          • auth_tokenbody · string可选

            auth_token

          • token_enablebody · bool可选

            token_enable

          • commentbody · string可选

            comment

          • ctimebody · string可选

            ctime

          • mtimebody · string可选

            mtime

          • user_typebody · string可选

            user_type

          • mobilebody · string可选

            mobile

          • emailbody · string可选

            email

          • metadatabody · map<string,string>可选

            metadata

      • user_countbody · uint32可选

        user_count

      • sourcebody · string可选

        source

      • metadatabody · map<string,string>可选

        metadata

请求示例
curl -sS -X PUT 'http://127.0.0.1:8090/auth/v1/roles' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/roles/delete需要鉴权

删除角色

删除角色。

  • Authorizationheader · string必填

    登录返回的 token。

  • (body)body · Role[]必填

    请求体为 Role 的 JSON 数组;下列为单条字段。

  • idbody · string可选

    id

  • namebody · string可选

    name

  • ownerbody · string可选

    owner

  • sourcebody · string可选

    source

  • default_rolebody · bool可选

    default_role

  • metadatabody · map<string,string>可选

    metadata

  • commentbody · string可选

    comment

  • usersbody · User[]可选

    users

    • idbody · string可选

      id

    • namebody · string可选

      name

    • passwordbody · string可选

      password

    • ownerbody · string可选

      owner

    • sourcebody · string可选

      source

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • user_typebody · string可选

      user_type

    • mobilebody · string可选

      mobile

    • emailbody · string可选

      email

    • metadatabody · map<string,string>可选

      metadata

  • user_groupsbody · UserGroup[]可选

    user_groups

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • auth_tokenbody · string可选

      auth_token

    • token_enablebody · bool可选

      token_enable

    • commentbody · string可选

      comment

    • relationbody · UserGroupRelation可选

      relation

      • group_idbody · string可选

        group_id

      • usersbody · User[]可选

        users

        • idbody · string可选

          id

        • namebody · string可选

          name

        • passwordbody · string可选

          password

        • ownerbody · string可选

          owner

        • sourcebody · string可选

          source

        • auth_tokenbody · string可选

          auth_token

        • token_enablebody · bool可选

          token_enable

        • commentbody · string可选

          comment

        • user_typebody · string可选

          user_type

        • mobilebody · string可选

          mobile

        • emailbody · string可选

          email

        • metadatabody · map<string,string>可选

          metadata

    • user_countbody · uint32可选

      user_count

    • sourcebody · string可选

      source

    • metadatabody · map<string,string>可选

      metadata

  • codebody · uint32必填

    业务码。

  • infobody · string可选

    提示信息。

  • Rolebody · Role可选

    实体字段。

    • idbody · string可选

      id

    • namebody · string可选

      name

    • ownerbody · string可选

      owner

    • sourcebody · string可选

      source

    • default_rolebody · bool可选

      default_role

    • metadatabody · map<string,string>可选

      metadata

    • commentbody · string可选

      comment

    • ctimebody · string可选

      ctime

    • mtimebody · string可选

      mtime

    • usersbody · User[]可选

      users

      • idbody · string可选

        id

      • namebody · string可选

        name

      • passwordbody · string可选

        password

      • ownerbody · string可选

        owner

      • sourcebody · string可选

        source

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • ctimebody · string可选

        ctime

      • mtimebody · string可选

        mtime

      • user_typebody · string可选

        user_type

      • mobilebody · string可选

        mobile

      • emailbody · string可选

        email

      • metadatabody · map<string,string>可选

        metadata

    • user_groupsbody · UserGroup[]可选

      user_groups

      • idbody · string可选

        id

      • namebody · string可选

        name

      • ownerbody · string可选

        owner

      • auth_tokenbody · string可选

        auth_token

      • token_enablebody · bool可选

        token_enable

      • commentbody · string可选

        comment

      • ctimebody · string可选

        ctime

      • mtimebody · string可选

        mtime

      • relationbody · UserGroupRelation可选

        relation

        • group_idbody · string可选

          group_id

        • usersbody · User[]可选

          users

          • idbody · string可选

            id

          • namebody · string可选

            name

          • passwordbody · string可选

            password

          • ownerbody · string可选

            owner

          • sourcebody · string可选

            source

          • auth_tokenbody · string可选

            auth_token

          • token_enablebody · bool可选

            token_enable

          • commentbody · string可选

            comment

          • ctimebody · string可选

            ctime

          • mtimebody · string可选

            mtime

          • user_typebody · string可选

            user_type

          • mobilebody · string可选

            mobile

          • emailbody · string可选

            email

          • metadatabody · map<string,string>可选

            metadata

      • user_countbody · uint32可选

        user_count

      • sourcebody · string可选

        source

      • metadatabody · map<string,string>可选

        metadata

请求示例
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/roles/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
响应示例
{
  "code": 200000,
  "info": "execute success"
}

On this page