User APIs

Fetch nodebb user details

This api is used for fetching the user details based on user slug from nodebb.

• The endpoint for User is /user/{userslug}
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/user/{userslug}

get

/discussion/user/{userslug}

Path parameters

userslugstringrequired

Header parameters

Authorizationstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://staging.sunbirded.org/api/discussion/user/{userslug}' \
  --header 'Authorization: text'

200

400

200

{
  "websiteLink": "websiteLink",
  "reputation": 5,
  "blocksCount": true,
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "status": "status",
  "birthday": "birthday",
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "title": "title",
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username",
  "latestPosts": [
    null,
    null
  ],
  "bestPosts": [
    null,
    null
  ],
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "_header": {},
  "ips": {},
  "template": {},
  "widgets": {},
  "sso": [
    {},
    {}
  ],
  "profile_links": [
    {},
    {}
  ],
  "breadcrumbs": [
    {},
    {}
  ],
  "selectedGroup": [
    {},
    {}
  ],
  "groups": [
    {},
    {}
  ],
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    }
  ]
}

successful operation

Fetch nodebb user details by using uid

This api is used for fetching the user details based on nodebb uid.

• The endpoint for User is /user/uid/{uid}
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/user/uid/{uid}

get

/discussion/user/uid/{uid}

Path parameters

uidstringrequired

Header parameters

Authorizationstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://staging.sunbirded.org/api/discussion/user/uid/{uid}' \
  --header 'Authorization: text'

200

400

200

{
  "uid": 1,
  "username": "text",
  "userslug": "text",
  "email:confirmed": 1,
  "joindate": 1,
  "lastonline": 1,
  "picture": {},
  "location": {},
  "birthday": {},
  "website": {},
  "aboutme": {},
  "signature": {},
  "uploadedpicture": {},
  "profileviews": 1,
  "reputation": 1,
  "postcount": 1,
  "topiccount": 1,
  "lastposttime": 1,
  "banned": 1,
  "banned:expire": 1,
  "status": "text",
  "flags": {},
  "followerCount": 1,
  "followingCount": 1,
  "cover:url": {},
  "cover:position": {},
  "groupTitle": {},
  "sunbird-oidcId": {},
  "displayname": "text",
  "groupTitleArray": {},
  "icon:text": "text",
  "icon:bgColor": "text",
  "joindateISO": "text",
  "lastonlineISO": "text",
  "banned_until": 1,
  "banned_until_readable": "text"
}

successful operation

Fetch user upvoted posts list

This api is used for fetching the user upvote details from nodebb.

• The endpoint for User is /user/{userslug}/upvoted
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/user/{userslug}/upvoted

get

/discussion/user/{userslug}/upvoted

Path parameters

userslugstringrequired

Header parameters

Authorizationstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://staging.sunbirded.org/api/discussion/user/{userslug}/upvoted' \
  --header 'Authorization: text'

200

400

200

{
  "websiteLink": "websiteLink",
  "reputation": 5,
  "blocksCount": true,
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "status": "status",
  "birthday": "birthday",
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "title": "title",
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username",
  "latestPosts": [
    null,
    null
  ],
  "bestPosts": [
    null,
    null
  ],
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "_header": {},
  "ips": {},
  "template": {},
  "widgets": {},
  "sso": [
    {},
    {}
  ],
  "profile_links": [
    {},
    {}
  ],
  "breadcrumbs": [
    {},
    {}
  ],
  "selectedGroup": [
    {},
    {}
  ],
  "groups": [
    {},
    {}
  ],
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    }
  ]
}

successful operation

Fetch user downvoted posts list

This api is used for fetching the user down vote details from nodebb.

• The endpoint for User is /user/{userslug}/downvoted
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/user/{userslug}/downvoted

get

/discussion/user/{userslug}/downvoted

Path parameters

userslugstringrequired

Header parameters

Authorizationstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://staging.sunbirded.org/api/discussion/user/{userslug}/downvoted' \
  --header 'Authorization: text'

200

400

200

{
  "websiteLink": "websiteLink",
  "reputation": 5,
  "blocksCount": true,
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "status": "status",
  "birthday": "birthday",
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "title": "title",
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username",
  "latestPosts": [
    null,
    null
  ],
  "bestPosts": [
    null,
    null
  ],
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "_header": {},
  "ips": {},
  "template": {},
  "widgets": {},
  "sso": [
    {},
    {}
  ],
  "profile_links": [
    {},
    {}
  ],
  "breadcrumbs": [
    {},
    {}
  ],
  "selectedGroup": [
    {},
    {}
  ],
  "groups": [
    {},
    {}
  ],
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    }
  ]
}

successful operation

Fetch user bookmarked posts

This api is used for fetching the user bookmark post details from nodebb.

• The endpoint for User is /user/{userslug}/bookmarks
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/user/{userslug}/bookmarks

get

/discussion/user/{userslug}/bookmarks

Path parameters

userslugstringrequired

Header parameters

Authorizationstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://staging.sunbirded.org/api/discussion/user/{userslug}/bookmarks' \
  --header 'Authorization: text'

200

400

200

{
  "websiteLink": "websiteLink",
  "reputation": 5,
  "blocksCount": true,
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "status": "status",
  "birthday": "birthday",
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "title": "title",
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username",
  "latestPosts": [
    null,
    null
  ],
  "bestPosts": [
    null,
    null
  ],
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "_header": {},
  "ips": {},
  "template": {},
  "widgets": {},
  "sso": [
    {},
    {}
  ],
  "profile_links": [
    {},
    {}
  ],
  "breadcrumbs": [
    {},
    {}
  ],
  "selectedGroup": [
    {},
    {}
  ],
  "groups": [
    {},
    {}
  ],
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    }
  ]
}

successful operation

Fetch user recent posts

This api is used for fetching the user recent post details from nodebb.

• The endpoint for User is /user/{userslug}/posts
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/user/{userslug}/posts

get

/discussion/user/{userslug}/posts

Path parameters

userslugstringrequired

Header parameters

Authorizationstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://staging.sunbirded.org/api/discussion/user/{userslug}/posts' \
  --header 'Authorization: text'

200

400

200

{
  "websiteLink": "websiteLink",
  "reputation": 5,
  "blocksCount": true,
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "status": "status",
  "birthday": "birthday",
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "title": "title",
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username",
  "latestPosts": [
    null,
    null
  ],
  "bestPosts": [
    null,
    null
  ],
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "_header": {},
  "ips": {},
  "template": {},
  "widgets": {},
  "sso": [
    {},
    {}
  ],
  "profile_links": [
    {},
    {}
  ],
  "breadcrumbs": [
    {},
    {}
  ],
  "selectedGroup": [
    {},
    {}
  ],
  "groups": [
    {},
    {}
  ],
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "votes": 9,
      "timestamp": 4,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "tid": 9,
        "slug": "slug",
        "cid": 6,
        "teaserPid": {}
      },
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass",
        "backgroundImage": {}
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "username": "username",
        "status": "status",
        "picture": {}
      }
    }
  ]
}

successful operation

Create new user in nodebb using write api plugin

This api is used for creating the user in nodebb using write api plugin.

• The endpoint for User is /v2/users
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/v2/users

post

/discussion/v2/users

Header parameters

Authorizationstring

Body

usernamestring

emailstring

passwordstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/v2/users' \
  --header 'Content-Type: application/json' \
  --data '{"username":"Vinu Kumar","email":"[e-mail]","password":"Test@123"}'

200

400

200

{
  "code": "code",
  "payload": {
    "uid": 0
  }
}

successful operation

Create new user in nodebb Sunbird OIDC

This api is used for creating the user in nodebb usig Sunbird OIDC plugin.

• The endpoint for User is /user/v1/create
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/user/v1/create

post

/discussion/user/v1/create

Header parameters

Authorizationstring

Body

requestobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/user/v1/create' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"example":{"id":"api.discussions.user.create","ver":1,"responseCode":400,"params":{"resmsgid":null,"msgid":null,"status":"unsuccessful","msg":"User already Exists"},"result":{"userSlug":"content_creator_tn3941","userName":"content_creator_tn3941","userId":{"uid":1}}}}}'

200

400

200

{
  "id": "text",
  "ver": "text",
  "responseCode": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "status": "text",
    "msg": "text"
  },
  "result": {
    "userSlug": "text",
    "userName": "text",
    "userId": {
      "uid": 1
    }
  }
}

successful operation

Updates a user's profile information

This api is used to update user's profile information in nodebb.

• The endpoint for User is /v2/users/{uid}
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/v2/users/{uid}

put

/discussion/v2/users/{uid}

Path parameters

uidintegerrequired

Header parameters

Authorizationstring

Body

usernamestring

emailstring

fullnamestring

websitestring

locationstring

birthdaystring

signaturestring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://staging.sunbirded.org/api/discussion/v2/users/{uid}' \
  --header 'Content-Type: application/json' \
  --data '{"username":"Venkat","email":"[e-mail]","fullname":"venkat kadiveti","website":"https://example.org/","location":"Bangalore","birthday":"02/04/1995","signature":"venkat"}'

200

400

200

{
  "code": "code",
  "payload": {}
}

successful operation

Deletes a user from nodebb

This api is used for deleting user in nodebb.

• The endpoint for User is /v2/users/{uid}
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/v2/users/{uid}

delete

/discussion/v2/users/{uid}

Path parameters

uidintegerrequired

Header parameters

Authorizationstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://staging.sunbirded.org/api/discussion/v2/users/{uid}'

200

400

200

{
  "code": "code",
  "payload": {}
}

successful operation