/deleteRole

1 min

POST

/deleteRole

Calling this request is used to delete an existing role in the MPC Driven system.

Request Example:

.. code-block::

  deleteRole(
      id="a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6",
      request_extra_data={
        "message_number": 5,
        "session_id": "3478593863424051983840947"
      }
  )

Response Example:

.. code-block::

  {
      "FunctionData": {
          "StatusCode": 0,
          "StatusCodeDescription": "Role deleted successfully"
      },
      "Meta": {
          "AccessToken": "2911...9a7",
          "Destination": "04bc...9e2",
          "Source": "3dcf...ba4",
          "Time": "2025-05-22 17:00:44.605"
      }
  }

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	Unknown role	"StatusCode": 1
Backend Response	400	2	Cannot delete built-in role	"StatusCode": 2
Backend Response	400	3	Role is already in use by users	"StatusCode": 3, "UserIds": ["[email protected]"]
Backend Response	400	4	Changing role permissions affects approval workflows (DEPRECATED)	"StatusCode": 4, "ApprovalWorkflowIds": ["123"]
Backend Response	400	5	Role is already in use by policies (DEPRECATED)	"StatusCode": 5, "PolicyIds": ["123"]

idstringThe identifier of the role to be deleted.

request_extra_dataobjectadditional data for the administrative request

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/deleteRole?id=a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6&request_extra_data={%0A%20%22MessageNumber%22%3A%205%2C%0A%20%22SessionId%22%3A%20%223478593863424051983840947%22%0A}%0A' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "Id": "123",
     "RequestExtraData": {
     "MessageNumber": 5,
     "SessionId": "3478593863424051983840947"
     }
     },
     "Meta": {
     "FunctionName": "deleteRole",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'