Open Documentation Menu

Configuring user rights for the cloud

You can use the HTTP REST endpoint user from dmsdocs.exe to display existing users that are known to the d.3 server. You can grant export and migration permissions to these users. This HTTP endpoint can be called only by users with administrative rights.

You can restrict user lists using query parameters. You can also display and edit individual users.

Structure of an individual user object

Main route:

https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user

Link to the individual user object:

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

d.3 ID of the user:

"d3Id": "user1",

IDP ID of the user:

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

Define whether you want the user to have export permissions:

"hasExportRight": true,

Define whether you want the user to have migration permissions:

"hasMigrationRight": true,

}

When you change a user permission, call the self link of the user object using a PUT request. Send the received information to the user as the JSON body in the request as well.

GET requests and query parameters

Objective: Querying all users

Request/subroute: GET https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user

Sample end point response:

{
    "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": ""
        }
    ]

}

Objective: Displaying users with migration permissions

Request/subroute: GET https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user?hasMigrationRight

Sample end point response:

{
  "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"
    }
  ]
}

Objective: Displaying users without migration permissions

Request/subroute: GET https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user?hasMigrationRight=false

Sample end point response:

{
  "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": ""
        }
  ]
}

Objective: Displaying users with export permissions

Request/subroute: GET https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user?hasExportRight

Sample end point response:

{
  "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"
    }
  ]
}

Objective: Displaying users without export permissions

Request/subroute: GET https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user?hasExportRight=false

Sample end point response:

{
  "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": ""
        }
  ]
}

Objective: Displaying users with IDP IDs

Request/subroute: GET https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user?hasIdpId

Sample end point response:

{
  "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"
    },
    .....
  ]
}

Objective: Displaying users without IDP IDs

Request/subroute: GET https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user?hasIdpId=false

Sample end point response:

{
  "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": ""
    },
    .....
  ]
}

Objective: Querying individual users

Request/subroute: GET https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user/d3Id/user1

Sample end point response:

{
  "_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

Objective: Granting and revoking migration permissions

Request/subroute: PUT https://<tenant>.d-velop.cloud/dmsdocs/r/<repository ID>/user/d3Id/<d3Id>

JSON body for request:

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

}

Sample end point response:

{
  "_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