Skip to content
Platform API 3.0
/
/
Block User

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.

Note: To help you get started with the Mend API 3.0, we recommend reviewing our onboarding guide -> Getting Started with API 3.0. This resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend API 3.0.

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

Access Management

Operations

Administration - Groups

Operations

Administration - Users

Operations

Unblock User

Request

Unblocks a user in the organization

Security
bearer-key
Path
orgUuidstringrequired

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

userUuidstringrequired

User UUID (Administration > Users)

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseboolean
Response
application/json
{
  "supportToken": "1171c60d",
  "response": true
}

Block User

Request

Blocks a user in the organization

Security
bearer-key
Path
orgUuidstringrequired

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

userUuidstringrequired

User UUID (Administration > Users)

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseboolean
Response
application/json
{
  "supportToken": "1171c60d",
  "response": true
}

Invite User

Request

Sends an email invitation to others to join an organization

Security
bearer-key
Path
orgUuidstringrequired

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

Bodyapplication/jsonrequired
emailstring(New User Email)required
Example: "jon.smith@mail.com"
application/json
{
  "email": "jon.smith@mail.com"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(UserInfoResponseDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "123e4567-e89b-12d3-a456-426655440000",
    "name": "Jon Smith",
    "email": "jon.smith@mail.com",
    "userType": "REGULAR",
    "existsInOrg": true
  }
}

Get Organization Users

Request

Returns a list of all users in an organization (paginated)

Security
bearer-key
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(UserInfoDTOV3)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Remove User From Organization

Request

Deletes a user from an organization

Security
bearer-key
Path
orgUuidstringrequired

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

userUuidstringrequired

User UUID (Administration > Users)

No request payload

Responses

OK

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

Administration - Labels

Operations

Reports

Operations

Scans

Operations

Projects

Operations

Applications

Operations

Findings - Project

Operations

Findings - Scan

Operations

SAST

Operations

Settings - Organization

Operations

Integrations

Operations

AI

Operations

Red Team

Operations