Assign Group to Category via Write API

[yapne]

Hi

I have installed the nodebb-plugin-write-api and testing out the functionality of assigning a Group to a Category. Below is the CURL example i have tried but getting error message

Curl:
curl -XPUT -H "Authorization: Bearer <TOKEN>" --data "privileges=['groups:find:false']&groups=['write-group']" http://<hostname>/api/v2/categories/7/privileges

Error:
{"path":"/api/v2/categories/7/privileges","error":"async is not defined"}

May i confirm if i'm using the API correctly for this request?

@julianlam - Are you able to advise please?

Thanks in advance

Nelson

[baris]

Looks like the async dependency wasn't added https://github.com/NodeBB/nodebb-plugin-write-api/commit/24b76c8cf8a42d62f7e8680c2e262ba8eb5310cf

[yapne]

@baris

I have retested again with the same CURL statement. Now i'm getting

{"path":"/api/v2/categories/7/privileges","error":"Groups is not defined"}

It is complaining on the payload "groups=['write-group']". Are you able to help?

Thanks

[baris]

https://github.com/NodeBB/nodebb-plugin-write-api/commit/8136ec97cc52f44a142e2e473fd4c023af32208c

[yapne]

@baris

retested again and it is saying {"code":"internal-server-error","message":"invalid-group-name","params":{}}

I am using the slug value of the group but getting the error above.

Please advise.

Thanks

[baris]

@yapne said in Assign Group to Category via Write API:

curl -XPUT -H "Authorization: Bearer <TOKEN>" --data "privileges=['groups:find:false']&groups=['write-group']" http://<hostname>/api/v2/categories/7/privileges

I think the correct call would use the group name instead of slug, and the privilege shouldn't have false at the end. Try curl -XPUT -H "Authorization: Bearer <TOKEN>" --data "privileges=['groups:find']&groups=['Write Group']" http://<hostname>/api/v2/categories/7/privileges Replace Write Group with the actual group name.

[yapne]

@baris
I have made the following changes as suggest and it is still throwing the same error message. Tried all different combinations below and none actually worked. Any thoughts?

{
"createtime": 1521473141636,
"deleted": 0,
"description": "First Write Group",
"disableJoinRequests": false,
"hidden": false,
"memberCount": 2,
"name": "Write Group",
"ownerUid": "11",
"private": true,
"slug": "write-group",
"system": false,
"userTitle": "Write Group",
"nameEncoded": "Write%20Group",
"displayName": "Write Group",
"userTitleEnabled": true,
"labelColor": "#000000",
"icon": "",
"createtimeISO": "2018-03-19T15:25:41.636Z",
"cover:url": "/assets/images/cover-default.png",
"cover:thumb:url": "/assets/images/cover-default.png",
"cover:position": "50% 50%"
}

[baris]

I am not sure, can you put a console.log(cid, privilege, group); before this line https://github.com/NodeBB/nodebb-plugin-write-api/blob/master/routes/v2/categories.js#L78 and try again? It sounds like the correct group name is not passed to the function. Those errors are thrown from https://github.com/NodeBB/NodeBB/blob/master/src/groups/create.js#L94-L100

[yapne]

@baris

It is returning nonsense. Have cut down the log as the post was regarded as spam. What's next please?

7 [ [
7 ' [
7 g [
7 r [
7 o [
7 u [
7 p [
7 s [
7 : [
7 f [
7 i [

[baris]

@baris said in Assign Group to Category via Write API:

curl -XPUT -H "Authorization: Bearer <TOKEN>" --data "privileges=['groups:find']&groups=['Write Group']" http://<hostname>/api/v2/categories/7/privileges

Yeah I think the curl command is still wrong try curl -XPUT -H "Authorization: Bearer <TOKEN>" --data "privileges[]=groups:find&groups[]='Write Group'" http://<hostname>/api/v2/categories/7/privileges

[yapne]

@baris That has resolved the issue. If i want to change the privileges for more than one action what would be the format?

I tried privileges[]=groups:find,groups:read OR privileges[]={groups:find,groups:read} OR privileges[]=[{groups:find,groups:read}]

Neither works.

Kindly please advise. Thanks

[baris]

It would be curl -XPUT -H "Authorization: Bearer <TOKEN>" --data "privileges[]=groups:find&privileges[]=groups:read&groups[]='Write Group'" http://<hostname>/api/v2/categories/7/privileges

[yapne]

@baris Many thanks. It has resolved my issue completely.

May I suggest to put up some examples as the syntax and format it not really easy to follow.

Thank you.

[yapne]

@baris @julianlam How do i add user(s) to the category via this write API? Are you able to advise please? Thanks

[yapne]

@yapne said in Assign Group to Category via Write API:

@baris @julianlam How do i add user(s) to the category via this write API? Are you able to advise please? Thanks

Doesn't seem the API support this. Are you able to confirm please?

@baris @julianlam

[PitaJ]

By "adding users" do you mean giving them privileges?

Edit: if that is the case, then you may find it easier to create a group for the category, give it privileges, and then use the write API to add users to the group

[yapne]

@pitaj There is a specific reason why I am not using group. Nodebb doesn't have the capability to assign user's privileges at the topic level. Hence, we are using category as a work around for this missing feature.

Externally to NodeBB, we are giving end users the functionality to create category dynamically and assign users to it. By using group, it may end up creating a lot of groups that are going to be nightmare to maintain. Therefore, i am planning to assign the users directly to the category instead. I think the API does not support this requirement just yet. If you can advise if there is another better way to do this please? Or possibly to enhance the API to assign user's privileges to the category?

Many thanks

Nelson

[yapne]

@PitaJ bumping up