SCIM TaskInstance examples
Operations
List all
List all GroupUser.TaskInstances.
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUserTaskInstanceResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 25,6,
"startIndex": 1,
"Resources": [
{
"groupDescription"variables": {
"requester": "Enterprise"admin",
"grants": [
{
"ownersString": "SOFFID_ADMIN ",
"comments": "",
"roleId": 393447,
"userFullName": "Soffid Administrator",
"owners": [
"SOFFID_ADMIN"
],
"userName": "admin",
"approved": false,
"applicationDescription": "SOFFID Identity Manager",
"taskInstance": 1762656,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Accounting Manager",
"applicationName": "Container/Business 2/SOFFID"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1762352,
"description": "Approve ",
"pooledActors": [
"SOFFID_ADMIN"
],
"priority": 3,
"transitions": [
"Rechazar",
"Aceptar"
],
"dummyTask": false,
"processName": "Modificar permisos",
"processId": 1762544,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/480412"TaskInstance/1762656",
"resourceType": "GroupUser"TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"TaskInstance"
],
"start"name": "2020-07-02 12:14:48"Approve",
"fullName"create": "test2021-03-30 User"19:57:35",
"disabled"cancelled": false,
"attributes": {},
"id": 480412,1762656,
"user"open": "test2",true,
"primaryGroup"signalling": false,
"group": "enterprise"true
},
{
"groupDescription"variables": {
"requester": "Worldadmin",
Modified""grants": [
{
"ownersString": "admin ",
"comments": "",
"roleId": 393447,
"userFullName": "Soffid Administrator",
"owners": [
"admin"
],
"userName": "admin",
"approved": false,
"applicationDescription": "SOFFID Identity Manager",
"taskInstance": 1861549,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Accounting Manager",
"applicationName": "Operation/Business 2/SOFFID"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1946303,
"description": "Approve pending permissions",
"pooledActors": [
"admin"
],
"priority": 3,
"transitions": [
"Reject",
"Approve"
],
"dummyTask": false,
"processName": "Permissions request",
"processId": 1861537,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"TaskInstance/1861549",
"resourceType": "GroupUser"TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"TaskInstance"
],
"start"name": "2020-08-06 15:52:12"Approve",
"fullName": "test User",
"end"create": "2021-02-2604-17 13:05:44"21:00:46",
"disabled"cancelled": false,
"id": 1861549,
"open": true,
"attributes"signalling": {},
"id": 503629,
"user": "test2",
"primaryGroup": false,
"group": "world2"true
},
{
"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 GroupUsersTaskInstances 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 GroupUser with a filter expression.
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser?TaskInstance?count=2&filter=groupDescriptionprocessName eq "WorldPermissions Modified"request" and name eq ApproveResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 4,
"startIndex": 1,
"Resources": [
{
"groupDescription"variables": {
"requester": "Worldadmin",
Modified""grants": [
{
"ownersString": "admin ",
"comments": "",
"roleId": 393447,
"userFullName": "Soffid Administrator",
"owners": [
"admin"
],
"userName": "admin",
"approved": false,
"applicationDescription": "SOFFID Identity Manager",
"taskInstance": 1861549,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Accounting Manager",
"applicationName": "Operation/Business 2/SOFFID"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1946303,
"description": "Approve pending permissions",
"pooledActors": [
"admin"
],
"priority": 3,
"transitions": [
"Reject",
"Approve"
],
"dummyTask": false,
"processName": "Permissions request",
"processId": 1861537,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"TaskInstance/1861549",
"resourceType": "GroupUser"TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"TaskInstance"
],
"start"name": "2020-08-06 15:52:12"Approve",
"fullName": "test User",
"end"create": "2021-02-2604-17 13:05:44"21:00:46",
"disabled"cancelled": false,
"id": 1861549,
"open": true,
"attributes"signalling": {},
"id": 503629,
"user": "test2",
"primaryGroup": false,
"group": "world2"true
},
{
"groupDescription"variables": {
"requester": "Worldadmin",
Modified""grants": [
{
"ownersString": "admin ",
"comments": "",
"roleId": 393103,
"userFullName": "Soffid Administrator",
"owners": [
"admin"
],
"userName": "admin",
"approved": false,
"applicationDescription": "Active Directory",
"taskInstance": 1638273,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Enterprise Administrators",
"applicationName": "Container/Business process/ad"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1946303,
"start": "2021-05-10 12:57:31",
"description": "Approve pending permissions",
"pooledActors": [
"admin"
],
"priority": 3,
"transitions": [
"Reject",
"Approve"
],
"dummyTask": false,
"actorId": "admin",
"processName": "Permissions request",
"processId": 1638261,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1519730"TaskInstance/1638273",
"resourceType": "GroupUser"TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"TaskInstance"
],
"start"name": "Approve",
"create": "2021-02-2003-11 18:08:23"16:33:41",
"fullName"cancelled": "Dilbert ADAMS .",false,
"end"id": "2021-02-20 19:07:45",1638273,
"disabled"open": true,
"attributes"signalling": {},
"id": 1519730,
"user": "dilbert",
"primaryGroup": false,
"group": "world2"true
},
{
"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 GroupUser by its id (primary key).
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1974296TaskInstance/1861549Response 200 OK
{
"groupDescription"variables": {
"requester": "Helpadmin",
desk"grants": support[
team"{
"ownersString": "admin ",
"comments": "",
"roleId": 393447,
"userFullName": "Soffid Administrator",
"owners": [
"admin"
],
"userName": "admin",
"approved": false,
"applicationDescription": "SOFFID Identity Manager",
"taskInstance": 1861549,
"schemas": [
"urn:soffid:com.soffid.iam.addons.bpm.common.RoleRequestInfo"
],
"denied": false,
"roleDescription": "Accounting Manager",
"applicationName": "Operation/Business 2/SOFFID"
}
],
"requesterName": "Soffid Administrator"
},
"processDefinition": 1946303,
"description": "Approve pending permissions",
"pooledActors": [
"admin"
],
"priority": 3,
"transitions": [
"Reject",
"Approve"
],
"dummyTask": false,
"processName": "Permissions request",
"processId": 1861537,
"blocking": false,
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1974296"TaskInstance/1861549",
"resourceType": "GroupUser"TaskInstance"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"TaskInstance"
],
"start"name": "Approve",
"create": "2021-05-0504-17 12:49:51"21:00:46",
"fullName": "John Smith",
"disabled"cancelled": false,
"attributes": {
"startDate": "2021-05-04 00:00:00"
},
"id": 1974296,1861549,
"user"open": "jsmith",true,
"primaryGroup"signalling": false,
"group": "it"true
}Create
To create a GroupUser.TaskInstance.
Request
POST http://<your-domain>/soffid/webservice/scim2/v1/GroupUserJSON
{
"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.
- Note that the attribute id is required to confirm that the resource "...
GroupUser/TaskInstance/<id>" is the same that the JSONGroupUser.TaskInstance. - Note that all the attributes not included in the request will be cleared in the
GroupUserTaskInstance 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
seevisit 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.
Please note after this delete, the account 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 infomationinformation about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response