Jump to

• Request
• Response

Add, Update or Delete Permissions for a Role

post

/ic/api/process/v1/dp-roles/{id}/permissions

Add, update, or delete permissions for a role.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Process role ID

Body ()

Permissions change request list.

Root Schema : ProcessRolePermissionsActionInput

Type: object

Show Source

• actions: array actions

{
    "type":"object",
    "properties":{
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProcessRolePermissionsAction"
            }
        }
    }
}

Nested Schema : actions

Type: array

Show Source

• Array of: object ProcessRolePermissionsAction

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProcessRolePermissionsAction"
    }
}

Nested Schema : ProcessRolePermissionsAction

Type: object

Show Source

• object: object ProcessRolePermission
• type: string
  Allowed Values: [ "INSERT", "UPDATE", "DELETE" ]

{
    "type":"object",
    "properties":{
        "object":{
            "$ref":"#/definitions/ProcessRolePermission"
        },
        "type":{
            "$ref":"#/definitions/ProcessRoleChangeRequestType"
        }
    }
}

Nested Schema : ProcessRolePermission

Type: object

Show Source

• actions: array actions
  List of actions
• condition: string
  The condition when this permission will be activated
• id: string
  The process role permission ID.
• resources: array resources

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The process role permission ID."
        },
        "condition":{
            "type":"string",
            "description":"The condition when this permission will be activated"
        },
        "actions":{
            "type":"array",
            "description":"List of actions",
            "items":{
                "$ref":"#/definitions/ProcessRolePermissionActionType"
            }
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProcessRoleResource"
            }
        }
    }
}

Nested Schema : actions

Type: array

List of actions

Show Source

• Array of: string
  Allowed Values: [ "NONE", "ALL", "READ", "UPDATE", "CREATE", "ACCESS", "DOCUMENT_DOWNLOAD", "DOCUMENT_CONTRIBUTE" ]

{
    "type":"array",
    "description":"List of actions",
    "items":{
        "$ref":"#/definitions/ProcessRolePermissionActionType"
    }
}

Nested Schema : resources

Type: array

Show Source

• Array of: object ProcessRoleResource
  Process Role Resource

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProcessRoleResource"
    }
}

Nested Schema : ProcessRoleResource

Type: object

Process Role Resource

Show Source

• resourceId: string
  ID of resource
• resourceType: string
  type of resource
• subResourceId: string
  sub respurce ID

{
    "description":"Process Role Resource",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"type of resource"
        },
        "resourceId":{
            "type":"string",
            "description":"ID of resource"
        },
        "subResourceId":{
            "type":"string",
            "description":"sub respurce ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : ProcessRolePermissions

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object ProcessRolePermissions-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessRolePermission"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Discriminator: links

Show Source

• links: array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ProcessRolePermissions-allOf[1]

Type: object

Show Source

• items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProcessRolePermission"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ProcessRolePermission

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProcessRolePermission"
    }
}

Nested Schema : ProcessRolePermission

Type: object

Show Source

• actions: array actions
  List of actions
• condition: string
  The condition when this permission will be activated
• id: string
  The process role permission ID.
• resources: array resources

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The process role permission ID."
        },
        "condition":{
            "type":"string",
            "description":"The condition when this permission will be activated"
        },
        "actions":{
            "type":"array",
            "description":"List of actions",
            "items":{
                "$ref":"#/definitions/ProcessRolePermissionActionType"
            }
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProcessRoleResource"
            }
        }
    }
}

Nested Schema : actions

Type: array

List of actions

Show Source

• Array of: string
  Allowed Values: [ "NONE", "ALL", "READ", "UPDATE", "CREATE", "ACCESS", "DOCUMENT_DOWNLOAD", "DOCUMENT_CONTRIBUTE" ]

{
    "type":"array",
    "description":"List of actions",
    "items":{
        "$ref":"#/definitions/ProcessRolePermissionActionType"
    }
}

Nested Schema : resources

Type: array

Show Source

• Array of: object ProcessRoleResource
  Process Role Resource

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProcessRoleResource"
    }
}

Nested Schema : ProcessRoleResource

Type: object

Process Role Resource

Show Source

• resourceId: string
  ID of resource
• resourceType: string
  type of resource
• subResourceId: string
  sub respurce ID

{
    "description":"Process Role Resource",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"type of resource"
        },
        "resourceId":{
            "type":"string",
            "description":"ID of resource"
        },
        "subResourceId":{
            "type":"string",
            "description":"sub respurce ID"
        }
    }
}

401 Response

Unauthorized.

403 Response

The user does not have permission to change dynamic process role permissions.

404 Response

Role or permission to be updated/deleted not found.

500 Response

Internal Server Error.

Back to Top