Lattice.Hub
GitHub

Lattice Hub Docs
HTTP OpenAPIAuthentication

Groups

User-group CRUD and token management.

User-group CRUD and token management.

Default Base URL: http://127.0.0.1:8090. Management APIs require Authorization (token from login).

Auth · Groups

User-group CRUD and token management.

GET/auth/v1/usergroupsAuth required

List user groups

List user groups.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idquery · stringoptional

    id

  • namequery · stringoptional

    name

  • user_idquery · stringoptional

    user_id

  • offsetquery · integeroptional

    offset

  • limitquery · integeroptional

    limit

Request
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/usergroups' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/usergroupsAuth required

Create user groups

Create user groups.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · UserGroup[]required

    JSON array of UserGroup; fields below are per-item.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • ownerbody · stringoptional

    owner

  • auth_tokenbody · stringoptional

    auth_token

  • token_enablebody · booloptional

    token_enable

  • commentbody · stringoptional

    comment

  • relationbody · UserGroupRelationoptional

    relation

    • group_idbody · stringoptional

      group_id

    • usersbody · User[]optional

      users

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

      • passwordbody · stringoptional

        password

      • ownerbody · stringoptional

        owner

      • sourcebody · stringoptional

        source

      • auth_tokenbody · stringoptional

        auth_token

      • token_enablebody · booloptional

        token_enable

      • commentbody · stringoptional

        comment

      • user_typebody · stringoptional

        user_type

      • mobilebody · stringoptional

        mobile

      • emailbody · stringoptional

        email

      • metadatabody · map<string,string>optional

        metadata

  • user_countbody · uint32optional

    user_count

  • sourcebody · stringoptional

    source

  • metadatabody · map<string,string>optional

    metadata

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • UserGroupbody · UserGroupoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • ownerbody · stringoptional

      owner

    • auth_tokenbody · stringoptional

      auth_token

    • token_enablebody · booloptional

      token_enable

    • commentbody · stringoptional

      comment

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • relationbody · UserGroupRelationoptional

      relation

      • group_idbody · stringoptional

        group_id

      • usersbody · User[]optional

        users

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

        • passwordbody · stringoptional

          password

        • ownerbody · stringoptional

          owner

        • sourcebody · stringoptional

          source

        • auth_tokenbody · stringoptional

          auth_token

        • token_enablebody · booloptional

          token_enable

        • commentbody · stringoptional

          comment

        • ctimebody · stringoptional

          ctime

        • mtimebody · stringoptional

          mtime

        • user_typebody · stringoptional

          user_type

        • mobilebody · stringoptional

          mobile

        • emailbody · stringoptional

          email

        • metadatabody · map<string,string>optional

          metadata

    • user_countbody · uint32optional

      user_count

    • sourcebody · stringoptional

      source

    • metadatabody · map<string,string>optional

      metadata

Request
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/usergroups' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
PUT/auth/v1/usergroupsAuth required

Update user groups

Update user groups.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · UserGroup[]required

    JSON array of UserGroup; fields below are per-item.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • ownerbody · stringoptional

    owner

  • auth_tokenbody · stringoptional

    auth_token

  • token_enablebody · booloptional

    token_enable

  • commentbody · stringoptional

    comment

  • relationbody · UserGroupRelationoptional

    relation

    • group_idbody · stringoptional

      group_id

    • usersbody · User[]optional

      users

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

      • passwordbody · stringoptional

        password

      • ownerbody · stringoptional

        owner

      • sourcebody · stringoptional

        source

      • auth_tokenbody · stringoptional

        auth_token

      • token_enablebody · booloptional

        token_enable

      • commentbody · stringoptional

        comment

      • user_typebody · stringoptional

        user_type

      • mobilebody · stringoptional

        mobile

      • emailbody · stringoptional

        email

      • metadatabody · map<string,string>optional

        metadata

  • user_countbody · uint32optional

    user_count

  • sourcebody · stringoptional

    source

  • metadatabody · map<string,string>optional

    metadata

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • UserGroupbody · UserGroupoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • ownerbody · stringoptional

      owner

    • auth_tokenbody · stringoptional

      auth_token

    • token_enablebody · booloptional

      token_enable

    • commentbody · stringoptional

      comment

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • relationbody · UserGroupRelationoptional

      relation

      • group_idbody · stringoptional

        group_id

      • usersbody · User[]optional

        users

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

        • passwordbody · stringoptional

          password

        • ownerbody · stringoptional

          owner

        • sourcebody · stringoptional

          source

        • auth_tokenbody · stringoptional

          auth_token

        • token_enablebody · booloptional

          token_enable

        • commentbody · stringoptional

          comment

        • ctimebody · stringoptional

          ctime

        • mtimebody · stringoptional

          mtime

        • user_typebody · stringoptional

          user_type

        • mobilebody · stringoptional

          mobile

        • emailbody · stringoptional

          email

        • metadatabody · map<string,string>optional

          metadata

    • user_countbody · uint32optional

      user_count

    • sourcebody · stringoptional

      source

    • metadatabody · map<string,string>optional

      metadata

Request
curl -sS -X PUT 'http://127.0.0.1:8090/auth/v1/usergroups' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
POST/auth/v1/usergroups/deleteAuth required

Delete user groups

Delete user groups.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · UserGroup[]required

    JSON array of UserGroup; fields below are per-item.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • ownerbody · stringoptional

    owner

  • auth_tokenbody · stringoptional

    auth_token

  • token_enablebody · booloptional

    token_enable

  • commentbody · stringoptional

    comment

  • relationbody · UserGroupRelationoptional

    relation

    • group_idbody · stringoptional

      group_id

    • usersbody · User[]optional

      users

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

      • passwordbody · stringoptional

        password

      • ownerbody · stringoptional

        owner

      • sourcebody · stringoptional

        source

      • auth_tokenbody · stringoptional

        auth_token

      • token_enablebody · booloptional

        token_enable

      • commentbody · stringoptional

        comment

      • user_typebody · stringoptional

        user_type

      • mobilebody · stringoptional

        mobile

      • emailbody · stringoptional

        email

      • metadatabody · map<string,string>optional

        metadata

  • user_countbody · uint32optional

    user_count

  • sourcebody · stringoptional

    source

  • metadatabody · map<string,string>optional

    metadata

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • UserGroupbody · UserGroupoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • ownerbody · stringoptional

      owner

    • auth_tokenbody · stringoptional

      auth_token

    • token_enablebody · booloptional

      token_enable

    • commentbody · stringoptional

      comment

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • relationbody · UserGroupRelationoptional

      relation

      • group_idbody · stringoptional

        group_id

      • usersbody · User[]optional

        users

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

        • passwordbody · stringoptional

          password

        • ownerbody · stringoptional

          owner

        • sourcebody · stringoptional

          source

        • auth_tokenbody · stringoptional

          auth_token

        • token_enablebody · booloptional

          token_enable

        • commentbody · stringoptional

          comment

        • ctimebody · stringoptional

          ctime

        • mtimebody · stringoptional

          mtime

        • user_typebody · stringoptional

          user_type

        • mobilebody · stringoptional

          mobile

        • emailbody · stringoptional

          email

        • metadatabody · map<string,string>optional

          metadata

    • user_countbody · uint32optional

      user_count

    • sourcebody · stringoptional

      source

    • metadatabody · map<string,string>optional

      metadata

Request
curl -sS -X POST 'http://127.0.0.1:8090/auth/v1/usergroups/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/auth/v1/usergroup/detailAuth required

User group detail

User group detail.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idquery · stringrequired

    id

Request
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/usergroup/detail' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
GET/auth/v1/usergroup/tokenAuth required

Get user group token

Get user group token.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idquery · stringrequired

    id

Request
curl -sS -X GET 'http://127.0.0.1:8090/auth/v1/usergroup/token' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success"
}
PUT/auth/v1/usergroup/token/enableAuth required

Enable/disable group token

Enable/disable group token.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • ownerbody · stringoptional

    owner

  • auth_tokenbody · stringoptional

    auth_token

  • token_enablebody · booloptional

    token_enable

  • commentbody · stringoptional

    comment

  • relationbody · UserGroupRelationoptional

    relation

    • group_idbody · stringoptional

      group_id

    • usersbody · User[]optional

      users

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

      • passwordbody · stringoptional

        password

      • ownerbody · stringoptional

        owner

      • sourcebody · stringoptional

        source

      • auth_tokenbody · stringoptional

        auth_token

      • token_enablebody · booloptional

        token_enable

      • commentbody · stringoptional

        comment

      • user_typebody · stringoptional

        user_type

      • mobilebody · stringoptional

        mobile

      • emailbody · stringoptional

        email

      • metadatabody · map<string,string>optional

        metadata

  • user_countbody · uint32optional

    user_count

  • sourcebody · stringoptional

    source

  • metadatabody · map<string,string>optional

    metadata

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • UserGroupbody · UserGroupoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • ownerbody · stringoptional

      owner

    • auth_tokenbody · stringoptional

      auth_token

    • token_enablebody · booloptional

      token_enable

    • commentbody · stringoptional

      comment

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • relationbody · UserGroupRelationoptional

      relation

      • group_idbody · stringoptional

        group_id

      • usersbody · User[]optional

        users

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

        • passwordbody · stringoptional

          password

        • ownerbody · stringoptional

          owner

        • sourcebody · stringoptional

          source

        • auth_tokenbody · stringoptional

          auth_token

        • token_enablebody · booloptional

          token_enable

        • commentbody · stringoptional

          comment

        • ctimebody · stringoptional

          ctime

        • mtimebody · stringoptional

          mtime

        • user_typebody · stringoptional

          user_type

        • mobilebody · stringoptional

          mobile

        • emailbody · stringoptional

          email

        • metadatabody · map<string,string>optional

          metadata

    • user_countbody · uint32optional

      user_count

    • sourcebody · stringoptional

      source

    • metadatabody · map<string,string>optional

      metadata

Request
curl -sS -X PUT 'http://127.0.0.1:8090/auth/v1/usergroup/token/enable' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
PUT/auth/v1/usergroup/token/refreshAuth required

Refresh group token

Refresh group token.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • ownerbody · stringoptional

    owner

  • auth_tokenbody · stringoptional

    auth_token

  • token_enablebody · booloptional

    token_enable

  • commentbody · stringoptional

    comment

  • relationbody · UserGroupRelationoptional

    relation

    • group_idbody · stringoptional

      group_id

    • usersbody · User[]optional

      users

      • idbody · stringoptional

        id

      • namebody · stringoptional

        name

      • passwordbody · stringoptional

        password

      • ownerbody · stringoptional

        owner

      • sourcebody · stringoptional

        source

      • auth_tokenbody · stringoptional

        auth_token

      • token_enablebody · booloptional

        token_enable

      • commentbody · stringoptional

        comment

      • user_typebody · stringoptional

        user_type

      • mobilebody · stringoptional

        mobile

      • emailbody · stringoptional

        email

      • metadatabody · map<string,string>optional

        metadata

  • user_countbody · uint32optional

    user_count

  • sourcebody · stringoptional

    source

  • metadatabody · map<string,string>optional

    metadata

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • UserGroupbody · UserGroupoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • ownerbody · stringoptional

      owner

    • auth_tokenbody · stringoptional

      auth_token

    • token_enablebody · booloptional

      token_enable

    • commentbody · stringoptional

      comment

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • relationbody · UserGroupRelationoptional

      relation

      • group_idbody · stringoptional

        group_id

      • usersbody · User[]optional

        users

        • idbody · stringoptional

          id

        • namebody · stringoptional

          name

        • passwordbody · stringoptional

          password

        • ownerbody · stringoptional

          owner

        • sourcebody · stringoptional

          source

        • auth_tokenbody · stringoptional

          auth_token

        • token_enablebody · booloptional

          token_enable

        • commentbody · stringoptional

          comment

        • ctimebody · stringoptional

          ctime

        • mtimebody · stringoptional

          mtime

        • user_typebody · stringoptional

          user_type

        • mobilebody · stringoptional

          mobile

        • emailbody · stringoptional

          email

        • metadatabody · map<string,string>optional

          metadata

    • user_countbody · uint32optional

      user_count

    • sourcebody · stringoptional

      source

    • metadatabody · map<string,string>optional

      metadata

Request
curl -sS -X PUT 'http://127.0.0.1:8090/auth/v1/usergroup/token/refresh' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}

Users

User CRUD and token / password management.

Roles

Role CRUD.

On this page

GET List user groupsPOST Create user groupsPUT Update user groupsPOST Delete user groupsGET User group detailGET Get user group tokenPUT Enable/disable group tokenPUT Refresh group token