curl --request OPTIONS \
--url http://{host}:{port}/{contextPath}/user/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "http://{host}:{port}/{contextPath}/user/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.options(url, headers=headers)
print(response.text)const options = {method: 'OPTIONS', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('http://{host}:{port}/{contextPath}/user/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://{host}:{port}/{contextPath}/user/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "OPTIONS",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://{host}:{port}/{contextPath}/user/{id}"
req, _ := http.NewRequest("OPTIONS", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.options("http://{host}:{port}/{contextPath}/user/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{contextPath}/user/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Options.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"links": [
{
"method": "GET",
"href": "http://localhost:8080/engine-rest/user/peter/profile",
"rel": "self"
},
{
"method": "DELETE",
"href": "http://localhost:8080/engine-rest/user/peter",
"rel": "delete"
},
{
"method": "PUT",
"href": "http://localhost:8080/engine-rest/user/peter/profile",
"rel": "update"
}
]
}Options
The /user resource supports two custom OPTIONS requests, one for the resource as such
and one for individual user instances. The OPTIONS request allows checking for the set of
available operations that the currently authenticated user can perform on the /user resource.
If the user can perform an operation or not may depend on various things, including the user’s
authorizations to interact with this resource and the internal configuration of the process
engine. OPTIONS /user/{id} returns available interactions on a resource instance.
curl --request OPTIONS \
--url http://{host}:{port}/{contextPath}/user/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "http://{host}:{port}/{contextPath}/user/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.options(url, headers=headers)
print(response.text)const options = {method: 'OPTIONS', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('http://{host}:{port}/{contextPath}/user/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://{host}:{port}/{contextPath}/user/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "OPTIONS",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://{host}:{port}/{contextPath}/user/{id}"
req, _ := http.NewRequest("OPTIONS", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.options("http://{host}:{port}/{contextPath}/user/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("http://{host}:{port}/{contextPath}/user/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Options.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"links": [
{
"method": "GET",
"href": "http://localhost:8080/engine-rest/user/peter/profile",
"rel": "self"
},
{
"method": "DELETE",
"href": "http://localhost:8080/engine-rest/user/peter",
"rel": "delete"
},
{
"method": "PUT",
"href": "http://localhost:8080/engine-rest/user/peter/profile",
"rel": "update"
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The id of the user to be deleted.
Response
Request successful.
The links associated to this resource, with method, href and rel.
Show child attributes
Show child attributes