IRironcladapp
Workflows

Update Workflow Role Assignment

Updates the assignment of the specified role (e.g. Archiver, Signature Coordinator, etc.) on the workflow to a new user. The new assignee must be eligible to be assigned to the role per the workflow definition configured in workflow designer. Note: If a role is assigned to another role in the workflow configuration, the new assignee will be assigned to both roles.

OAuth Scope required: public.workflows.updateRoleAssignment

patch/workflows/{id}/roles/{roleName}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/roles/{roleName}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.workflows.updateRoleAssignment

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

roleNamestring required

The display name of the role, URL-encoded (e.g. Legal%20Approver).

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Request body

userIdstring required

The id of the Ironclad user to assign to the role. Must be eligible to be assigned to the role.

Example request

{
  "userId": "61968ae4945dcecf4a78cc83"
}

Response

200

roleNamestring required

The display name of the role that was updated.

Example response

{
  "roleName": "Legal Approver",
  "assignee": {
    "userId": "61968ae4945dcecf4a78cc83",
    "displayName": "Jane Doe",
    "email": "jane@example.com"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.