Roles API (1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Provides access to the roles in Hyperproof.

Download OpenAPI description

Servers

Mock server

https://developer.hyperproof.app/_mock/hyperproof-api/roles/roles.openapi

Hyperproof US

https://api.hyperproof.app/v1/roles

Hyperproof Gov

https://api.hyperproofgov.app/v1/roles

Hyperproof EU

https://api.hyperproof.eu/v1/roles

Get Roles

GET /

Retrieves a list of all Hyperproof roles, including role names, descriptions, and associated permissions.

Security

oauth2

curl -i -X GET \
  https://developer.hyperproof.app/_mock/hyperproof-api/roles/roles.openapi/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Success.

Bodyapplication/jsonArray [

idstring(uuid)

The unique identifier for the role.

Example: "f5a110d4-00a2-11ee-acbd-2bbf74beda27"

namestring

The name of the role.

Example: "Control Contributor"

scopestring

The type of object that this role can be applied to.

Example: "control"

]

Response

application/json

[
  {
    "id": "f5a110d4-00a2-11ee-acbd-2bbf74beda27",
    "name": "Control Contributor",
    "scope": "control"
  }
]