Lattice.Hub

Role CRUD.

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

Auth · Roles

Role CRUD.

GET/auth/v1/rolesAuth required

List roles

List roles.

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/roles' \
  -H "Authorization: $TOKEN"

Response example

{
  "code": 200000,
  "info": "execute success"
}

POST/auth/v1/rolesAuth required

Create roles

Create roles.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · Role[]required
JSON array of Role; fields below are per-item.
idbody · stringoptional
id
namebody · stringoptional
name
ownerbody · stringoptional
owner
sourcebody · stringoptional
source
default_rolebody · booloptional
default_role
metadatabody · map<string,string>optional
metadata
commentbody · stringoptional
comment
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_groupsbody · UserGroup[]optional
user_groups
- 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.
Rolebody · Roleoptional
Entity fields.
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- ownerbody · stringoptional
  owner
- sourcebody · stringoptional
  source
- default_rolebody · booloptional
  default_role
- metadatabody · map<string,string>optional
  metadata
- commentbody · stringoptional
  comment
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- 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_groupsbody · UserGroup[]optional
  user_groups
  - 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/roles' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response example

{
  "code": 200000,
  "info": "execute success"
}

PUT/auth/v1/rolesAuth required

Update roles

Update roles.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · Role[]required
JSON array of Role; fields below are per-item.
idbody · stringoptional
id
namebody · stringoptional
name
ownerbody · stringoptional
owner
sourcebody · stringoptional
source
default_rolebody · booloptional
default_role
metadatabody · map<string,string>optional
metadata
commentbody · stringoptional
comment
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_groupsbody · UserGroup[]optional
user_groups
- 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.
Rolebody · Roleoptional
Entity fields.
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- ownerbody · stringoptional
  owner
- sourcebody · stringoptional
  source
- default_rolebody · booloptional
  default_role
- metadatabody · map<string,string>optional
  metadata
- commentbody · stringoptional
  comment
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- 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_groupsbody · UserGroup[]optional
  user_groups
  - 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/roles' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response example

{
  "code": 200000,
  "info": "execute success"
}

POST/auth/v1/roles/deleteAuth required

Delete roles

Delete roles.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · Role[]required
JSON array of Role; fields below are per-item.
idbody · stringoptional
id
namebody · stringoptional
name
ownerbody · stringoptional
owner
sourcebody · stringoptional
source
default_rolebody · booloptional
default_role
metadatabody · map<string,string>optional
metadata
commentbody · stringoptional
comment
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_groupsbody · UserGroup[]optional
user_groups
- 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.
Rolebody · Roleoptional
Entity fields.
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- ownerbody · stringoptional
  owner
- sourcebody · stringoptional
  source
- default_rolebody · booloptional
  default_role
- metadatabody · map<string,string>optional
  metadata
- commentbody · stringoptional
  comment
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- 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_groupsbody · UserGroup[]optional
  user_groups
  - 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/roles/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response example

{
  "code": 200000,
  "info": "execute success"
}

Roles

List roles

Create roles

Update roles

Delete roles

On this page