Table of Contents | ||
---|---|---|
|
In the following it is assumed that:
- curl is the reference tool for CLI invocation
admin:password
are the credentials for accessing Syncope core- Syncope core runs on http://localhost:9080/syncope
...
...
style | decimal |
---|
Apache Syncope >= 2.0.X
...
Details are available in the Reference Guide.
Info |
---|
With Apache Syncope 2.0.0, besides using curl as with earlier versions, a brand new CLI tool is available. |
Tip |
---|
For more details please refer to the REST API reference, which is also available in your own deployment at http://localhost:9080/syncope/. |
Tip |
---|
If selected for deployment, the Swagger extension is also available in your deployment at http://localhost:9080/syncope/swagger/. |
...
Tip |
---|
For more details please refer to the REST API reference, which is also available in your own deployment at http://localhost:9080/syncope/rest/doc/. |
...
Code Block |
---|
curl -X POST -u admin:password -H "Accept: application/json" -H "Content-Type: application/json" \ --data @/tmp/newuser.json http://localhost:9080/syncope/rest/users |
...
Code Block | ||
---|---|---|
| ||
{ "id": 0, "password": "password123", "username": "myusername@cazmyusername@apache.itorg", "securityQuestion": null, "securityAnswer": null, "attributes": [ { "schema": "fullname", "readonly": false, "values": [ "myusername@cazmyusername@apache.itorg" ] }, { "schema": "loginDate", "readonly": false, "values": [ "2015-11-12" ] } ] } |
...
Code Block |
---|
curl -X POST -u admin:password -H "Accept: application/json" -H "Content-Type: application/json" \ --data @/tmp/updateuser.json http://localhost:9080/syncope/rest/users/100 |
...
to avoid Syncope core populating the HTTP response with the updated user entry.
Delete user
Panelcode |
---|
curl -X DELETE -u admin:password -H "Accept: application/json" http://localhost:9080/syncope/rest/users/100 |
where 100 is the id of the user to be deleted.
...
to avoid Syncope core populating the HTTP response with the deleted user entry.
Export database content
Panelcode |
---|
curl -X GET -u admin:password -o content.xml http://localhost:9080/syncope/rest/configurations/stream |
Change configuration parameter value
Panelcode |
---|
curl -X PUT -u admin:password -H "Accept: application/json" -H "Content-Type: application/json" \ -d '{"schema":"selfRegistration.allowed","values":["true"]}' http://localhost:9080/syncope/rest/configurations/selfRegistration.allowed |
Apache Syncope <= 1.1.X
Create user
Panelcode |
---|
curl -u admin:password -H "Content-Type: application/json" --data @/tmp/newuser.json http://localhost:9080/syncope/rest/user/create.json |
where /tmp/newuser.json
looks like:
...
Code Block | ||
---|---|---|
| ||
"resources": [ "ws-target-resource-1" ] |
Export database content
Panelcode |
---|
curl -u admin:password -o content.xml -H "Content-Type: application/xml" -X GET http://localhost:9080/syncope/cxf/configurations/stream |
Change configuration parameter value
Panelcode |
---|
curl -u admin:password -H "Content-Type: application/json" \ -d '{"key":"smtp.host","value":"smtp.ngi.it"}' http://localhost:9080/syncope/rest/configuration/update.json |