Skip to main content

Bulk-Update Roles' Metadata by ID

POST 

/roles/access-model-metadata/bulk-update/ids

This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed.

Request

Body

required

    roles string[]required

    Roles' Id to be updated

    operation stringrequired

    Possible values: [add, remove, replace]

    The operation to be performed

    replaceScope string

    Possible values: [ALL, ATTRIBUTE]

    The choice of update scope.

    values

    object[]

    required

    The metadata to be updated, including attribute key and value.

  • Array [

  • attribute stringrequired

    the key of metadata attribute

    values string[]nullablerequired

    the values of attribute to be updated

  • ]

Responses

Returned if bulk update request created

Schema

    id string

    ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status.

    type string

    Type of the bulk update object.

    status string

    Possible values: [CREATED, PRE_PROCESS, PRE_PROCESS_COMPLETED, POST_PROCESS, COMPLETED, CHUNK_PENDING, CHUNK_PROCESSING]

    The status of the bulk update request, could also checked by getBulkUpdateStatus API

    created date-time

    Time when the bulk update request was created

Loading...