Platform API 3.0
/
Administration - Groups

Mend API (3.0)

Mend's enhanced 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 Platform.
  • Improved security with a JWT token per organization, which expires every 30 minutes.
  • Added scalability with support for cursor pagination and limiting results size.
  • Broader functionality available programmatically.
  • New standard API documentation for easy navigation and search.

If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.

Download OpenAPI description
3.0.json
3.0.yaml
Languages
Servers
Generated server url
https://baseUrl/

Access Management

Operations

Administration - Groups

Operations

Get Group Roles

Request

Returns the list of roles associated with a given group

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running Administration - Groups > Get All Groups of Organization)

Query
cursorString

Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.

limitstring<= 10000

Specifies the maximum number of items to be returned in the response.

Default "50"
No request payload

Responses

OK

Bodyapplication/json
additionalDataobject(Provides insights into endpoint-supported pagination information.)
  • totalItems: The total count of data points returned in an API response.
Example: {"totalItems":"422","next":"http://someUrl?cursor=3","cursor":3}
supportTokenstring(Support Token)
Example: "1171c60d"
responseArray of objects(MultipleGroupRolesPerContextDTOV3)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Remove Group Roles

Request

Deletes a role from a group

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running User Management - Groups > Get All Groups of Organization).

Bodyapplication/jsonrequired
scopeUuidstringrequired
Example: "123e4567-e89b-12d3-a456-426655440000"
scopeTypestringrequired
Enum"organization""application""project""account""unsupported""organization""application"
Example: "organization"
rolestring
Enum"ADMIN""SCAN_MANAGER""SECURITY_ANALYST""MEMBER"
application/json
{
  "scopeUuid": "123e4567-e89b-12d3-a456-426655440000",
  "scopeType": "organization",
  "role": "ADMIN"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(MessageDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "message": "Success!"
  }
}

Add Group Role

Request

Creates a new group role for an organization

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running Administration - Groups > Get All Groups of Organization).

Bodyapplication/jsonrequired
scopeUuidstringrequired
Example: "123e4567-e89b-12d3-a456-426655440000"
scopeTypestringrequired
Enum"organization""application""project""account""unsupported""organization""application"
Example: "organization"
rolestring
Enum"ADMIN""SCAN_MANAGER""SECURITY_ANALYST""MEMBER"
application/json
{
  "scopeUuid": "123e4567-e89b-12d3-a456-426655440000",
  "scopeType": "organization",
  "role": "ADMIN"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(GroupRoleDTOV3)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "scopeUuid": "123e4567-e89b-12d3-a456-426655440000",
    "scopeName": "My Project",
    "scopeType": "organization",
    "role": "ADMIN"
  }
}

Get Group

Request

Returns the given group of an organization

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running Administration - Groups > Get All Groups of Organization).

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(GroupDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "123e4567-e89b-12d3-a456-426655440000",
    "name": "Group A",
    "description": "Group description",
    "userCount": 22
  }
}

Update Group

Request

Updates the properties of a given group

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running Administration - Groups > Get All Groups of Organization).

Bodyapplication/jsonrequired
namestring(Group Name)
Example: "Group A"
descriptionstring(Group Description)
Example: "Group description"
application/json
{
  "name": "Group A",
  "description": "Group description"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(GroupDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "123e4567-e89b-12d3-a456-426655440000",
    "name": "Group A",
    "description": "Group description",
    "userCount": 22
  }
}

Delete Group

Request

Deletes the given group

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running Administration - Groups > Get All Groups of Organization).

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(MessageDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "message": "Success!"
  }
}

Get Group Users

Request

Returns a list of users that belong to given group

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running Administration - Groups > Get All Groups of Organization)

Query
cursorString

Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.

limitstring<= 10000

Specifies the maximum number of items to be returned in the response.

Default "50"
No request payload

Responses

OK

Bodyapplication/json
additionalDataobject(Provides insights into endpoint-supported pagination information.)
  • totalItems: The total count of data points returned in an API response.
Example: {"totalItems":"422","next":"http://someUrl?cursor=3","cursor":3}
supportTokenstring(Support Token)
Example: "1171c60d"
responseArray of objects(UserInfoDTO)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Add User To Group

Request

Adds a user to an organization's group

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running Administration - Groups > Get All Groups of Organization).

Bodyapplication/jsonrequired
userEmailsArray of stringsuniquerequired
Example: ["jon.smith@mail.com"]
application/json
{
  "userEmails": [
    "jon.smith@mail.com"
  ]
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(MessageDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "message": "Success!"
  }
}

Get All Groups of organization

Request

Returns a list of all groups within an organization

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

Query
cursorString

Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.

limitstring<= 10000

Specifies the maximum number of items to be returned in the response.

Default "50"
No request payload

Responses

OK

Bodyapplication/json
additionalDataobject(Provides insights into endpoint-supported pagination information.)
  • totalItems: The total count of data points returned in an API response.
Example: {"totalItems":"422","next":"http://someUrl?cursor=3","cursor":3}
supportTokenstring(Support Token)
Example: "1171c60d"
responseArray of objects(GroupSummaryDTOV3)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Create Group

Request

Creates a new group for an organization

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

Bodyapplication/jsonrequired
namestring(Group Name)required
Example: "Group A"
descriptionstring(Group Description)required
Example: "Group description"
application/json
{
  "name": "Group A",
  "description": "Group description"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(GroupDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "123e4567-e89b-12d3-a456-426655440000",
    "name": "Group A",
    "description": "Group description",
    "userCount": 22
  }
}

Delete User From Group

Request

Deletes a user from an organization's group

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

groupUuidstringrequired

Group UUID (by running Administration - Groups > Get All Groups of Organization).

userUuidstringrequired

User UUID (by running User Management - Users > Get Organization Users).

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(MessageDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "message": "Success!"
  }
}

Administration - Users

Operations

Administration - Labels

Operations

Reports

Operations

Scans

Operations

Projects

Operations

Applications

Operations

Findings - Project

Operations

Findings - Scan

Operations