Mend

Mend User Management - Roles Definitions API

The User Management - Roles Definitions API from Mend — 8 operation(s) for user management - roles definitions.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 14

GET /api/v3.0/orgs/{orgUuid}/roleDefinitions Get Organization Role Definitions #
POST /api/v3.0/orgs/{orgUuid}/roleDefinitions Create Organization Role Definition #
GET /api/v3.0/accounts/{accountUuid}/roleDefinitions Get Account Role Definitions #
POST /api/v3.0/accounts/{accountUuid}/roleDefinitions Create Account Role Definition #
GET /api/v3.0/orgs/{orgUuid}/roleDefinitions/{roleDefinitionUuid} Get Organization Role Definition by UUID #
DELETE /api/v3.0/orgs/{orgUuid}/roleDefinitions/{roleDefinitionUuid} Delete Organization Role Definition #
PATCH /api/v3.0/orgs/{orgUuid}/roleDefinitions/{roleDefinitionUuid} Update Organization Role Definition #
GET /api/v3.0/accounts/{accountUuid}/roleDefinitions/{roleDefinitionUuid} Get Account Role Definition by UUID #
DELETE /api/v3.0/accounts/{accountUuid}/roleDefinitions/{roleDefinitionUuid} Delete Account Role Definition #
PATCH /api/v3.0/accounts/{accountUuid}/roleDefinitions/{roleDefinitionUuid} Update Account Role Definition #
GET /api/v3.0/orgs/{orgUuid}/roleDefinitions/{roleDefinitionUuid}/capabilities Get Organization Role Definition Capabilities #
GET /api/v3.0/orgs/{orgUuid}/roleDefinitions/capabilities Get Assignable Capabilities #
GET /api/v3.0/accounts/{accountUuid}/roleDefinitions/{roleDefinitionUuid}/capabilities Get Account Role Definition Capabilities #
GET /api/v3.0/accounts/{accountUuid}/roleDefinitions/capabilities Get All Assignable Capabilities #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/mend/openapi/mend-user-management-roles-definitions-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mend:mend-user-management-roles-definitions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mend-user-management-roles-definitions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mend User Management - Roles Definitions API
  description: 'Mend''s enhanced SCA API enables automation of workflows in a REST compliant format. The API features:

    + Access for any user with Mend credentials, via a user key available in the user''s profile page in the Mend App.

    + Improved security with a JWT token per organization, which expires every 10 minutes.

    + Added scalability with support for pagination, filtering and sorting search results.

    + Broader functionality available programmatically.

    + New standard API documentation for easy navigation and search.


    **Note:** To help you get started with the Mend SCA API 2.0, we recommend reviewing our onboarding guide -> Getting Started with Mend SCA API 2.0.

    This resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend SCA API 2.0. If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.'
  version: 3.0.1
servers:
- url: https://api-saas.mend.io
  description: Generated server url
security:
- bearer-key: []
tags:
- name: User Management - Roles Definitions
paths:
  /api/v3.0/orgs/{orgUuid}/roleDefinitions:
    get:
      tags:
      - User Management - Roles Definitions
      summary: Get Organization Role Definitions
      description: Returns a list of available role definitions for the given organization
      operationId: getRoleDefinitions
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3ListRoleDefinitionDTOV3'
    post:
      tags:
      - User Management - Roles Definitions
      summary: Create Organization Role Definition
      description: Creates a custom role definition for the given organization
      operationId: createCustomRoleDefinition
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefinitionRequestDTOV3'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3RoleDefinitionDTOV3'
  /api/v3.0/accounts/{accountUuid}/roleDefinitions:
    get:
      tags:
      - User Management - Roles Definitions
      summary: Get Account Role Definitions
      description: Returns a list of available role definitions for the given account
      operationId: getRoleDefinitions_1
      parameters:
      - name: accountUuid
        in: path
        description: Account UUID
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3ListRoleDefinitionDTOV3'
    post:
      tags:
      - User Management - Roles Definitions
      summary: Create Account Role Definition
      description: Creates a custom role definition for the given account
      operationId: createCustomRoleDefinition_1
      parameters:
      - name: accountUuid
        in: path
        description: Account UUID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefinitionRequestDTOV3'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3RoleDefinitionDTOV3'
  /api/v3.0/orgs/{orgUuid}/roleDefinitions/{roleDefinitionUuid}:
    get:
      tags:
      - User Management - Roles Definitions
      summary: Get Organization Role Definition by UUID
      description: Returns the role definition identified by its UUID
      operationId: getRoleDefinition
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: roleDefinitionUuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3RoleDefinitionDTOV3'
    delete:
      tags:
      - User Management - Roles Definitions
      summary: Delete Organization Role Definition
      description: Deletes the role definition for the given organization
      operationId: deleteRoleDefinition
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: roleDefinitionUuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
    patch:
      tags:
      - User Management - Roles Definitions
      summary: Update Organization Role Definition
      description: Updates the role definition for the given organization
      operationId: updateRoleDefinition
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: roleDefinitionUuid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefinitionRequestDTOV3'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
  /api/v3.0/accounts/{accountUuid}/roleDefinitions/{roleDefinitionUuid}:
    get:
      tags:
      - User Management - Roles Definitions
      summary: Get Account Role Definition by UUID
      description: Returns the role definition identified by its UUID
      operationId: getRoleDefinition_1
      parameters:
      - name: accountUuid
        in: path
        description: Account UUID
        required: true
        schema:
          type: string
      - name: roleDefinitionUuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3RoleDefinitionDTOV3'
    delete:
      tags:
      - User Management - Roles Definitions
      summary: Delete Account Role Definition
      description: Deletes the role definition for the given account
      operationId: deleteRoleDefinition_1
      parameters:
      - name: accountUuid
        in: path
        description: Account UUID
        required: true
        schema:
          type: string
      - name: roleDefinitionUuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
    patch:
      tags:
      - User Management - Roles Definitions
      summary: Update Account Role Definition
      description: Updates the role definition for the given account
      operationId: updateRoleDefinition_1
      parameters:
      - name: accountUuid
        in: path
        description: Account UUID
        required: true
        schema:
          type: string
      - name: roleDefinitionUuid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefinitionRequestDTOV3'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
  /api/v3.0/orgs/{orgUuid}/roleDefinitions/{roleDefinitionUuid}/capabilities:
    get:
      tags:
      - User Management - Roles Definitions
      summary: Get Organization Role Definition Capabilities
      description: Returns a list of permissions granted to the given role
      operationId: getRoleDefinitionCapabilities
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: roleDefinitionUuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3RoleDefinitionCapabilitiesDTOV3'
  /api/v3.0/orgs/{orgUuid}/roleDefinitions/capabilities:
    get:
      tags:
      - User Management - Roles Definitions
      summary: Get Assignable Capabilities
      description: This api returns a list of assignable capabilities.
      operationId: getAssignableCapabilities
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3ListRoleCapabilityDTOV3'
  /api/v3.0/accounts/{accountUuid}/roleDefinitions/{roleDefinitionUuid}/capabilities:
    get:
      tags:
      - User Management - Roles Definitions
      summary: Get Account Role Definition Capabilities
      description: Returns a list of capabilities granted to the given role
      operationId: getRoleDefinitionCapabilities_1
      parameters:
      - name: accountUuid
        in: path
        description: Account UUID
        required: true
        schema:
          type: string
      - name: roleDefinitionUuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3RoleDefinitionCapabilitiesDTOV3'
  /api/v3.0/accounts/{accountUuid}/roleDefinitions/capabilities:
    get:
      tags:
      - User Management - Roles Definitions
      summary: Get All Assignable Capabilities
      description: This api returns a list of assignable capabilities.
      operationId: getAssignableCapabilities_1
      parameters:
      - name: accountUuid
        in: path
        description: Account UUID
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3ListRoleCapabilityDTOV3'
components:
  schemas:
    DWRResponseBase:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
    DWRResponseV3RoleDefinitionDTOV3:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/RoleDefinitionDTOV3'
    RoleCapabilityDTOV3:
      type: object
      properties:
        id:
          type: string
          enum:
          - SCANS__UPDATE_PROJECTS
          - SCANS__CREATE_ENTITIES
          - WORKFLOWS__VIEW
          - WORKFLOWS__WRITE
          - WORKFLOWS__DELETE
          - WORKFLOWS__UPDATE_SLA
          - SUPPRESSIONS__REQUEST_CODE
          - SUPPRESSIONS__MANAGE_CODE
          - SUPPRESSIONS__MANAGE_CODE_LOW
          - SUPPRESSIONS__MANAGE_CODE_MEDIUM
          - SUPPRESSIONS__MANAGE_CODE_HIGH
          - SUPPRESSIONS__SUPPRESS_CN
          - SUPPRESSIONS__SUPPRESS_SCA
          - SUPPRESSIONS__SUPPRESS_AI
          - SUPPRESSIONS__SUPPRESS_ALL
          - JIRA_TICKET__SECURITY_CREATE
          - REVIEW_STATUS__UPDATE
          - SEVERITY__UPDATE
          - COMMENT__ADD
          - RED_TEAMING__VIEW
          - RED_TEAMING__RUN_CAMPAIGN
          - RED_TEAMING__MANAGE_TARGETS
          - RED_TEAMING__DELETE_TARGET
          - RED_TEAMING__MANAGE_SETTINGS
          - RED_TEAMING__SUPPRESS_FINDINGS
        name:
          type: string
        category:
          type: string
        subcategory:
          type: string
        implies:
          type: array
          items:
            type: string
            enum:
            - SCANS__UPDATE_PROJECTS
            - SCANS__CREATE_ENTITIES
            - WORKFLOWS__VIEW
            - WORKFLOWS__WRITE
            - WORKFLOWS__DELETE
            - WORKFLOWS__UPDATE_SLA
            - SUPPRESSIONS__REQUEST_CODE
            - SUPPRESSIONS__MANAGE_CODE
            - SUPPRESSIONS__MANAGE_CODE_LOW
            - SUPPRESSIONS__MANAGE_CODE_MEDIUM
            - SUPPRESSIONS__MANAGE_CODE_HIGH
            - SUPPRESSIONS__SUPPRESS_CN
            - SUPPRESSIONS__SUPPRESS_SCA
            - SUPPRESSIONS__SUPPRESS_AI
            - SUPPRESSIONS__SUPPRESS_ALL
            - JIRA_TICKET__SECURITY_CREATE
            - REVIEW_STATUS__UPDATE
            - SEVERITY__UPDATE
            - COMMENT__ADD
            - RED_TEAMING__VIEW
            - RED_TEAMING__RUN_CAMPAIGN
            - RED_TEAMING__MANAGE_TARGETS
            - RED_TEAMING__DELETE_TARGET
            - RED_TEAMING__MANAGE_SETTINGS
            - RED_TEAMING__SUPPRESS_FINDINGS
    MessageDTO:
      type: object
      properties:
        message:
          title: message
          type: string
          example: Success!
    RoleDefinitionDTOV3:
      type: object
      properties:
        uuid:
          type: string
        name:
          type: string
        description:
          type: string
        type:
          type: string
        scopeType:
          type: string
          enum:
          - organization
          - application
          - project
          - account
          - unsupported
        createdBy:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        originalRole:
          type: string
        capabilities:
          type: array
          items:
            type: string
    DWRResponseV3MessageDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/MessageDTO'
    DWRResponseV3ListRoleCapabilityDTOV3:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          type: array
          items:
            $ref: '#/components/schemas/RoleCapabilityDTOV3'
    DWRResponseV3RoleDefinitionCapabilitiesDTOV3:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/RoleDefinitionCapabilitiesDTOV3'
    RoleDefinitionCapabilitiesDTOV3:
      type: object
      properties:
        capabilities:
          type: array
          items:
            type: string
    DWRResponseV3ListRoleDefinitionDTOV3:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          type: array
          items:
            $ref: '#/components/schemas/RoleDefinitionDTOV3'
    RoleDefinitionRequestDTOV3:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        capabilities:
          type: array
          items:
            type: string
  securitySchemes:
    bearer-key:
      type: http
      description: JWT token Bearer
      scheme: bearer
      bearerFormat: JWT