Jump to

• Request
• Response

Add, Update, or Delete Members for a Role

post

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

Add, update, or delete members for a role.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Process role ID.

Body ()

Members change request list.

Root Schema : ProcessRoleMembersActionInput

Type: object

Show Source

• actions: array actions

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

Nested Schema : actions

Type: array

Show Source

• Array of: object ProcessRoleMembersAction

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

Nested Schema : ProcessRoleMembersAction

Type: object

Show Source

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

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

Nested Schema : ProcessRoleMember

Type: object

Show Source

• id: string
  The process role member's ID.
• memberName: string
  The process role member's ID.
• memberType: string
  Allowed Values: [ "USER", "GROUP" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The process role member's ID."
        },
        "memberName":{
            "type":"string",
            "description":"The process role member's ID."
        },
        "memberType":{
            "$ref":"#/definitions/ProcessRoleMemberType"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ProcessRoleMembers

Type: object

Match All

Show Source

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

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

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 : ProcessRoleMembers-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object ProcessRoleMember

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

Nested Schema : ProcessRoleMember

Type: object

Show Source

• id: string
  The process role member's ID.
• memberName: string
  The process role member's ID.
• memberType: string
  Allowed Values: [ "USER", "GROUP" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The process role member's ID."
        },
        "memberName":{
            "type":"string",
            "description":"The process role member's ID."
        },
        "memberType":{
            "$ref":"#/definitions/ProcessRoleMemberType"
        }
    }
}

401 Response

Unauthorized

403 Response

User is not allowed to perform changes to process role members.

404 Response

Role or Member to be deleted not found

500 Response

Internal Server Error

Back to Top