/r/{repoId}/permissions/assignments

GET
https://sample-api.d-velop.cloud
Retrieving a list of subjects and their permissions
In the response, you receive a mapping all mappings of permissions to the groups and applications.
Parameters
repoId/string/required
The unique ID of the repository.
Responses
200
The permissions were determined successfully.
Content
Media type: application/json
{
  "subjects": {
    "type": "array",
    "items": {
      "required": [
        "id"
      ],
      "type": "object",
      "properties": {
        "assignments": {
          "type": "array",
          "items": {
            "required": [
              "permissionId"
            ],
            "type": "object",
            "properties": {
              "delete": {
                "type": "string",
                "description": "Authorizes the group members or applications to delete objects.",
                "default": "INHERITED",
                "nullable": true,
                "example": "ALLOWED | INHERITED | DENIED"
              },
              "permissionId": {
                "minLength": 1,
                "type": "string",
                "description": "The unique ID of the permission.",
                "example": "00000000-0000-0000-0000-000000000000"
              },
              "read": {
                "type": "string",
                "description": "Authorizes the group members or applications to read objects.",
                "default": "INHERITED",
                "nullable": true,
                "example": "ALLOWED | INHERITED | DENIED"
              },
              "write": {
                "type": "string",
                "description": "Authorizes the group members or applications to edit or create objects.",
                "default": "INHERITED",
                "nullable": true,
                "example": "ALLOWED | INHERITED | DENIED"
              }
            },
            "additionalProperties": false,
            "description": "An assignment describes a group or application that contains permissions and their corresponding rights.\r\n            \r\nYou can use this restriction levels:\r\n- ALLOWED: Right is explicitly granted.\r\n- INHERITED: Right is not granted. If several permissions for the group or application pertain to an object, the others will apply. Otherwise as DENIED\r\n- DENIED: Right is explicitly denied. If several permissions for the group or application pertain to an object, DENIED will always apply.\r\nIf the property read contains the value DENIED, the properties write and delete also need to contain the value DENIED.\r\nIf the properties write or delete contain the value ALLOWED, the property read also needs to contain the value ALLOWED."
          },
          "description": "The permissions that this group or application has received.",
          "nullable": true
        },
        "id": {
          "minLength": 1,
          "type": "string",
          "description": "The unique ID of the group or application.",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "type": {
          "type": "string",
          "description": "The type of the object that is being assigned.",
          "default": "GROUP",
          "nullable": true,
          "example": "GROUP | APP"
        }
      },
      "additionalProperties": false,
      "description": "Subject with its assigned permissions."
    },
    "nullable": true
  }
}
Media type: application/hal+json
{
  "subjects": {
    "type": "array",
    "items": {
      "required": [
        "id"
      ],
      "type": "object",
      "properties": {
        "assignments": {
          "type": "array",
          "items": {
            "required": [
              "permissionId"
            ],
            "type": "object",
            "properties": {
              "delete": {
                "type": "string",
                "description": "Authorizes the group members or applications to delete objects.",
                "default": "INHERITED",
                "nullable": true,
                "example": "ALLOWED | INHERITED | DENIED"
              },
              "permissionId": {
                "minLength": 1,
                "type": "string",
                "description": "The unique ID of the permission.",
                "example": "00000000-0000-0000-0000-000000000000"
              },
              "read": {
                "type": "string",
                "description": "Authorizes the group members or applications to read objects.",
                "default": "INHERITED",
                "nullable": true,
                "example": "ALLOWED | INHERITED | DENIED"
              },
              "write": {
                "type": "string",
                "description": "Authorizes the group members or applications to edit or create objects.",
                "default": "INHERITED",
                "nullable": true,
                "example": "ALLOWED | INHERITED | DENIED"
              }
            },
            "additionalProperties": false,
            "description": "An assignment describes a group or application that contains permissions and their corresponding rights.\r\n            \r\nYou can use this restriction levels:\r\n- ALLOWED: Right is explicitly granted.\r\n- INHERITED: Right is not granted. If several permissions for the group or application pertain to an object, the others will apply. Otherwise as DENIED\r\n- DENIED: Right is explicitly denied. If several permissions for the group or application pertain to an object, DENIED will always apply.\r\nIf the property read contains the value DENIED, the properties write and delete also need to contain the value DENIED.\r\nIf the properties write or delete contain the value ALLOWED, the property read also needs to contain the value ALLOWED."
          },
          "description": "The permissions that this group or application has received.",
          "nullable": true
        },
        "id": {
          "minLength": 1,
          "type": "string",
          "description": "The unique ID of the group or application.",
          "example": "00000000-0000-0000-0000-000000000000"
        },
        "type": {
          "type": "string",
          "description": "The type of the object that is being assigned.",
          "default": "GROUP",
          "nullable": true,
          "example": "GROUP | APP"
        }
      },
      "additionalProperties": false,
      "description": "Subject with its assigned permissions."
    },
    "nullable": true
  }
}
Show operation

Language

const options = {method: 'GET', headers: {accept: 'application/json'}};

fetch('https://example.com/dmsconfig/r/REPOID/permissions/assignments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));