Menü der Dokumentation

Konfigurieren von Benutzerrechten für die Cloud

Mit dem HTTP-REST-Endpunkt user von dmsdocs.exe können Sie bestehende Benutzer anzeigen, die dem d.3-Server bekannt sind. Sie können diesen Benutzern Export- und Migrationsberechtigungen erteilen. Dieser HTTP-Endpunkt ist ausschließlich von Benutzern mit administrativen Rechten aufrufbar.

Sie können Benutzerlisten über Query-Parameter einschränken. Darüber hinaus können Sie einzelne Benutzer anzeigen und bearbeiten.

Aufbau eines einzelnen User-Objekts

Hauptroute:

https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user

Link zum einzelnen User-Objekt:

{
  "_links": {
     "self": {
         "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user1",
         "templated": false
         }
   },

d.3-ID des Benutzers:

"d3Id": "user1",

IDP-ID des Benutzers:

"idpId": "7B841E93-EC4E-4790-B9D7-AD7F5DFCC82B"

Legen Sie fest, ob der Benutzer über Exportberechtigungen verfügen soll:

"hasExportRight": true,

Legen Sie fest, ob der Benutzer über Migrationsberechtigungen verfügen soll:

"hasMigrationRight": true,

}

Wenn Sie eine Benutzerberechtigung verändern, rufen Sie den self-Link des Benutzer-Objekts per PUT auf. Schicken Sie die erhaltenen Informationen zum Benutzer als JSON-Body im Request mit.

GET-Requests und Query-Parameter

Ziel: Alle Benutzer abfragen

Request/Subroute: GET https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user

Beispielantwort des Endpunkts:

{
    "user": [
        {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user1",
                    "templated": false
                }
            },
            "d3Id": "user1",
            "hasExportRight": true,
            "hasMigrationRight": true,
            "idpId": "7B841E93-EC4E-4790-B9D7-AD7F5DFCC82B"
        },
        {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user2",
                    "templated": false
                }
            },
            "d3Id": "user2",
            "hasExportRight": false,
            "hasMigrationRight": false,
            "idpId": ""
        },
        {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user3",
                    "templated": false
                }
            },
            "d3Id": "user3",
            "hasExportRight": false,
            "hasMigrationRight": false,
            "idpId": ""
        }
    ]

}

Ziel: Benutzer mit Migrationsberechtigungen anzeigen

Request/Subroute: GET https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user?hasMigrationRight

Beispielantwort des Endpunkts:

{
  "user": [
    {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user1",
                    "templated": false
                }
            },
            "d3Id": "user1",
            "hasExportRight": true,
            "hasMigrationRight": true,
            "idpId": "7B841E93-EC4E-4790-B9D7-AD7F5DFCC82B"
    }
  ]
}

Ziel: Benutzer ohne Migrationsberechtigungen anzeigen

Request/Subroute: GET https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user?hasMigrationRight=false

Beispielantwort des Endpunkts:

{
  "user": [
    {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user2",
                    "templated": false
                }
            },
            "d3Id": "user2",
            "hasExportRight": false,
            "hasMigrationRight": false,
            "idpId": ""
        },
        {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user3",
                    "templated": false
                }
            },
            "d3Id": "user3",
            "hasExportRight": false,
            "hasMigrationRight": false,
            "idpId": ""
        }
  ]
}

Ziel: Benutzer mit Exportberechtigungen anzeigen

Request/Subroute: GET https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user?hasExportRight

Beispielantwort des Endpunkts:

{
  "user": [
    {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user1",
                    "templated": false
                }
            },
            "d3Id": "user1",
            "hasExportRight": true,
            "hasMigrationRight": true,
            "idpId": "7B841E93-EC4E-4790-B9D7-AD7F5DFCC82B"
    }
  ]
}

Ziel: Benutzer ohne Exportberechtigungen anzeigen

Request/Subroute: GET https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user?hasExportRight=false

Beispielantwort des Endpunkts:

{
  "user": [
    {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user2",
                    "templated": false
                }
            },
            "d3Id": "user2",
            "hasExportRight": false,
            "hasMigrationRight": false,
            "idpId": ""
        },
        {
            "_links": {
                "self": {
                    "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user3",
                    "templated": false
                }
            },
            "d3Id": "user3",
            "hasExportRight": false,
            "hasMigrationRight": false,
            "idpId": ""
        }
  ]
}

Ziel: Benutzer mit IDP-IDs anzeigen

Request/Subroute: GET https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user?hasIdpId

Beispielantwort des Endpunkts:

{
  "user": [
    {
      "_links": {
        "self": {
          "href": "https://<tenant>.d-velop.cloud/dmsdocs/r/<repoId>/user/d3Id/user1",
          "templated": false
        }
      },
      "d3Id": "user1",
      "hasExportRight": false,
      "hasMigrationRight": true,
      "idpId": "7B841E93-EC4E-4790-B9D7-AD7F5DFCC82B"
    },
    {
      "_links": {
        "self": {
          "href": "https://<tenant>.d-velop.cloud/dmsdocs/r/<repoId>/user/d3Id/user2",
          "templated": false
        }
      },
      "d3Id": "user2",
      "hasExportRight": false,
      "hasMigrationRight": false,
      "idpId": "61C15487-3A24-4FC0-B105-F3141114168D"
    },
    .....
  ]
}

Ziel: Benutzer ohne IDP-IDs anzeigen

Request/Subroute: GET https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user?hasIdpId=false

Beispielantwort des Endpunkts:

{
  "user": [
    {
      "_links": {
        "self": {
          "href": "https://<tenant>.d-velop.cloud/dmsdocs/r/<repoId>/user/d3Id/user1",
          "templated": false
        }
      },
      "d3Id": "d3_wfl",
      "hasMigrationRight": false,
      "idpId": ""
    },
    {
      "_links": {
        "self": {
          "href": "https://<tenant>.d-velop.cloud/dmsdocs/r/<repoId>/user/d3Id/user1",
          "templated": false
        }
      },
      "d3Id": "jhor",
      "hasMigrationRight": false,
      "idpId": ""
    },
    .....
  ]
}

Ziel: Individuellen Benutzer abfragen

Request/Subroute: GET https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user/d3Id/user1

Beispielantwort des Endpunkts:

{
  "_links": {
    "self": {
      "href": "https://<tenant>.d-velop.cloud/dmsdocs/r/<repoId>/user/d3Id/user1",
      "templated": false
    }
  },
  "d3Id": "user1",
  "hasExportRight": false,  
  "hasMigrationRight": true,
  "idpId": "7B841E93-EC4E-4790-B9D7-AD7F5DFCC82B"
}
PUT-Requests

Ziel: Migrationsberechtigungen erteilen bzw. entziehen

Anfrage/Subroute: PUT https://<Mandant>.d-velop.cloud/dmsdocs/r/<Repository-ID>/user/d3Id/<d3Id>

JSON-Body für Anfrage:

{ 
 "d3Id": "user1",
 "hasExportRight": true,
 "hasMigrationRight": false,
 "idpId": "7B841E93-EC4E-4790-B9D7-AD7F5DFCC82B"

}

Beispielantwort des Endpunkts:

{
  "_links": {
     "self": {
       "href": "https://<baseUrl>/dmsdocs/r/<repoUuid>/user/d3Id/user1",
       "templated": false
     }
  },
  "d3Id": "user1",
  "hasExportRight": true,
  "hasMigrationRight": false,
  "idpId": "7B841E93-EC4E-4790-B9D7-AD7F5DFCC82B"
}

/dmsdocs