Open API v2 / Files & System / Admin Users

Admin Users

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/admin-users#

Retrieves a list of admin users by using a "where" filtering

Parameters

Wherestring · query

JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.

Order_Bystring · query

Sort field. Prefix with - for descending; comma-separate for tie-breakers.

Semantic_Querystring · query

Natural-language search, ranked by relevance.

Min_Scorenumber · query

Lowest relevance score to include when using Semantic_Query.

Offsetinteger · query

Number of items to skip before returning results. Defaults to 0.

Limitinteger · query

Maximum number of items to return. Defaults to 100.

Response

Idinteger

The unique identifier of the administrator entry in the access rights table. Read-only.

IsInvitedboolean

A boolean flag indicating whether the user has been sent an email invitation. If true, the user has yet to confirm registration or set a password.

FirstNamestring · nullable

User name.

LastNamestring · nullable

User's last name.

Emailstring · nullable

An email address that is also the login for entering the admin panel.

EnableOseboolean

This flag enables specific access rights to the advanced operator interface.

UserIdinteger

Global user identifier in a common authentication system.

RoleIdinteger · nullable

The numeric identifier of the assigned role, which defines the set of available permissions.

curl "https://your-site.webinone.com/api/v2/admin/admin-users" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/admin-users", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/admin-users",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/admin-users', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/admin-users");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "IsInvited": false,
      "FirstName": "Example",
      "LastName": "Example",
      "Email": "user@example.com",
      "EnableOse": false,
      "UserId": 1,
      "RoleId": 1
    }
  ],
  "TotalItemsCount": 0
}

POST/api/v2/admin/admin-users#

Creates a new admin user

Body parameters

FirstNamestringrequired

User name.

LastNamestringrequired

User's last name.

Emailstringrequired

An email address that is also the login for entering the admin panel.

EnableOseboolean

This flag enables specific access rights to the advanced operator interface.

Roleinteger

Access level granted to the member.

Response

Idinteger

The unique identifier of the administrator entry in the access rights table. Read-only.

IsInvitedboolean

A boolean flag indicating whether the user has been sent an email invitation. If true, the user has yet to confirm registration or set a password.

FirstNamestring · nullable

User name.

LastNamestring · nullable

User's last name.

Emailstring · nullable

An email address that is also the login for entering the admin panel.

EnableOseboolean

This flag enables specific access rights to the advanced operator interface.

UserIdinteger

Global user identifier in a common authentication system.

RoleIdinteger · nullable

The numeric identifier of the assigned role, which defines the set of available permissions.

curl -X POST "https://your-site.webinone.com/api/v2/admin/admin-users" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"FirstName":"Example","LastName":"Example","Email":"user@example.com","EnableOse":false,"Role":0}'

await fetch("https://your-site.webinone.com/api/v2/admin/admin-users", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "FirstName": "Example",
    "LastName": "Example",
    "Email": "user@example.com",
    "EnableOse": false,
    "Role": 0
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/admin-users",
    headers={"Authorization": "Bearer <token>"},
    json={
        "FirstName": "Example",
        "LastName": "Example",
        "Email": "user@example.com",
        "EnableOse": False,
        "Role": 0
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/admin-users', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'FirstName' => 'Example',
        'LastName' => 'Example',
        'Email' => 'user@example.com',
        'EnableOse' => false,
        'Role' => 0
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/admin-users");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"FirstName\":\"Example\",\"LastName\":\"Example\",\"Email\":\"user@example.com\",\"EnableOse\":false,\"Role\":0}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "IsInvited": false,
  "FirstName": "Example",
  "LastName": "Example",
  "Email": "user@example.com",
  "EnableOse": false,
  "UserId": 1,
  "RoleId": 1
}

GET/api/v2/admin/admin-users/{id}#

Retrieves a single admin user

Parameters

idinteger · pathrequired

User id.

Response

Idinteger

The unique identifier of the administrator entry in the access rights table. Read-only.

IsInvitedboolean

A boolean flag indicating whether the user has been sent an email invitation. If true, the user has yet to confirm registration or set a password.

FirstNamestring · nullable

User name.

LastNamestring · nullable

User's last name.

Emailstring · nullable

An email address that is also the login for entering the admin panel.

EnableOseboolean

This flag enables specific access rights to the advanced operator interface.

UserIdinteger

Global user identifier in a common authentication system.

RoleIdinteger · nullable

The numeric identifier of the assigned role, which defines the set of available permissions.

curl "https://your-site.webinone.com/api/v2/admin/admin-users/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/admin-users/1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/admin-users/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/admin-users/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/admin-users/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "IsInvited": false,
  "FirstName": "Example",
  "LastName": "Example",
  "Email": "user@example.com",
  "EnableOse": false,
  "UserId": 1,
  "RoleId": 1
}

PUT/api/v2/admin/admin-users/{id}#

Updates an existing admin user

Parameters

idinteger · pathrequired

Existent admin user id.

Body parameters

EnableOseboolean

This flag enables specific access rights to the advanced operator interface.

Roleinteger

Access level granted to the member.

Response

Idinteger

The unique identifier of the administrator entry in the access rights table. Read-only.

IsInvitedboolean

A boolean flag indicating whether the user has been sent an email invitation. If true, the user has yet to confirm registration or set a password.

FirstNamestring · nullable

User name.

LastNamestring · nullable

User's last name.

Emailstring · nullable

An email address that is also the login for entering the admin panel.

EnableOseboolean

This flag enables specific access rights to the advanced operator interface.

UserIdinteger

Global user identifier in a common authentication system.

RoleIdinteger · nullable

The numeric identifier of the assigned role, which defines the set of available permissions.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/admin-users/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"EnableOse":false,"Role":0}'

await fetch("https://your-site.webinone.com/api/v2/admin/admin-users/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "EnableOse": false,
    "Role": 0
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/admin-users/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "EnableOse": False,
        "Role": 0
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/admin-users/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'EnableOse' => false,
        'Role' => 0
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/admin-users/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"EnableOse\":false,\"Role\":0}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "IsInvited": false,
  "FirstName": "Example",
  "LastName": "Example",
  "Email": "user@example.com",
  "EnableOse": false,
  "UserId": 1,
  "RoleId": 1
}

DELETE/api/v2/admin/admin-users/{id}#

Deletes an existing admin user

Parameters

idinteger · pathrequired

Existent admin user id.

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/admin-users/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/admin-users/1", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/admin-users/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/admin-users/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/admin-users/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

POST/api/v2/admin/admin-users/{id}/re-invite#

Creates a new admin user

Parameters

idstring · pathrequired

Resource identifier.

Response

Idinteger

The unique identifier of the administrator entry in the access rights table. Read-only.

IsInvitedboolean

A boolean flag indicating whether the user has been sent an email invitation. If true, the user has yet to confirm registration or set a password.

FirstNamestring · nullable

User name.

LastNamestring · nullable

User's last name.

Emailstring · nullable

An email address that is also the login for entering the admin panel.

EnableOseboolean

This flag enables specific access rights to the advanced operator interface.

UserIdinteger

Global user identifier in a common authentication system.

RoleIdinteger · nullable

The numeric identifier of the assigned role, which defines the set of available permissions.

curl -X POST "https://your-site.webinone.com/api/v2/admin/admin-users/1/re-invite" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/admin-users/1/re-invite", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/admin-users/1/re-invite",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/admin-users/1/re-invite', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/admin-users/1/re-invite");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "IsInvited": false,
  "FirstName": "Example",
  "LastName": "Example",
  "Email": "user@example.com",
  "EnableOse": false,
  "UserId": 1,
  "RoleId": 1
}