Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Users

Operations for managing users

Get groups matching the given filters.

get

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Query parameters
namestringOptional

Filter groups whose name contains a specific string.

rolestring · enumOptional

Filter groups with specific role.

Possible values:
Responses
200

OK

application/json
namestringRequired

The name of the group.

get/rest/v5/groups
GET /fact-finder/rest/v5/groups HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

[
  {
    "name": "text",
    "roles": [
      "AbTestManager"
    ]
  }
]

Create a new group. Non-admin user are not allowed to create groups containing api roles.

post

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Body
namestringRequired

The name of the group.

Responses
200

OK

application/json
namestringRequired

The name of the group.

post/rest/v5/groups
POST /fact-finder/rest/v5/groups HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "name": "text",
  "roles": [
    "AbTestManager"
  ]
}
{
  "name": "text",
  "roles": [
    "AbTestManager"
  ]
}

Update group. Non-admin user are not allowed to add new api roles to the group.

put

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Body
namestringRequired

The name of the group.

Responses
200

OK

application/json
namestringRequired

The name of the group.

put/rest/v5/groups
PUT /fact-finder/rest/v5/groups HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "name": "text",
  "roles": [
    "AbTestManager"
  ]
}
{
  "name": "text",
  "roles": [
    "AbTestManager"
  ]
}

Delete multiple groups.

delete

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Query parameters
namestring[]Required

List with names of the groups that should be deleted.

Responses
200

OK

application/json
namestringRequired

The name of the group.

delete/rest/v5/groups
DELETE /fact-finder/rest/v5/groups?name=text HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

[
  {
    "name": "text",
    "roles": [
      "AbTestManager"
    ]
  }
]

Delete the group with the given name.

delete

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Path parameters
namestringRequired

Name of the group which should be deleted.

Responses
200

OK

application/json
namestringRequired

The name of the group.

delete/rest/v5/groups/{name}
DELETE /fact-finder/rest/v5/groups/{name} HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

{
  "name": "text",
  "roles": [
    "AbTestManager"
  ]
}

Get visible channels

get

Required Roles: none

Authorizations
AuthorizationstringRequired
Responses
200

OK

application/json
string[]Optional
get/rest/v5/user/channel
GET /fact-finder/rest/v5/user/channel HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

[
  "text"
]

Get the users, which fulfil the given filters.

get

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Query parameters
channelstringOptional

Filter users assigned a specific channel.

groupstringOptional

Filter users who are part of a specific group.

namestringOptional

Filter users whose name contains a specific string.

rolestring · enumOptional

Filter users with a specific role.

Possible values:
Responses
200

OK

application/json

Represents a user and its settings.

lastActivestring · date-timeRequired

Date of the last activity of the user or the creation date, when the user did not log in, yet.

namestringRequired

The name of the user.

originstring · enumRequired

If the user is managed locally or remotely.

Possible values:
get/rest/v5/users
GET /fact-finder/rest/v5/users HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

[
  {
    "lastActive": "2026-01-01T00:00:00.000Z",
    "name": "text",
    "origin": "LOCAL",
    "permissions": {
      "allowAllCurrentAndFutureChannels": true,
      "channels": [
        "text"
      ],
      "groups": [
        "text"
      ],
      "roles": [
        "AbTestManager"
      ]
    },
    "uiSettings": {
      "enableAdvancedMode": true,
      "hideErrorNotifications": true,
      "hideInactiveModules": true,
      "locale": "text"
    }
  }
]

Create a new local user. Non-admin user are not allowed to create user with api roles or admin user. Only channels known by the creating user can be added to the new user.

post

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Body

Represents a user, which should be created, and its settings.

namestring · min: 1 · max: 100Required

The name of the user.

passwordstringRequired

The password of the user in plaintext.

ssoEnabledbooleanOptional
Responses
200

OK

application/json

Represents a user and its settings.

lastActivestring · date-timeRequired

Date of the last activity of the user or the creation date, when the user did not log in, yet.

namestringRequired

The name of the user.

originstring · enumRequired

If the user is managed locally or remotely.

Possible values:
post/rest/v5/users
POST /fact-finder/rest/v5/users HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 285

{
  "name": "text",
  "password": "text",
  "permissions": {
    "allowAllCurrentAndFutureChannels": true,
    "channels": [
      "text"
    ],
    "groups": [
      "text"
    ],
    "roles": [
      "AbTestManager"
    ]
  },
  "ssoEnabled": true,
  "uiSettings": {
    "enableAdvancedMode": true,
    "hideErrorNotifications": true,
    "hideInactiveModules": true,
    "locale": "text"
  }
}
{
  "lastActive": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "origin": "LOCAL",
  "permissions": {
    "allowAllCurrentAndFutureChannels": true,
    "channels": [
      "text"
    ],
    "groups": [
      "text"
    ],
    "roles": [
      "AbTestManager"
    ]
  },
  "uiSettings": {
    "enableAdvancedMode": true,
    "hideErrorNotifications": true,
    "hideInactiveModules": true,
    "locale": "text"
  }
}

Update user ui settings and permissions. Non-admin user are not allowed to add api roles or channels unknown to the creating user. Use dedicated api, if you want to change the password.

put

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Body

Represents a user, which should be updated, and its settings.

namestringRequired

The name of the user.

Responses
200

OK

application/json

Represents a user and its settings.

lastActivestring · date-timeRequired

Date of the last activity of the user or the creation date, when the user did not log in, yet.

namestringRequired

The name of the user.

originstring · enumRequired

If the user is managed locally or remotely.

Possible values:
put/rest/v5/users
PUT /fact-finder/rest/v5/users HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 249

{
  "name": "text",
  "permissions": {
    "allowAllCurrentAndFutureChannels": true,
    "channels": [
      "text"
    ],
    "groups": [
      "text"
    ],
    "roles": [
      "AbTestManager"
    ]
  },
  "uiSettings": {
    "enableAdvancedMode": true,
    "hideErrorNotifications": true,
    "hideInactiveModules": true,
    "locale": "text"
  }
}
{
  "lastActive": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "origin": "LOCAL",
  "permissions": {
    "allowAllCurrentAndFutureChannels": true,
    "channels": [
      "text"
    ],
    "groups": [
      "text"
    ],
    "roles": [
      "AbTestManager"
    ]
  },
  "uiSettings": {
    "enableAdvancedMode": true,
    "hideErrorNotifications": true,
    "hideInactiveModules": true,
    "locale": "text"
  }
}

Delete multiple users.

delete

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Query parameters
namestring[]Required

The names of users that will be deleted.

Responses
200

OK

application/json

Represents a user and its settings.

lastActivestring · date-timeRequired

Date of the last activity of the user or the creation date, when the user did not log in, yet.

namestringRequired

The name of the user.

originstring · enumRequired

If the user is managed locally or remotely.

Possible values:
delete/rest/v5/users
DELETE /fact-finder/rest/v5/users?name=text HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

[
  {
    "lastActive": "2026-01-01T00:00:00.000Z",
    "name": "text",
    "origin": "LOCAL",
    "permissions": {
      "allowAllCurrentAndFutureChannels": true,
      "channels": [
        "text"
      ],
      "groups": [
        "text"
      ],
      "roles": [
        "AbTestManager"
      ]
    },
    "uiSettings": {
      "enableAdvancedMode": true,
      "hideErrorNotifications": true,
      "hideInactiveModules": true,
      "locale": "text"
    }
  }
]

Delete user.

delete

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Path parameters
userNamestringRequired

The name of user that will be deleted.

Responses
200

OK

application/json

Represents a user and its settings.

lastActivestring · date-timeRequired

Date of the last activity of the user or the creation date, when the user did not log in, yet.

namestringRequired

The name of the user.

originstring · enumRequired

If the user is managed locally or remotely.

Possible values:
delete/rest/v5/users/{userName}
DELETE /fact-finder/rest/v5/users/{userName} HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Accept: */*

{
  "lastActive": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "origin": "LOCAL",
  "permissions": {
    "allowAllCurrentAndFutureChannels": true,
    "channels": [
      "text"
    ],
    "groups": [
      "text"
    ],
    "roles": [
      "AbTestManager"
    ]
  },
  "uiSettings": {
    "enableAdvancedMode": true,
    "hideErrorNotifications": true,
    "hideInactiveModules": true,
    "locale": "text"
  }
}

Update user password. The password is expected to be plain text. Only passwords for local users can be changed.

put

Required Roles: ApiUsers

Authorizations
AuthorizationstringRequired
Path parameters
userNamestringRequired

The name of the user, whose password should be changed.

Body
stringOptional

The password

Responses
200

OK

application/json

Represents a user and its settings.

lastActivestring · date-timeRequired

Date of the last activity of the user or the creation date, when the user did not log in, yet.

namestringRequired

The name of the user.

originstring · enumRequired

If the user is managed locally or remotely.

Possible values:
put/rest/v5/users/{userName}/password
PUT /fact-finder/rest/v5/users/{userName}/password HTTP/1.1
Host: vector-demo.fact-finder.de/
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "lastActive": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "origin": "LOCAL",
  "permissions": {
    "allowAllCurrentAndFutureChannels": true,
    "channels": [
      "text"
    ],
    "groups": [
      "text"
    ],
    "roles": [
      "AbTestManager"
    ]
  },
  "uiSettings": {
    "enableAdvancedMode": true,
    "hideErrorNotifications": true,
    "hideInactiveModules": true,
    "locale": "text"
  }
}
PreviousTrackingNextModels

Last updated

Was this helpful?