SCIM ProcessDefinition examples
Operations
List all
List all GroupUser.ProcessDefinitions.
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUserProcessDefinitionResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 25,8,
"startIndex": 1,
"Resources": [
{
"groupDescription"author": "Enterprise"admin",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/480412"ProcessDefinition/1474063",
"resourceType": "GroupUser"ProcessDefinition"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessDefinition"
],
"start"name": "2020-07-02User 12:14:48"registration",
"fullName"deployed": "test2021-02-11 User"16:42:08",
"disabled"tag": false,
"attributes": {}27",
"id": 480412,1474063,
"user"version": "test2",27,
"primaryGroup"enabled": false,
"group": "enterprise"true
},
{
"groupDescription"author": "World Modified"admin",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"ProcessDefinition/1857694",
"resourceType": "GroupUser"ProcessDefinition"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessDefinition"
],
"start"name": "2020-08-06User 15:52:12"request",
"fullName": "test User",
"end"deployed": "2021-02-2604-15 13:05:44"16:10:11",
"disabled"tag": true,
"attributes": {}19",
"id": 503629,1857694,
"user"version": "test2",19,
"primaryGroup"enabled": 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 GroupUsersProcessDefinitions 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 GroupUserProcessDefinitions with a filter expression.
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser?ProcessDefinition?filter=groupDescriptionname eqco "World Modified"requestResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 4,2,
"startIndex": 1,
"Resources": [
{
"groupDescription"author": "World Modified"admin",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"ProcessDefinition/1946303",
"resourceType": "GroupUser"ProcessDefinition"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessDefinition"
],
"start"name": "2020-08-06Permissions 15:52:12"request",
"fullName": "test User",
"end"deployed": "2021-02-2604-30 13:05:44"08:48:58",
"disabled"tag": true,
"attributes": {}23",
"id": 503629,1946303,
"user"type": "test2"RoleApproval",
"primaryGroup"version": false,23,
"group"enabled": "world2"true
},
{
"groupDescription"author": "World Modified"admin",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1519730"ProcessDefinition/1857694",
"resourceType": "GroupUser"ProcessDefinition"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessDefinition"
],
"start"name": "User request",
"deployed": "2021-02-2004-15 18:08:23"16:10:11",
"fullName"tag": "Dilbert ADAMS .",
"end": "2021-02-20 19:07:45",
"disabled": true,
"attributes": {}19",
"id": 1519730,1857694,
"user"version": "dilbert",19,
"primaryGroup"enabled": false,
"group": "world2"
},
{
"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"true
}
]
}Query by id
Query a GroupUserProcessDefinition by its id (primary key).
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1974296ProcessDefinition/1857694Response 200 OK
{
"groupDescription"author": "Help desk support team"admin",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1974296"ProcessDefinition/1857694",
"resourceType": "GroupUser"ProcessDefinition"
},
"schemas": [
"urn:soffid:com.soffid.iam.bpm.api.GroupUser"ProcessDefinition"
],
"start"name": "User request",
"deployed": "2021-05-0504-15 12:49:51"16:10:11",
"fullName"tag": "John Smith",
"disabled": false,
"attributes": {
"startDate": "2021-05-04 00:00:00"
}19",
"id": 1974296,1857694,
"user"version": "jsmith",19,
"primaryGroup"enabled": false,
"group": "it"true
}Create
To create a GroupUser.ProcessDefinition.
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/1976741-JSON
{
"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.ProcessDefinition.
- Note that the attribute id is required to confirm that the resource "...
GroupUser/ProcessDefinition/<id>" is the same that the JSONGroupUser.ProcessDefinition. - Note that all the attributes not included in the request will be cleared in the
GroupUserProcessDefinition 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 accountProcessDefinition 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