Kiwire ( v3 ) - API

  2. Home
  4. Docs
  6. Kiwire ( v3 ) – API
  8. Admin

Admin

create

Use POST method to create new subordinate resources.

Example request URIs

[POST] https://{{kiwire_ip}}/api/admin/ Parameters Required
Parameter Value Description
tenant_id string Tenant ID or Tenant name of the API key
updated_date datetime The last updated date and time
username string Username to login into Kiwire system
password string Password to login into Kiwire system
groupname string Role for the admin
fullname string Full name
lastlogin datetime The date of the last login
email string Email address to send notification
monitor y or n Set the value to Y if this admin should receive notification email from Kiwire
temp_pass string Temporary password
permission rw or r or w The access granted to the admin. Read + Write : Full access Read Only : Read only access Write Only : Write only access
balance_credit string The credit balance in account
last_change_pass datetime The date of the last password changed
first_login datetime The date of the first login
tenant_default string Login tenant id will be default tenant
tenant_allowed string The restriction tenant, only allowed tenant can access

PATCH

Use PATCH method is to make a partial update on a resource. 

The differences between PATCH and PUT, PUT method also modify a resource entity but PATCH method is used for partially updating an existing resource. PUT should be used if you are entirety replacing a resource.

Example request URIs

 

[PATCH] https://{{kiwire_ip}}/api/admin/{{id}}/ Parameters Required
Parameter Value Description
tenant_id string Tenant ID or Tenant name of the API key
updated_date datetime The last updated date and time
username string Username to login into Kiwire system
password string Password to login into Kiwire system
groupname string Role for the admin
fullname string Full name
lastlogin datetime The date of the last login
email string Email address to send notification
monitor y or n Set the value to Y if this admin should receive notification email from Kiwire
temp_pass string Temporary password
permission rw or r or w The access granted to the admin. Read + Write : Full access Read Only : Read only access Write Only : Write only access
balance_credit string The credit balance in account
last_change_pass datetime The date of the last password changed
first_login datetime The date of the first login
tenant_default string Login tenant id will be default tenant
tenant_allowed string The restriction tenant, only allowed tenant can access

delete

Use DELETE method as the name applies to delete resources.

Example request URIs

[DELETE] https://{{kiwire_ip}}/api/admin/{{id}}/

GET

Use GET method to retrieve resource information only and not to modify it in any way.

Example request URIs

[GET] https://{{kiwire_ip}}/api/admin/ [GET] https://{{kiwire_ip}}/api/admin/{{id}}/ [GET] https://{{kiwire_ip}}/api/admin/{{offset}}/{{limit}}/{{column}}/{{order}}/
Value Description
offset integer Start data count
limit integer Limit data count
column string Column name
order desc or asc Sort the result set in ascending or descending order.

NOTE:

For GET method, if {{offset}}, {{limit}}, {{column}}, and {{order}} not provided then Kiwire will return default value eg : https://{{kiwire_ip}}/api/admin/0/10/id/desc/