SCIM ProcessInstance examples
Operations
List all
List all GroupUser.ProcessInstances.
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUserProcessInstanceResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 25,311,
"startIndex": 1,
"Resources": [
{
"groupDescription"dummyProcess": false,
"variables": {},
"comments": [
{
"actor": "Enterprise"admin Soffid Administrator",
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.Comment"
],
"time": "2020-09-30 09:57:15",
"message": "Comentario"
}
],
"processDefinition": 628635,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/480412"ProcessInstance/626161",
"resourceType": "GroupUser"ProcessInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessInstance"
],
"start": "2020-07-0209-29 12:14:20:34:46",
"currentTask": "Entrada de la consulta",
"description": "Consultar la base de datos",
"end": "2020-11-11 15:05:48",
"fullName"id": "test626161
User"},
{
"disabled"dummyProcess": false,
"attributes"variables": {},
"id"comments": 480412,
"user": "test2"[],
"primaryGroup"processDefinition": false,
"group": "enterprise"
},
{
"groupDescription": "World Modified",628635,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"ProcessInstance/626179",
"resourceType": "GroupUser"ProcessInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessInstance"
],
"start": "2020-08-0609-29 15:52:12"20:35:22",
"fullName"currentTask": "testEntrada User"de la consulta",
"description": "Consultar la base de datos",
"end": "2021-02-262020-11-11 13:15:05:44",
"disabled": true,
"attributes": {},
"id": 503629,
"user": "test2",
"primaryGroup": false,
"group": "world2"626179
},
{
"groupDescription": "Enterprise Administrators Group",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1182887",
"resourceType": "GroupUser"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"start": "2020-12-31 16:48:58",
"fullName": "John Smith",
"disabled": false,
"attributes": {
"comments": "This is a test",
"startDate": "2021-01-01 00:00:00"
},
"id": 1182887,
"user": "jsmith",
"primaryGroup": false,
"group": "admingroup"
},
...........
]
}List by filter
List all GroupUsersProcessInstances with a filter expression.
It is allowed to use pagination and sort the information, for more information visit the Sorting and Pagination information.
Request
List all GroupUserProcessInstances with a filter expression.
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser?ProcessInstance?filter=groupDescriptiondescription co Permission and currentTask eq "World Modified"StartResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 4,8,
"startIndex": 1,
"Resources": [
{
"groupDescription"dummyProcess": false,
"variables": {
"requester": "Worldadmin",
Modified""grants": [],
"requesterName": "Soffid Administrator"
},
"comments": [],
"processDefinition": 1054785,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"ProcessInstance/1053984",
"resourceType": "GroupUser"ProcessInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessInstance"
],
"start": "2020-08-0612-14 15:52:12"14:49:20",
"fullName"currentTask": "testStart",
User""description": "Permissions request",
"end": "2021-02-2601-29 13:05:44",
"disabled": true,
"attributes": {}08:25:28",
"id": 503629,
"user": "test2",
"primaryGroup": false,
"group": "world2"1053984
},
{
"groupDescription"dummyProcess": false,
"variables": {
"requester": "Worldadmin",
Modified""grants": [],
"requesterName": "Soffid Administrator"
},
"comments": [],
"processDefinition": 1946303,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1519730"ProcessInstance/1378380",
"resourceType": "GroupUser"ProcessInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessInstance"
],
"start": "2021-02-2001-29 18:08:23"26:30",
"fullName"currentTask": "Dilbert ADAMS ."Start",
"end"description": "2021-02-20Permissions 19:07:45",
"disabled": true,
"attributes": {}request",
"id": 1519730,
"user": "dilbert",
"primaryGroup": false,
"group": "world2"1378380
},
{
"groupDescription": "World Modified",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1521501",
"resourceType": "GroupUser"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"start": "2021-02-20 20:21:06",
"fullName": "Dilbert ADAMS .",
"disabled": false,
"attributes": {},
"id": 1521501,
"user": "dilbert",
"primaryGroup": false,
"group": "world2"
},
{
"groupDescription": "World Modified",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1558480",
"resourceType": "GroupUser"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"start": "2021-02-26 13:06:24",
"fullName": "test User",
"disabled": false,
"attributes": {},
"id": 1558480,
"user": "test2",
"primaryGroup": false,
"group": "world2"
}..........
]
}
Query by id
Query a GroupUserProcessInstance by its id (primary key).
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1974296ProcessInstance/1474138Response 200 OK
{
"groupDescription"dummyProcess": false,
"variables": {
"requester": "Helpadmin",
desk"grants": support[],
team""firstName": "Peter",
"lastName": "Adams",
"requesterName": "Soffid Administrator",
"userType": "I",
"userName": "peter",
"primaryGroup": "enterprise"
},
"comments": [],
"processDefinition": 1474063,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1974296"ProcessInstance/1474138",
"resourceType": "GroupUser"ProcessInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessInstance"
],
"start": "2021-05-0502-11 12:49:51"16:43:06",
"fullName"currentTask": "John Smith"Start",
"disabled": false,
"attributes": {
"startDate"description": "2021-05-04User 00:00:00"
}registration",
"id": 1974296,
"user": "jsmith",
"primaryGroup": false,
"group": "it"1474138
}Create
To create a GroupUser.ProcessInstance.
Request
POST http://<your-domain>/soffid/webservice/scim2/v1/GroupUser-JSON
{
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"group": "it",
"groupDescription": "Help desk support team",
"user": "ckelp",
"fullName": "Casey Kelp",
"primaryGroup": true,
"attributes": {}
}-Response 201 Created
{
"groupDescription": "Help desk support team",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741",
"resourceType": "GroupUser"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"start": "2021-05-11 10:39:23",
"fullName": "Casey Kelp",
"disabled": false,
"attributes": {},
"id": 1976741,
"user": "ckelp",
"primaryGroup": true,
"group": "it"
}-Update partial
Update only of the attributes with changes, only these atrributes will be updated, the rest will maintain the same value.
Request
PATCH http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1976741JSON
{
"Operations": [
{
"op": "replace",
"path": "groupDescription",
"value": "Enterprise engineering team"
},
{
"op": "replace",
"path": "group",
"value": "EngineeringTeam"
}
]
}-Response 200 OK
{
"groupDescription": "Enterprise engineering team",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741",
"resourceType": "GroupUser"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"start": "2021-05-11 10:39:23",
"fullName": "Casey Kelp",
"disabled": false,
"attributes": {},
"id": 1976741,
"user": "ckelp",
"primaryGroup": true,
"group": "EngineeringTeam"
}-Update all
This operation replacereplaces all values in the GroupUser.ProcessInstance.
- Note that the attribute id is required to confirm that the resource "...
GroupUser/ProcessInstance/<id>" is the same that the JSONGroupUser.ProcessInstance. - Note that all the attributes not included in the request will be cleared in the
GroupUserProcessInstance type and their data will be lost. - Note that not all the attributes are updatable, for example tag meta, avoid these tags. For more information see Resource data model page
Request
PUT http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1976741-JSON
{
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"id": 1976741,
"group": "it",
"groupDescription": "Help desk support team",
"user": "ckelp",
"fullName": "Casey Kelp",
"primaryGroup": true,
"attributes": {}
}-Response 200 OK
{
"groupDescription": "Help desk support team",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741",
"resourceType": "GroupUser"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"fullName": "Casey Kelp",
"disabled": false,
"attributes": {},
"id": 1976741,
"user": "ckelp",
"primaryGroup": true,
"group": "it"
}-Delete
Delete a role.ProcessInstance.
Please note after this delete, the ProcessInstance has to be created again to use it in the next examples.
Request
DELETE http://<your-omain>/soffid/webservice/scim2/v1/GroupUser/1976741-Response 204 No Content
204 No ContentError response
For more infomation about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response