OPENIDM- HTTP PUT cURL request - openidm

I'm new to openIDM, I'm trying to execute the following query, getting proper results as expected which is POST.
$ curl -k -s https://localhost/openidm/managed/zzzz?_action=create -H 'Content-Type: application/json' -H 'X-OpenIDM-Username: '"openidm-admin"'' -H 'X-OpenIDM-Password: '"openidm-admin"'' -H 'Accept: application/json' -d
'{ "x": "'"AA1"'", "xx": "'"xx"'", "xxx": "'"xxx"'","xxxx": "'"xxxx"'"}'
Results:
{"_id":"db0489f6-d390-481f-8708-0970b3e42469","_rev":"0","x":"AA1","xx":"xx","xxx":"xxx","xxxx":"xxxx"}
But I want to have id value to be created as client Assigned ID not the one generated by openidm, and for that I am using PUT command as below
$ curl -k -s PUT https://xxxx/openidm/managed/zzzz/AA1 -H 'Content-Type: application/json' -H 'X-OpenIDM-Username: '"openidm-admin"'' -H 'X-OpenIDM-Password: '"openidm-admin"'' -H 'Accept: application/json' -d '{ "x": "'"AA1"'", "xx": "'"xx"'", "xxx": "'"xxx"'","xxxx": "'"xxxx"'"}'
Result :
{"code":400,"reason":"Bad Request","message":"The resource instance
/managed/zzzz/AA1 cannot be created"}
Output what I want is
{"_id":"AA1","_rev":"0","x":"AA1","xx":"xx","xxx":"xxx","xxxx":"xxxx"}
I am not sure what I'm doing wrong, Any suggestion ? I followed openidm documentation and below is the link for that.
https://backstage.forgerock.com/docs/idm/5.5/integrators-guide/#about-crest-create

Related

curl command for REST API which takes json input

I want to call REST API by passing json input.
I have following details-
username
apitoken
apiurl
Jsonfile
I have already tried
curl -d #Metadata.json -H "Content-Type: application/json" <> --user xyz:apitoken --insecure
but i m getting null values for all the parameters in the json file.
What am i doing wrong here?
Simple Solution would be to create a sample postman with above details then follow below steps -
Click on the code icon.
Choose cURL from the drop-down.
There’s your cURL command
Sample curl command -
curl -X POST \
https://something.com/endpoint \
-H 'Content-Type: application/json' \
-H 'Postman-Token: 1f0fcc007739' \
-H 'apikey: CSZftBtR0WaN' \
-H 'cache-control: no-cache' \
-d '{
"Id": "5de675",
"xxxxx": "500081"
}'

I try convert this cURL code in code for Retrofit2 but I can't

I try convert this cURL in kotlin with retrofit2, but I can't.
'curl -X POST \
URL_BASE\
-H 'Authorization: Bearer <your_access_token>' \
-H 'content-type: application/json' \
-d '{
“process”: “Attended”,
“rauthorityId”: “<your_rauthorityId>”
}'

Not able to PUT multiple users to https://api.vimeo.com/channels/{channel_id}/privacy/users

In reading https://developer.vimeo.com/api/reference/channels#PUT/channels/{channel_id}/privacy/users it looks like it should be possible to allow multiple users to view a private channel by sending a body with multiple users.
When I issue the following cURL
curl -X PUT \
https://api.vimeo.com/channels/1407898/privacy/users \
-H 'Authorization: Bearer {bearer token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Postman-Token: 8a5288c3-1352-4c90-8874-aa622930c4e7' \
-d users=89969174
I get back
{
"error": "Something strange occurred. Please try again.",
"link": null,
"developer_message": "The body of this HTTP request is not formatted properly. Please check the content-type header and raw body.",
"error_code": 2205
}
I'm not certain what I'm doing wrong, here?
The documentation on that endpoint is a bit lacking - Vimeo will fix that soon.
To add multiple users, you'll need to send an array of objects:
curl -X PUT
https://api.vimeo.com/channels/*channel_id*/privacy/users
-H 'Accept: application/vnd.vimeo.*+json;version=3.4'
-H 'Authorization: bearer *token*'
-H 'Content-Type: application/json'
-d '[
{"uri":"/users/*userid1*"},{"uri":"/users/*userid2*"}
]
'

Extract token from a curl request and use in another shell command

I've started picking up bash scripting and I'm stuck at something I'm trying to wrap my head around.
I have a curl command that outputs a token and I need to use it in the following command:
curl -k 'https://server:port/session' -X POST -H 'Content-Type: application/json' -d '{"username":"admin","password":"password"}'
It then outputs a token here:
{"token":"ac07098ad59ca6f3fccea0e2a2f6cb080df55c9a52fc9d65"}
I then need to use it in the follow up command
curl https://server:port/ -k -X POST -H 'Content-Type: application/json' -H 'X-Cookie:token=token' -d '
I was thinking I could output the token to a file, then have a sed command write the token to a file, then the new command use a variable where token=$token
Thanks!
This is where a JSON parsing tool comes in handy (such as jq):
$ echo '{"token":"ac07098ad59ca6f3fccea0e2a2f6cb080df55c9a52fc9d65"}' | jq -r .token
ac07098ad59ca6f3fccea0e2a2f6cb080df55c9a52fc9d65
So
json=$( curl -k 'https://server:port/session' -X POST -H 'Content-Type: application/json' -d '{"username":"admin","password":"password"}' )
token=$( jq -r ".token" <<<"$json" )
curl https://server:port/ -k -X POST -H "X-Cookie:token=$token" ...
With no further tool than a bash (tested Centos/Rhel7/GitBash) :
json=$(curl -k 'https://server:port/session' \
-X POST -H 'Content-Type: application/json' \
-d '{"username":"admin","password":"password"}') \
&& token=$(echo $json | sed "s/{.*\"token\":\"\([^\"]*\).*}/\1/g") \
&& echo "token = $token"
then use your authentication needing commands like that :
curl https://server:port/ -k -X POST \
-H 'Content-Type: application/json' \
-H 'X-Cookie:token=$token' -d ...'
If Python is installed, and hopefully it is on modern systems, you can do something like:
OUTPUT="$(curl -k 'https://server:port/session' -X POST -H 'Content-Type: application/json' -d '{"username":"admin","password":"password"}' | python -c "import sys, json; print json.load(sys.stdin)['token']")"
This will give you:
echo $OUTPUT
ec2e99a1d294fd4bc0a04da852ecbdeed3b55671c08cc09f
Use the `` syntax:
cmd1result=$(command1 | cut -d ':' -f 2 | grep -Po "[a-z0-9-]+")
command2 $cmd1result

How to pass payload via JSON file for curl?

I can successfully create a place via curl executing the following command:
$ curl -vX POST https://server/api/v1/places.json -d "
auth_token=B8dsbz4HExMskqUa6Qhn& \
place[name]=Fuelstation Central& \
place[city]=Grossbeeren& \
place[address]=Buschweg 1& \
place[latitude]=52.3601& \
place[longitude]=13.3332& \
place[washing]=true& \
place[founded_at_year]=2000& \
place[products][]=diesel& \
place[products][]=benzin \
"
The server returns HTTP/1.1 201 Created.
Now I want to store the payload in a JSON file which looks like this:
// testplace.json
{
"auth_token" : "B8dsbz4HExMskqUa6Qhn",
"name" : "Fuelstation Central",
"city" : "Grossbeeren",
"address" : "Buschweg 1",
"latitude" : 52.3601,
"longitude" : 13.3332,
"washing" : true,
"founded_at_year" : 2000,
"products" : ["diesel","benzin"]
}
So I modify the command to be executed like this:
$ curl -vX POST http://server/api/v1/places.json -d #testplace.json
This fails returning HTTP/1.1 401 Unauthorized. Why?
curl sends POST requests with the default content type of application/x-www-form-urlencoded. If you want to send a JSON request, you will have to specify the correct content type header:
$ curl -vX POST http://server/api/v1/places.json -d #testplace.json \
--header "Content-Type: application/json"
But that will only work if the server accepts json input. The .json at the end of the url may only indicate that the output is json, it doesn't necessarily mean that it also will handle json input. The API documentation should give you a hint on whether it does or not.
The reason you get a 401 and not some other error is probably because the server can't extract the auth_token from your request.
To clarify how to actually specify a file that contains the JSON to post, note that it's with the # sign as shown in the OP
e.g. a typical post to a local .NET Core API:
curl -X POST https://localhost:5001/api -H "Content-Type: application/json" -d #/some/directory/some.json
You can cat the contents of a json file to curl via the --data-raw parameter
curl https://api.com/route -H 'Content-Type: application/json' --data-raw "$(cat ~/.json/payload-2022-03-03.json | grep -v '^\s*//')"
curl https://api.com/route -H 'Content-Type: application/json' -d #<(jq . ~/.json/payload-2022-03-03.json)
curl https://api.com/route -H 'Content-Type: application/json' -d #<(jq '{"payload": .}' < ~/.json/payload-2022-03-03.json)
Note: comments in the json file are filtered out via grep -v '^\s*//'
You can also pass the data to curl via stdin using grep or cat or jq
grep -v '^\s*//' ~/.json/payload-2022-03-03.json | curl https://api.com/route -H 'Content-Type: application/json' -d #-
cat ~/.json/payload-2022-03-03.json | grep -v '^\s*//' | curl https://api.com/route -H 'Content-Type: application/json' -d #-
jq . ~/.json/payload-2022-03-03.json | curl https://api.com/route -H 'Content-Type: application/json' -d #-
jq '{"payload": .}' < ~/.json/payload-2022-03-03.json | curl https://api.com/route -H 'Content-Type: application/json' -d #-