Lattice.Hub
GitHub

Lattice Hub Docs
HTTP OpenAPIAuthentication

Users

User CRUD and token / password management.

User CRUD and token / password management.

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

Auth · Users

User CRUD and token/password management.

GET/auth/v1/usersAuth required

List users

List users.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idquery · stringoptional

    id

  • namequery · stringoptional

    name

  • offsetquery · integeroptional

    offset

  • limitquery · integeroptional

    limit

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

Create users

Create users.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · User[]required

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

  • 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

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • Userbody · Useroptional

    Entity fields.

    • 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

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

Update users

Update users.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · User[]required

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

  • 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

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • Userbody · Useroptional

    Entity fields.

    • 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

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

Delete users

Delete users.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · User[]required

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

  • 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

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • Userbody · Useroptional

    Entity fields.

    • 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

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

Change password

Change password.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idbody · stringoptional

    id

  • old_passwordbody · stringoptional

    old_password

  • new_passwordbody · stringoptional

    new_password

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ModifyUserPasswordbody · ModifyUserPasswordoptional

    Entity fields.

    • idbody · stringoptional

      id

    • old_passwordbody · stringoptional

      old_password

    • new_passwordbody · stringoptional

      new_password

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

Get user token

Get user token.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idquery · stringrequired

    id

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

Enable/disable user token

Enable/disable user token.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • 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

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • Userbody · Useroptional

    Entity fields.

    • 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

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

Refresh user token

Refresh user token.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • 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

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • Userbody · Useroptional

    Entity fields.

    • 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

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

Login & status

User login and auth system status.

Groups

User-group CRUD and token management.

On this page

GET List usersPOST Create usersPUT Update usersPOST Delete usersPUT Change passwordGET Get user tokenPUT Enable/disable user tokenPUT Refresh user token