Delete Roles

Request

Path Params

roleName

string

required

Example:

exampleRole

Header Params

x-rockit-beauth-token

string

optional

ROCKIT Edge backend authentication token (POST /be/v1/auth) or API key (POST /be/v1/apikeys)
Mutually excluded with x-rockit-api-key.

Example:

x-rockit-orgname

string

optional

Unique and immutable organization identifier obtained from the ROCKIT Edge administrator.
Requires x-rockit-username and x-rockit-api-key.

Example:

x-rockit-username

string

optional

Unique and immutable username which is accociated with the apikey.
Requires x-rockit-orgname and x-rockit-api-key.

Example:

adminPrincipal

x-rockit-api-key

string

optional

Unique and imuutable apikey which is accociated with an machine user.
Mutually excluded with x-rockit-beauth-token. Requires x-rockit-username and x-rockit-orgname.

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request DELETE 'https://Example-Server.com/be/v1/roles/exampleRole' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}'

Responses

🟢200Success

application/json

Body

status

string

required

A string confirming that the deletion operation was successful.

message

string

required

A confirmation message (for example, "app deleted") indicating that the specified app has been removed from the system.

Example

{
  "status": "success",
  "message": "role deleted"
}

🟠400Invalid Param

🟠401Unauthorized

🟠409Item protected

Required Permissions#

Request

Request samples

Responses

Required Permissions