Jump to

• Request
• Response
• Examples

Bulk Update User Status

post

/rest/v19/users/actions/bulkUpdate

This endpoint is used to perform a bulk update of active and inactive users based on the criteria passed in the request body.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Bulk Update Request

Type: object

Title: Bulk Update Request

Bulk Update Request

Show Source

• criteria: object Criteria
  Title: Criteria

  Criteria to Filter Users
• userData: object UserData
  Title: UserData

  User Data to Update

{
    "type":"object",
    "properties":{
        "userData":{
            "$ref":"#/definitions/userData"
        },
        "criteria":{
            "$ref":"#/definitions/criteria"
        }
    },
    "title":"Bulk Update Request",
    "description":"Bulk Update Request"
}

Nested Schema : Criteria

Type: object

Title: Criteria

Criteria to Filter Users

Show Source

• q: string
  Title: Filter String

  Filter String

{
    "type":"object",
    "properties":{
        "q":{
            "type":"string",
            "description":"Filter String",
            "title":"Filter String"
        }
    },
    "title":"Criteria",
    "description":"Criteria to Filter Users"
}

Nested Schema : UserData

Type: object

Title: UserData

User Data to Update

Show Source

• status: object Status
  Title: Status

  Status of the user

{
    "type":"object",
    "properties":{
        "status":{
            "type":"object",
            "description":"Status of the user",
            "title":"Status",
            "properties":{
                "value":{
                    "$ref":"#/definitions/numberValue"
                },
                "displayValue":{
                    "$ref":"#/definitions/displayValue"
                }
            }
        }
    },
    "title":"UserData",
    "description":"User Data to Update"
}

Nested Schema : Status

Type: object

Title: Status

Status of the user

Show Source

• displayValue: string
  Title: Display Value

  Display value.
• value: number
  Title: Value

  Value.

{
    "type":"object",
    "description":"Status of the user",
    "title":"Status",
    "properties":{
        "value":{
            "$ref":"#/definitions/numberValue"
        },
        "displayValue":{
            "$ref":"#/definitions/displayValue"
        }
    }
}

Back to Top

Response

204 Response

All Users updated successfully.

Back to Top

Examples

This endpoint is used to perform a bulk update of user status based on the criteria passed in the request body by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/users/actions/bulkUpdate

Request Body Sample

{
  "userData": {
    "status": {
      "value": 0,
      "displayValue": "Inactive"
    }
  },
  "criteria": {
    "q": "{'login' :{'$like':'%jsmith%'}}"
  }
}

Note: The display value is optional in the sample above. For example, the following sample is also valid.

{
  "userData": {
    "status": {
      "value": 0
    }
  },
  "criteria": {
    "q": "{'login' :{'$like':'%jsmith%'}}"
  }
}

Back to Top