UserAccessGroup

Returns a list of UserAccessGroup entries.

GET/api/user_access_group

Responses

200Return all UserAccessGrouparray<UserAccessGroup>

Show fields (81)

idinteger
Primary key of the user access group. Internal ID, used as the reference by users and access tokens.
namestring
Name of the user access group. Shown to administrators when they assign users to a group.
super_adminboolean
Super admin flag of the group. Members of a super admin group have all rights, including the administration of other admin groups.
adminboolean
Admin flag of the group. Members of an admin group can manage users and access rights.
userboolean
User flag of the group. Standard flag for regular members.
guestboolean
Guest flag of the group. Guests get only the rights explicitly granted to them.
read_installationsboolean
Read access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
write_installationsboolean
Write access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
read_userboolean
Read access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
write_userboolean
Write access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
read_customerprofileboolean
Read access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
write_customerprofileboolean
Write access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
read_crmboolean
Read access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
write_crmboolean
Write access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
read_crm_projectboolean
Read access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
write_crm_projectboolean
Write access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
read_billingboolean
Read access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
write_billingboolean
Write access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
read_taxaccountingboolean
Read access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
write_taxaccountingboolean
Write access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
read_donationsboolean
Read access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
write_donationsboolean
Write access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
read_productsboolean
Read access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
write_productsboolean
Write access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
read_ticketboolean
Read access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_ticketboolean
Write access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_own_ticketboolean
Write access to own tickets only. Users can only change tickets assigned to them.
read_timeboolean
Read access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
write_timeboolean
Write access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
read_trainer_timeboolean
Read access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
write_trainer_timeboolean
Write access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
read_studio_trainingboolean
Read access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
write_studio_trainingboolean
Write access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
read_callboolean
Read access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
write_callboolean
Write access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
read_hrboolean
Read access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
write_hrboolean
Write access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
read_srvboolean
Read access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
write_srvboolean
Write access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
read_domainboolean
Read access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
write_domainboolean
Write access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
read_softwareboolean
Read access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
write_softwareboolean
Write access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
read_privacyboolean
Read access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
write_privacyboolean
Write access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
read_eventboolean
Read access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
write_eventboolean
Write access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
read_event_bookingboolean
Read access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
write_event_bookingboolean
Write access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
read_event_booking_groupboolean
Read access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
write_event_booking_groupboolean
Write access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
read_maintenanceboolean
Read access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_maintenanceboolean
Write access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_event_availabilityboolean
Write access to event availability. Grants the write permission for the availability scope 'event_availability'.
write_easboolean
Write access to the event attendance scanner. Grants the write permission for the scope 'eas'.
write_wtesboolean
Write access to the work time entry scanner. Grants the write permission for the scope 'wtes'.
write_statsboolean
Write access to statistics. Grants the write permission for the statistics scope 'stats'.
read_shortlinkboolean
Read access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
write_shortlinkboolean
Write access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
read_mediaboolean
Read access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
write_mediaboolean
Write access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
read_settingsboolean
Read access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
write_settingsboolean
Write access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
read_dwiboolean
Read access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
write_dwiboolean
Write access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
read_fltboolean
Read access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
write_fltboolean
Write access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
read_c1boolean
Read access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
write_c1boolean
Write access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
read_chboolean
Read access to change history. Grants the read permission for the scope 'ch'.
read_siboolean
Read access to short information. Grants the read permission for the scope 'si'.
read_ptboolean
Read access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
write_ptboolean
Write access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
read_locboolean
Read access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
write_locboolean
Write access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
read_notifyboolean
Read access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
write_notifyboolean
Write access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
read_chatboolean
Read access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_chatboolean
Write access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_webhookboolean
Write access to webhooks. Grants the write permission for the scope 'webhook'.
… 6 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/user_access_group \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/user_access_group', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/user_access_group"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/user_access_group', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/user_access_group"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/user_access_group")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/user_access_group"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/user_access_group_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await UserAccessGroupController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "super_admin": true,
    "admin": true,
    "user": true,
    "guest": true,
    "read_installations": true,
    "write_installations": true,
    "read_user": true,
    "write_user": true
  }
]

Creates a new UserAccessGroup entry.

POST/api/user_access_group

Request body application/json

dataUpdateUserAccessGroup

Responses

200Add new UserAccessGroupUserAccessGroup

Show fields (81)

idinteger
Primary key of the user access group. Internal ID, used as the reference by users and access tokens.
namestring
Name of the user access group. Shown to administrators when they assign users to a group.
super_adminboolean
Super admin flag of the group. Members of a super admin group have all rights, including the administration of other admin groups.
adminboolean
Admin flag of the group. Members of an admin group can manage users and access rights.
userboolean
User flag of the group. Standard flag for regular members.
guestboolean
Guest flag of the group. Guests get only the rights explicitly granted to them.
read_installationsboolean
Read access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
write_installationsboolean
Write access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
read_userboolean
Read access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
write_userboolean
Write access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
read_customerprofileboolean
Read access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
write_customerprofileboolean
Write access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
read_crmboolean
Read access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
write_crmboolean
Write access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
read_crm_projectboolean
Read access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
write_crm_projectboolean
Write access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
read_billingboolean
Read access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
write_billingboolean
Write access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
read_taxaccountingboolean
Read access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
write_taxaccountingboolean
Write access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
read_donationsboolean
Read access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
write_donationsboolean
Write access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
read_productsboolean
Read access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
write_productsboolean
Write access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
read_ticketboolean
Read access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_ticketboolean
Write access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_own_ticketboolean
Write access to own tickets only. Users can only change tickets assigned to them.
read_timeboolean
Read access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
write_timeboolean
Write access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
read_trainer_timeboolean
Read access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
write_trainer_timeboolean
Write access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
read_studio_trainingboolean
Read access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
write_studio_trainingboolean
Write access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
read_callboolean
Read access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
write_callboolean
Write access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
read_hrboolean
Read access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
write_hrboolean
Write access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
read_srvboolean
Read access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
write_srvboolean
Write access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
read_domainboolean
Read access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
write_domainboolean
Write access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
read_softwareboolean
Read access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
write_softwareboolean
Write access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
read_privacyboolean
Read access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
write_privacyboolean
Write access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
read_eventboolean
Read access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
write_eventboolean
Write access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
read_event_bookingboolean
Read access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
write_event_bookingboolean
Write access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
read_event_booking_groupboolean
Read access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
write_event_booking_groupboolean
Write access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
read_maintenanceboolean
Read access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_maintenanceboolean
Write access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_event_availabilityboolean
Write access to event availability. Grants the write permission for the availability scope 'event_availability'.
write_easboolean
Write access to the event attendance scanner. Grants the write permission for the scope 'eas'.
write_wtesboolean
Write access to the work time entry scanner. Grants the write permission for the scope 'wtes'.
write_statsboolean
Write access to statistics. Grants the write permission for the statistics scope 'stats'.
read_shortlinkboolean
Read access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
write_shortlinkboolean
Write access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
read_mediaboolean
Read access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
write_mediaboolean
Write access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
read_settingsboolean
Read access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
write_settingsboolean
Write access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
read_dwiboolean
Read access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
write_dwiboolean
Write access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
read_fltboolean
Read access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
write_fltboolean
Write access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
read_c1boolean
Read access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
write_c1boolean
Write access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
read_chboolean
Read access to change history. Grants the read permission for the scope 'ch'.
read_siboolean
Read access to short information. Grants the read permission for the scope 'si'.
read_ptboolean
Read access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
write_ptboolean
Write access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
read_locboolean
Read access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
write_locboolean
Write access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
read_notifyboolean
Read access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
write_notifyboolean
Write access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
read_chatboolean
Read access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_chatboolean
Write access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_webhookboolean
Write access to webhooks. Grants the write permission for the scope 'webhook'.
… 6 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/user_access_group \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://your-instance.iw-erp.de/api/user_access_group', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/user_access_group"

payload = {}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/user_access_group', [
  'body' => '{}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/user_access_group"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/user_access_group")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/user_access_group"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/user_access_group_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/user_access_group.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await UserAccessGroupController.post(UserAccessGroup.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "super_admin": true,
  "admin": true,
  "user": true,
  "guest": true,
  "read_installations": true,
  "write_installations": true,
  "read_user": true,
  "write_user": true
}

Return a single UserAccessGroup

GET/api/user_access_group/{identifier}

Path parameters

identifierrequiredstring

Responses

200Return a single UserAccessGroupUserAccessGroup

Show fields (81)

idinteger
Primary key of the user access group. Internal ID, used as the reference by users and access tokens.
namestring
Name of the user access group. Shown to administrators when they assign users to a group.
super_adminboolean
Super admin flag of the group. Members of a super admin group have all rights, including the administration of other admin groups.
adminboolean
Admin flag of the group. Members of an admin group can manage users and access rights.
userboolean
User flag of the group. Standard flag for regular members.
guestboolean
Guest flag of the group. Guests get only the rights explicitly granted to them.
read_installationsboolean
Read access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
write_installationsboolean
Write access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
read_userboolean
Read access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
write_userboolean
Write access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
read_customerprofileboolean
Read access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
write_customerprofileboolean
Write access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
read_crmboolean
Read access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
write_crmboolean
Write access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
read_crm_projectboolean
Read access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
write_crm_projectboolean
Write access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
read_billingboolean
Read access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
write_billingboolean
Write access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
read_taxaccountingboolean
Read access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
write_taxaccountingboolean
Write access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
read_donationsboolean
Read access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
write_donationsboolean
Write access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
read_productsboolean
Read access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
write_productsboolean
Write access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
read_ticketboolean
Read access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_ticketboolean
Write access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_own_ticketboolean
Write access to own tickets only. Users can only change tickets assigned to them.
read_timeboolean
Read access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
write_timeboolean
Write access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
read_trainer_timeboolean
Read access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
write_trainer_timeboolean
Write access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
read_studio_trainingboolean
Read access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
write_studio_trainingboolean
Write access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
read_callboolean
Read access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
write_callboolean
Write access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
read_hrboolean
Read access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
write_hrboolean
Write access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
read_srvboolean
Read access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
write_srvboolean
Write access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
read_domainboolean
Read access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
write_domainboolean
Write access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
read_softwareboolean
Read access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
write_softwareboolean
Write access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
read_privacyboolean
Read access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
write_privacyboolean
Write access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
read_eventboolean
Read access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
write_eventboolean
Write access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
read_event_bookingboolean
Read access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
write_event_bookingboolean
Write access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
read_event_booking_groupboolean
Read access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
write_event_booking_groupboolean
Write access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
read_maintenanceboolean
Read access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_maintenanceboolean
Write access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_event_availabilityboolean
Write access to event availability. Grants the write permission for the availability scope 'event_availability'.
write_easboolean
Write access to the event attendance scanner. Grants the write permission for the scope 'eas'.
write_wtesboolean
Write access to the work time entry scanner. Grants the write permission for the scope 'wtes'.
write_statsboolean
Write access to statistics. Grants the write permission for the statistics scope 'stats'.
read_shortlinkboolean
Read access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
write_shortlinkboolean
Write access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
read_mediaboolean
Read access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
write_mediaboolean
Write access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
read_settingsboolean
Read access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
write_settingsboolean
Write access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
read_dwiboolean
Read access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
write_dwiboolean
Write access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
read_fltboolean
Read access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
write_fltboolean
Write access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
read_c1boolean
Read access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
write_c1boolean
Write access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
read_chboolean
Read access to change history. Grants the read permission for the scope 'ch'.
read_siboolean
Read access to short information. Grants the read permission for the scope 'si'.
read_ptboolean
Read access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
write_ptboolean
Write access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
read_locboolean
Read access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
write_locboolean
Write access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
read_notifyboolean
Read access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
write_notifyboolean
Write access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
read_chatboolean
Read access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_chatboolean
Write access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_webhookboolean
Write access to webhooks. Grants the write permission for the scope 'webhook'.
… 6 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/user_access_group/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/user_access_group/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/user_access_group/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/user_access_group/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/user_access_group/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/user_access_group/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/user_access_group/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/user_access_group_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await UserAccessGroupController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "super_admin": true,
  "admin": true,
  "user": true,
  "guest": true,
  "read_installations": true,
  "write_installations": true,
  "read_user": true,
  "write_user": true
}

Update a single UserAccessGroup

PUT/api/user_access_group/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataUserAccessGroup
Show fields (81)
- idinteger
  Primary key of the user access group. Internal ID, used as the reference by users and access tokens.
- namestring
  Name of the user access group. Shown to administrators when they assign users to a group.
- super_adminboolean
  Super admin flag of the group. Members of a super admin group have all rights, including the administration of other admin groups.
- adminboolean
  Admin flag of the group. Members of an admin group can manage users and access rights.
- userboolean
  User flag of the group. Standard flag for regular members.
- guestboolean
  Guest flag of the group. Guests get only the rights explicitly granted to them.
- read_installationsboolean
  Read access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
- write_installationsboolean
  Write access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
- read_userboolean
  Read access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
- write_userboolean
  Write access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
- read_customerprofileboolean
  Read access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
- write_customerprofileboolean
  Write access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
- read_crmboolean
  Read access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
- write_crmboolean
  Write access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
- read_crm_projectboolean
  Read access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
- write_crm_projectboolean
  Write access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
- read_billingboolean
  Read access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
- write_billingboolean
  Write access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
- read_taxaccountingboolean
  Read access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
- write_taxaccountingboolean
  Write access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
- read_donationsboolean
  Read access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
- write_donationsboolean
  Write access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
- read_productsboolean
  Read access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
- write_productsboolean
  Write access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
- read_ticketboolean
  Read access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
- write_ticketboolean
  Write access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
- write_own_ticketboolean
  Write access to own tickets only. Users can only change tickets assigned to them.
- read_timeboolean
  Read access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
- write_timeboolean
  Write access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
- read_trainer_timeboolean
  Read access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
- write_trainer_timeboolean
  Write access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
- read_studio_trainingboolean
  Read access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
- write_studio_trainingboolean
  Write access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
- read_callboolean
  Read access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
- write_callboolean
  Write access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
- read_hrboolean
  Read access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
- write_hrboolean
  Write access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
- read_srvboolean
  Read access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
- write_srvboolean
  Write access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
- read_domainboolean
  Read access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
- write_domainboolean
  Write access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
- read_softwareboolean
  Read access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
- write_softwareboolean
  Write access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
- read_privacyboolean
  Read access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
- write_privacyboolean
  Write access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
- read_eventboolean
  Read access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
- write_eventboolean
  Write access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
- read_event_bookingboolean
  Read access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
- write_event_bookingboolean
  Write access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
- read_event_booking_groupboolean
  Read access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
- write_event_booking_groupboolean
  Write access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
- read_maintenanceboolean
  Read access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
- write_maintenanceboolean
  Write access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
- write_event_availabilityboolean
  Write access to event availability. Grants the write permission for the availability scope 'event_availability'.
- write_easboolean
  Write access to the event attendance scanner. Grants the write permission for the scope 'eas'.
- write_wtesboolean
  Write access to the work time entry scanner. Grants the write permission for the scope 'wtes'.
- write_statsboolean
  Write access to statistics. Grants the write permission for the statistics scope 'stats'.
- read_shortlinkboolean
  Read access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
- write_shortlinkboolean
  Write access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
- read_mediaboolean
  Read access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
- write_mediaboolean
  Write access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
- read_settingsboolean
  Read access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
- write_settingsboolean
  Write access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
- read_dwiboolean
  Read access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
- write_dwiboolean
  Write access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
- read_fltboolean
  Read access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
- write_fltboolean
  Write access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
- read_c1boolean
  Read access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
- write_c1boolean
  Write access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
- read_chboolean
  Read access to change history. Grants the read permission for the scope 'ch'.
- read_siboolean
  Read access to short information. Grants the read permission for the scope 'si'.
- read_ptboolean
  Read access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
- write_ptboolean
  Write access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
- read_locboolean
  Read access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
- write_locboolean
  Write access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
- read_notifyboolean
  Read access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
- write_notifyboolean
  Write access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
- read_chatboolean
  Read access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
- write_chatboolean
  Write access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
- write_webhookboolean
  Write access to webhooks. Grants the write permission for the scope 'webhook'.
- … 6 more fields

Responses

200Update a single UserAccessGroupUserAccessGroup

Show fields (81)

idinteger
Primary key of the user access group. Internal ID, used as the reference by users and access tokens.
namestring
Name of the user access group. Shown to administrators when they assign users to a group.
super_adminboolean
Super admin flag of the group. Members of a super admin group have all rights, including the administration of other admin groups.
adminboolean
Admin flag of the group. Members of an admin group can manage users and access rights.
userboolean
User flag of the group. Standard flag for regular members.
guestboolean
Guest flag of the group. Guests get only the rights explicitly granted to them.
read_installationsboolean
Read access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
write_installationsboolean
Write access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
read_userboolean
Read access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
write_userboolean
Write access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
read_customerprofileboolean
Read access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
write_customerprofileboolean
Write access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
read_crmboolean
Read access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
write_crmboolean
Write access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
read_crm_projectboolean
Read access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
write_crm_projectboolean
Write access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
read_billingboolean
Read access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
write_billingboolean
Write access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
read_taxaccountingboolean
Read access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
write_taxaccountingboolean
Write access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
read_donationsboolean
Read access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
write_donationsboolean
Write access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
read_productsboolean
Read access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
write_productsboolean
Write access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
read_ticketboolean
Read access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_ticketboolean
Write access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_own_ticketboolean
Write access to own tickets only. Users can only change tickets assigned to them.
read_timeboolean
Read access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
write_timeboolean
Write access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
read_trainer_timeboolean
Read access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
write_trainer_timeboolean
Write access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
read_studio_trainingboolean
Read access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
write_studio_trainingboolean
Write access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
read_callboolean
Read access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
write_callboolean
Write access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
read_hrboolean
Read access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
write_hrboolean
Write access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
read_srvboolean
Read access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
write_srvboolean
Write access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
read_domainboolean
Read access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
write_domainboolean
Write access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
read_softwareboolean
Read access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
write_softwareboolean
Write access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
read_privacyboolean
Read access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
write_privacyboolean
Write access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
read_eventboolean
Read access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
write_eventboolean
Write access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
read_event_bookingboolean
Read access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
write_event_bookingboolean
Write access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
read_event_booking_groupboolean
Read access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
write_event_booking_groupboolean
Write access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
read_maintenanceboolean
Read access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_maintenanceboolean
Write access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_event_availabilityboolean
Write access to event availability. Grants the write permission for the availability scope 'event_availability'.
write_easboolean
Write access to the event attendance scanner. Grants the write permission for the scope 'eas'.
write_wtesboolean
Write access to the work time entry scanner. Grants the write permission for the scope 'wtes'.
write_statsboolean
Write access to statistics. Grants the write permission for the statistics scope 'stats'.
read_shortlinkboolean
Read access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
write_shortlinkboolean
Write access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
read_mediaboolean
Read access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
write_mediaboolean
Write access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
read_settingsboolean
Read access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
write_settingsboolean
Write access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
read_dwiboolean
Read access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
write_dwiboolean
Write access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
read_fltboolean
Read access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
write_fltboolean
Write access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
read_c1boolean
Read access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
write_c1boolean
Write access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
read_chboolean
Read access to change history. Grants the read permission for the scope 'ch'.
read_siboolean
Read access to short information. Grants the read permission for the scope 'si'.
read_ptboolean
Read access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
write_ptboolean
Write access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
read_locboolean
Read access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
write_locboolean
Write access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
read_notifyboolean
Read access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
write_notifyboolean
Write access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
read_chatboolean
Read access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_chatboolean
Write access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_webhookboolean
Write access to webhooks. Grants the write permission for the scope 'webhook'.
… 6 more fields

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/user_access_group/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "super_admin": true,
    "admin": true,
    "user": true,
    "guest": true
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      name: 'Beispiel',
      super_admin: true,
      admin: true,
      user: true,
      guest: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/user_access_group/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/user_access_group/42"

payload = { "data": {
    "id": 42,
    "name": "Beispiel",
    "super_admin": True,
    "admin": True,
    "user": True,
    "guest": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/user_access_group/42', [
  'body' => '{"data":{"id":42,"name":"Beispiel","super_admin":true,"admin":true,"user":true,"guest":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/user_access_group/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"super_admin\":true,\"admin\":true,\"user\":true,\"guest\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"super_admin\":true,\"admin\":true,\"user\":true,\"guest\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/user_access_group/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/user_access_group/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"super_admin\":true,\"admin\":true,\"user\":true,\"guest\":true}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/user_access_group_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/user_access_group.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await UserAccessGroupController.put(UserAccessGroup.fromJson({
  "id": 42,
  "name": "Beispiel",
  "super_admin": true,
  "admin": true,
  "user": true,
  "guest": true
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "super_admin": true,
  "admin": true,
  "user": true,
  "guest": true,
  "read_installations": true,
  "write_installations": true,
  "read_user": true,
  "write_user": true
}

Update a single UserAccessGroup

PATCH/api/user_access_group/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataUserAccessGroup
Show fields (81)
- idinteger
  Primary key of the user access group. Internal ID, used as the reference by users and access tokens.
- namestring
  Name of the user access group. Shown to administrators when they assign users to a group.
- super_adminboolean
  Super admin flag of the group. Members of a super admin group have all rights, including the administration of other admin groups.
- adminboolean
  Admin flag of the group. Members of an admin group can manage users and access rights.
- userboolean
  User flag of the group. Standard flag for regular members.
- guestboolean
  Guest flag of the group. Guests get only the rights explicitly granted to them.
- read_installationsboolean
  Read access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
- write_installationsboolean
  Write access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
- read_userboolean
  Read access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
- write_userboolean
  Write access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
- read_customerprofileboolean
  Read access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
- write_customerprofileboolean
  Write access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
- read_crmboolean
  Read access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
- write_crmboolean
  Write access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
- read_crm_projectboolean
  Read access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
- write_crm_projectboolean
  Write access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
- read_billingboolean
  Read access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
- write_billingboolean
  Write access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
- read_taxaccountingboolean
  Read access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
- write_taxaccountingboolean
  Write access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
- read_donationsboolean
  Read access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
- write_donationsboolean
  Write access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
- read_productsboolean
  Read access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
- write_productsboolean
  Write access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
- read_ticketboolean
  Read access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
- write_ticketboolean
  Write access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
- write_own_ticketboolean
  Write access to own tickets only. Users can only change tickets assigned to them.
- read_timeboolean
  Read access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
- write_timeboolean
  Write access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
- read_trainer_timeboolean
  Read access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
- write_trainer_timeboolean
  Write access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
- read_studio_trainingboolean
  Read access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
- write_studio_trainingboolean
  Write access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
- read_callboolean
  Read access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
- write_callboolean
  Write access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
- read_hrboolean
  Read access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
- write_hrboolean
  Write access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
- read_srvboolean
  Read access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
- write_srvboolean
  Write access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
- read_domainboolean
  Read access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
- write_domainboolean
  Write access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
- read_softwareboolean
  Read access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
- write_softwareboolean
  Write access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
- read_privacyboolean
  Read access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
- write_privacyboolean
  Write access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
- read_eventboolean
  Read access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
- write_eventboolean
  Write access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
- read_event_bookingboolean
  Read access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
- write_event_bookingboolean
  Write access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
- read_event_booking_groupboolean
  Read access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
- write_event_booking_groupboolean
  Write access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
- read_maintenanceboolean
  Read access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
- write_maintenanceboolean
  Write access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
- write_event_availabilityboolean
  Write access to event availability. Grants the write permission for the availability scope 'event_availability'.
- write_easboolean
  Write access to the event attendance scanner. Grants the write permission for the scope 'eas'.
- write_wtesboolean
  Write access to the work time entry scanner. Grants the write permission for the scope 'wtes'.
- write_statsboolean
  Write access to statistics. Grants the write permission for the statistics scope 'stats'.
- read_shortlinkboolean
  Read access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
- write_shortlinkboolean
  Write access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
- read_mediaboolean
  Read access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
- write_mediaboolean
  Write access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
- read_settingsboolean
  Read access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
- write_settingsboolean
  Write access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
- read_dwiboolean
  Read access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
- write_dwiboolean
  Write access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
- read_fltboolean
  Read access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
- write_fltboolean
  Write access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
- read_c1boolean
  Read access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
- write_c1boolean
  Write access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
- read_chboolean
  Read access to change history. Grants the read permission for the scope 'ch'.
- read_siboolean
  Read access to short information. Grants the read permission for the scope 'si'.
- read_ptboolean
  Read access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
- write_ptboolean
  Write access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
- read_locboolean
  Read access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
- write_locboolean
  Write access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
- read_notifyboolean
  Read access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
- write_notifyboolean
  Write access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
- read_chatboolean
  Read access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
- write_chatboolean
  Write access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
- write_webhookboolean
  Write access to webhooks. Grants the write permission for the scope 'webhook'.
- … 6 more fields

Responses

200Update a single UserAccessGroupUserAccessGroup

Show fields (81)

idinteger
Primary key of the user access group. Internal ID, used as the reference by users and access tokens.
namestring
Name of the user access group. Shown to administrators when they assign users to a group.
super_adminboolean
Super admin flag of the group. Members of a super admin group have all rights, including the administration of other admin groups.
adminboolean
Admin flag of the group. Members of an admin group can manage users and access rights.
userboolean
User flag of the group. Standard flag for regular members.
guestboolean
Guest flag of the group. Guests get only the rights explicitly granted to them.
read_installationsboolean
Read access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
write_installationsboolean
Write access to installations (servers, installation settings). Grants the matching permission for the scope 'installations' in the access rights check of the API.
read_userboolean
Read access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
write_userboolean
Write access to users and user access groups. Grants the matching permission for the scope 'user' in the access rights check of the API.
read_customerprofileboolean
Read access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
write_customerprofileboolean
Write access to customer profiles (customer app data). Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.
read_crmboolean
Read access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
write_crmboolean
Write access to CRM (persons, companies, memberships). Grants the matching permission for the scope 'crm' in the access rights check of the API.
read_crm_projectboolean
Read access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
write_crm_projectboolean
Write access to CRM projects. Grants the matching permission for the scope 'crm_project' in the access rights check of the API.
read_billingboolean
Read access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
write_billingboolean
Write access to billing (invoices, payments, direct debit). Grants the matching permission for the scope 'billing' in the access rights check of the API.
read_taxaccountingboolean
Read access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
write_taxaccountingboolean
Write access to tax accounting (EUER and balance sheet). Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.
read_donationsboolean
Read access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
write_donationsboolean
Write access to donations. Grants the matching permission for the scope 'donations' in the access rights check of the API.
read_productsboolean
Read access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
write_productsboolean
Write access to products. Grants the matching permission for the scope 'products' in the access rights check of the API.
read_ticketboolean
Read access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_ticketboolean
Write access to tickets. Grants the matching permission for the scope 'ticket' in the access rights check of the API.
write_own_ticketboolean
Write access to own tickets only. Users can only change tickets assigned to them.
read_timeboolean
Read access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
write_timeboolean
Write access to time tracking. Grants the matching permission for the scope 'time' in the access rights check of the API.
read_trainer_timeboolean
Read access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
write_trainer_timeboolean
Write access to trainer time tracking. Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.
read_studio_trainingboolean
Read access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
write_studio_trainingboolean
Write access to studio training. Grants the matching permission for the scope 'studio_training' in the access rights check of the API.
read_callboolean
Read access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
write_callboolean
Write access to calls. Grants the matching permission for the scope 'call' in the access rights check of the API.
read_hrboolean
Read access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
write_hrboolean
Write access to HR. Grants the matching permission for the scope 'hr' in the access rights check of the API.
read_srvboolean
Read access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
write_srvboolean
Write access to servers and containers. Grants the matching permission for the scope 'srv' in the access rights check of the API.
read_domainboolean
Read access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
write_domainboolean
Write access to domains. Grants the matching permission for the scope 'domain' in the access rights check of the API.
read_softwareboolean
Read access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
write_softwareboolean
Write access to software and licenses. Grants the matching permission for the scope 'software' in the access rights check of the API.
read_privacyboolean
Read access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
write_privacyboolean
Write access to privacy and data protection. Grants the matching permission for the scope 'privacy' in the access rights check of the API.
read_eventboolean
Read access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
write_eventboolean
Write access to events. Grants the matching permission for the scope 'event' in the access rights check of the API.
read_event_bookingboolean
Read access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
write_event_bookingboolean
Write access to event bookings. Grants the matching permission for the scope 'event_booking' in the access rights check of the API.
read_event_booking_groupboolean
Read access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
write_event_booking_groupboolean
Write access to event booking groups. Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.
read_maintenanceboolean
Read access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_maintenanceboolean
Write access to maintenance. Grants the matching permission for the scope 'maintenance' in the access rights check of the API.
write_event_availabilityboolean
Write access to event availability. Grants the write permission for the availability scope 'event_availability'.
write_easboolean
Write access to the event attendance scanner. Grants the write permission for the scope 'eas'.
write_wtesboolean
Write access to the work time entry scanner. Grants the write permission for the scope 'wtes'.
write_statsboolean
Write access to statistics. Grants the write permission for the statistics scope 'stats'.
read_shortlinkboolean
Read access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
write_shortlinkboolean
Write access to short links. Grants the matching permission for the scope 'shortlink' in the access rights check of the API.
read_mediaboolean
Read access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
write_mediaboolean
Write access to media. Grants the matching permission for the scope 'media' in the access rights check of the API.
read_settingsboolean
Read access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
write_settingsboolean
Write access to settings. Grants the matching permission for the scope 'settings' in the access rights check of the API.
read_dwiboolean
Read access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
write_dwiboolean
Write access to data warehouse import (DWI). Grants the matching permission for the scope 'dwi' in the access rights check of the API.
read_fltboolean
Read access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
write_fltboolean
Write access to flexible LaTeX templates. Grants the matching permission for the scope 'flt' in the access rights check of the API.
read_c1boolean
Read access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
write_c1boolean
Write access to custom area 1. Grants the matching permission for the scope 'c1' in the access rights check of the API.
read_chboolean
Read access to change history. Grants the read permission for the scope 'ch'.
read_siboolean
Read access to short information. Grants the read permission for the scope 'si'.
read_ptboolean
Read access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
write_ptboolean
Write access to payment transactions. Grants the matching permission for the scope 'pt' in the access rights check of the API.
read_locboolean
Read access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
write_locboolean
Write access to locations. Grants the matching permission for the scope 'loc' in the access rights check of the API.
read_notifyboolean
Read access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
write_notifyboolean
Write access to notifications. Grants the matching permission for the scope 'notify' in the access rights check of the API.
read_chatboolean
Read access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_chatboolean
Write access to chat. Grants the matching permission for the scope 'chat' in the access rights check of the API.
write_webhookboolean
Write access to webhooks. Grants the write permission for the scope 'webhook'.
… 6 more fields

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/user_access_group/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "super_admin": true,
    "admin": true,
    "user": true,
    "guest": true
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      name: 'Beispiel',
      super_admin: true,
      admin: true,
      user: true,
      guest: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/user_access_group/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/user_access_group/42"

payload = { "data": {
    "id": 42,
    "name": "Beispiel",
    "super_admin": True,
    "admin": True,
    "user": True,
    "guest": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/user_access_group/42', [
  'body' => '{"data":{"id":42,"name":"Beispiel","super_admin":true,"admin":true,"user":true,"guest":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/user_access_group/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"super_admin\":true,\"admin\":true,\"user\":true,\"guest\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"super_admin\":true,\"admin\":true,\"user\":true,\"guest\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/user_access_group/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/user_access_group/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"name\":\"Beispiel\",\"super_admin\":true,\"admin\":true,\"user\":true,\"guest\":true}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/user_access_group/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "id": 42,
      "name": "Beispiel",
      "super_admin": true,
      "admin": true,
      "user": true,
      "guest": true
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "super_admin": true,
  "admin": true,
  "user": true,
  "guest": true,
  "read_installations": true,
  "write_installations": true,
  "read_user": true,
  "write_user": true
}