Users

Users

Operations related to user management and authentication.

Users Endpoints

Create a user

Creates a new user account (Contributor or PowerReader).

Body
application/json

The user to create.

Schema for creating a new user.

userName
string
required

The login for the new user.

userInfo
object
required
userType
string enum
default:
PowerReader

Type of the user.

  • Contributor
  • PowerReader
userRole
string

Comma-separated list of roles or access groups.

isDontSendEmail
boolean
default:
false

If true, no email notification will be sent to the new user.

Responses
POST/users
curl https://your-portal.clickhelp.co/api/v1/users \
  --request POST \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
  "userName": "",
  "userInfo": {
    "email": "",
    "firstName": "",
    "middleName": "",
    "lastName": ""
  },
  "userType": "PowerReader",
  "userRole": "",
  "isDontSendEmail": false
}'

{
  "userName": "…",
  "isEnabled": true,
  "userType": "Contributor",
  "userRole": "…",
  "userInfo": {
    "email": "hello@example.com",
    "firstName": "…",
    "middleName": "…",
    "lastName": "…",
    "about": "…",
    "avatarImageUrl": "https://example.com",
    "cultureInfoId": "…",
    "isAutoDetectCultureInfo": true,
    "isAutoDetectTimeZone": true,
    "timeZoneId": "…",
    "lastActivityDate": "2026-01-23T22:10:04.180Z"
  }
}

User created successfully.

Get user profile

Returns information and profile data for a specific user.

Path Parameters
  • userLogin
    string
    required

    The login of the user.

Responses
GET/users/{userLogin}
curl https://your-portal.clickhelp.co/api/v1/users/ \
  --header 'Authorization: Basic username:password'

{
  "userName": "…",
  "isEnabled": true,
  "userType": "Contributor",
  "userRole": "…",
  "userInfo": {
    "email": "hello@example.com",
    "firstName": "…",
    "middleName": "…",
    "lastName": "…",
    "about": "…",
    "avatarImageUrl": "https://example.com",
    "cultureInfoId": "…",
    "isAutoDetectCultureInfo": true,
    "isAutoDetectTimeZone": true,
    "timeZoneId": "…",
    "lastActivityDate": "2026-01-23T22:10:04.180Z"
  }
}

Successful operation.

Update user profile

Updates a user's profile information.

Path Parameters
  • userLogin
    string
    required

    The login of the user.

Body
application/json

The user properties to update.

Schema for updating a user's profile.

updatedFields
string
required

A comma-separated list of fields to update (e.g., 'email,userRole,isEnabled').

email
string email
userRole
string
userType
string enum
  • Contributor
  • PowerReader
isEnabled
boolean
Responses
PATCH/users/{userLogin}
curl https://your-portal.clickhelp.co/api/v1/users/ \
  --request PATCH \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
  "updatedFields": "",
  "email": "",
  "userRole": "",
  "userType": "Contributor",
  "isEnabled": true
}'

{
  "userName": "…",
  "isEnabled": true,
  "userType": "Contributor",
  "userRole": "…",
  "userInfo": {
    "email": "hello@example.com",
    "firstName": "…",
    "middleName": "…",
    "lastName": "…",
    "about": "…",
    "avatarImageUrl": "https://example.com",
    "cultureInfoId": "…",
    "isAutoDetectCultureInfo": true,
    "isAutoDetectTimeZone": true,
    "timeZoneId": "…",
    "lastActivityDate": "2026-01-23T22:10:04.180Z"
  }
}

User updated successfully.

Get login token

Generates a temporary login token for a user. This token can be used for sessionless authentication.

Path Parameters
  • userLogin
    string
    required

    The login of the user.

Query Parameters
  • exp
    string date-time

    An ISO 8601 timestamp of the token expiration date (GMT). Defaults to 30 minutes from now.

  • muse
    boolean
    default:
    false

    If true, the token can be used multiple times until expiration. If false, it's consumed on the first use.

Responses
GET/users/{userLogin}/tokens
curl https://your-portal.clickhelp.co/api/v1/users//tokens \
  --header 'Authorization: Basic username:password'

{
  "token": "…",
  "userName": "…",
  "expirationDate": "2026-01-23T22:10:04.180Z",
  "isMultiUse": true
}

Successful operation.

Get publications available to a user

Returns a list of publications available to a specific user.

Path Parameters
  • userLogin
    string
    required

    The login of the user.

Responses
GET/users/{userLogin}/projects
curl https://your-portal.clickhelp.co/api/v1/users//projects \
  --header 'Authorization: Basic username:password'

[
  {
    "id": "…",
    "title": "…",
    "createdOn": "2026-01-23T22:10:04.180Z",
    "visibility": "Private",
    "parentId": "…",
    "fullUrl": "https://example.com",
    "url": "…",
    "parentUrl": "…"
  }
]

A list of publications.