Zum Inhalt springen
Developer

Server Client Permission

oAuth / Server Client-Berechtigung

Login und Sitzung4 EndpunkteoAuth / Server Client Permission

Einzelne OauthServerClientPermission abrufen

GET/api/opendata/oauth/server_clients_permission/{clientIdentifier}

Pfad-Parameter

clientIdentifierPflichtstring

Antworten

200Einzelne OauthServerClientPermission abrufenOauthServerClientPermission

Felder anzeigen (6)
  • idinteger

    Primärschlüssel der Client-Berechtigung. Interne ID.

  • scopesstring

    Kommagetrennte Liste der gewährten Scopes.

  • activeboolean

    Ob die Berechtigung aktiv ist.

  • is_dgboolean

    Ob die Berechtigung für den Kontext der DG (Mitgliedsorganisation) gilt.

  • selected_customerCustomerProfile

    Kundenprofil, auf das die Berechtigung beschränkt ist.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kundenprofils. Interne ID.

    • slackchannelstring

      Slack-Kanal des Kundenprofils.

    • displaynamestring

      Anzeigename des Kundenprofils.

    • deletedboolean

      Ob das Kundenprofil gelöscht ist.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • namestring

    Name der Einheit.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/opendata/oauth/server_clients_permission/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "scopes": "string",
  "active": true,
  "is_dg": true,
  "selected_customer": {
    "id": 42,
    "slackchannel": "string",
    "displayname": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
}

Erstellt eine einzelne OauthServerClientPermission

POST/api/opendata/oauth/server_clients_permission/{clientIdentifier}

Pfad-Parameter

clientIdentifierPflichtstring

Request-Body application/json

  • dataOauthServerClientPermission2
    Felder anzeigen (2)
    • scopesstring

      Kommagetrennte Liste der gewährten Scopes.

    • activeboolean

      Ob die Berechtigung aktiv ist.

Antworten

200Erstellt eine einzelne OauthServerClientPermissionOauthServerClientPermission

Felder anzeigen (6)
  • idinteger

    Primärschlüssel der Client-Berechtigung. Interne ID.

  • scopesstring

    Kommagetrennte Liste der gewährten Scopes.

  • activeboolean

    Ob die Berechtigung aktiv ist.

  • is_dgboolean

    Ob die Berechtigung für den Kontext der DG (Mitgliedsorganisation) gilt.

  • selected_customerCustomerProfile

    Kundenprofil, auf das die Berechtigung beschränkt ist.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kundenprofils. Interne ID.

    • slackchannelstring

      Slack-Kanal des Kundenprofils.

    • displaynamestring

      Anzeigename des Kundenprofils.

    • deletedboolean

      Ob das Kundenprofil gelöscht ist.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • namestring

    Name der Einheit.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/opendata/oauth/server_clients_permission/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "scopes": "string",
    "active": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "scopes": "string",
  "active": true,
  "is_dg": true,
  "selected_customer": {
    "id": 42,
    "slackchannel": "string",
    "displayname": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
}

Aktualisiert eine einzelne OauthServerClientPermission

PUT/api/opendata/oauth/server_clients_permission/{clientIdentifier}

Pfad-Parameter

clientIdentifierPflichtstring

Request-Body application/json

  • dataOauthServerClientPermission2
    Felder anzeigen (2)
    • scopesstring

      Kommagetrennte Liste der gewährten Scopes.

    • activeboolean

      Ob die Berechtigung aktiv ist.

Antworten

200Aktualisiert eine einzelne OauthServerClientPermissionOauthServerClientPermission

Felder anzeigen (6)
  • idinteger

    Primärschlüssel der Client-Berechtigung. Interne ID.

  • scopesstring

    Kommagetrennte Liste der gewährten Scopes.

  • activeboolean

    Ob die Berechtigung aktiv ist.

  • is_dgboolean

    Ob die Berechtigung für den Kontext der DG (Mitgliedsorganisation) gilt.

  • selected_customerCustomerProfile

    Kundenprofil, auf das die Berechtigung beschränkt ist.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kundenprofils. Interne ID.

    • slackchannelstring

      Slack-Kanal des Kundenprofils.

    • displaynamestring

      Anzeigename des Kundenprofils.

    • deletedboolean

      Ob das Kundenprofil gelöscht ist.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • namestring

    Name der Einheit.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/opendata/oauth/server_clients_permission/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "scopes": "string",
    "active": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "scopes": "string",
  "active": true,
  "is_dg": true,
  "selected_customer": {
    "id": 42,
    "slackchannel": "string",
    "displayname": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
}

Aktualisiert eine einzelne OauthServerClientPermission

PATCH/api/opendata/oauth/server_clients_permission/{clientIdentifier}

Pfad-Parameter

clientIdentifierPflichtstring

Request-Body application/json

  • dataOauthServerClientPermission2
    Felder anzeigen (2)
    • scopesstring

      Kommagetrennte Liste der gewährten Scopes.

    • activeboolean

      Ob die Berechtigung aktiv ist.

Antworten

200Aktualisiert eine einzelne OauthServerClientPermissionOauthServerClientPermission

Felder anzeigen (6)
  • idinteger

    Primärschlüssel der Client-Berechtigung. Interne ID.

  • scopesstring

    Kommagetrennte Liste der gewährten Scopes.

  • activeboolean

    Ob die Berechtigung aktiv ist.

  • is_dgboolean

    Ob die Berechtigung für den Kontext der DG (Mitgliedsorganisation) gilt.

  • selected_customerCustomerProfile

    Kundenprofil, auf das die Berechtigung beschränkt ist.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kundenprofils. Interne ID.

    • slackchannelstring

      Slack-Kanal des Kundenprofils.

    • displaynamestring

      Anzeigename des Kundenprofils.

    • deletedboolean

      Ob das Kundenprofil gelöscht ist.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • namestring

    Name der Einheit.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/opendata/oauth/server_clients_permission/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "scopes": "string",
    "active": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "scopes": "string",
  "active": true,
  "is_dg": true,
  "selected_customer": {
    "id": 42,
    "slackchannel": "string",
    "displayname": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
}