{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/mend/main/json-schema/mend-dwrresponse-pageable-list-group-summary-dto-schema.json", "title": "DWRResponsePageableListGroupSummaryDTO", "description": "Provides insights into endpoint-supported pagination information", "x-generated": "2026-10-04", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/mend-user-management-groups-api-openapi.yml#/components/schemas/DWRResponsePageableListGroupSummaryDTO", "type": "object", "properties": { "additionalData": { "title": "Provides insights into endpoint-supported pagination information.", "type": "object", "description": "+ **totalItems**: The total count of data points returned in an API response.\n+ **isLastPage**: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining." }, "supportToken": { "title": "Support Token", "type": "string" }, "retVal": { "type": "array", "items": { "$ref": "#/$defs/GroupSummaryDTO" } } }, "$defs": { "GroupRoleDTO": { "title": "List of Group Roles", "type": "object", "properties": { "contextToken": { "type": "string", "description": "Depending on the value of contextType, this can be:\n+ orgToken (org UUID by running Entities - Organization > Get User Organization) or Api Token (from the Mend SCA App: **Integrate** tab > **API Key**).\n+ productToken (product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: **Integrate** tab > **Product Token**.\n+ projectToken (project UUID by running Entities - Product > Get Product Projects) or project Token (from the Mend SCA App: **Integrate** tab > **Project Token**)." }, "contextName": { "title": "Context Name", "type": "string" }, "contextType": { "type": "string", "description": "Type of entity the role will be associated with", "enum": [ "orgs", "products" ] }, "role": { "type": "string", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] } } }, "GroupSummaryDTO": { "type": "object", "properties": { "uuid": { "title": "Group UUID", "type": "string" }, "name": { "title": "Group Name", "type": "string" }, "description": { "title": "Group Description", "type": "string" }, "users": { "title": "User Count", "type": "integer", "description": "The amount of users in that group", "format": "int32" }, "affectedProducts": { "title": "Affected Products", "type": "integer", "format": "int32" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/GroupRoleDTO" } }, "applicationRoles": { "title": "Application roles grouped by application label", "type": "array", "items": { "$ref": "#/$defs/RolesGroupedByScopeDTO" } }, "applicationRolesCount": { "type": "integer", "format": "int32" }, "orgRoles": { "title": "Organization roles", "type": "array", "items": { "type": "string", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] } } } }, "RolesGroupedByScopeDTO": { "type": "object", "properties": { "label": { "title": "Group label", "type": "string" }, "roles": { "title": "Roles under this label", "type": "array", "items": { "type": "string", "enum": [ "DEFAULT_APPROVER", "ADMIN", "ALERT_EMAIL_RECEIVER", "ALERTS_IGNORER", "LICENSE_AND_COPYRIGHT_ASSIGNER", "AUDITOR", "USER", "PRODUCT_INTEGRATOR", "SBOM_EXPORTER" ] } } } } } }