Revoke permission on a Workflow

DELETE

/api/v2/workflows/{workflow_id}/permissions

Revokes access to a workflow for a user or team.

Path Parameters:

workflow_id (int): The ID of the workflow

Request Body:

subject_type (str, required): "user" or "team"

subject_id (str, required): ID of the user or team

relation (str, optional): Role to revoke — "admin", "member", or "all". Defaults to "all".
Use "all" to remove every role the subject holds on the workflow.

Note: The owner relation is system-assigned and cannot be revoked here.
If the subject is the workflow owner, a 403 is returned.

Authorization:

Requires manage permission on the workflow

Returns:

A response containing the revoked permission details

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200

application/json

Permission revoked successfully

Body

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request DELETE 'https:///api/v2/workflows//permissions' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "workflow_id": 0,
        "subject_type": "string",
        "subject_id": "string",
        "subject_name": "string",
        "revoked_relations": [
            "string"
        ],
        "revoked_at": "string"
    }
}

Update a permission on a Workflow

Batch grant permissions on a Workflow