SCIM RoleAccount examples
Operations
List all
List all GroupUser.RoleAccounts.
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUserRoleAccountResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 25,3530,
"startIndex": 1,
"itemsPerPage": 100,
"Resources": [
{
"groupDescription"certificationDate": "Enterprise"2020-02-13 23:01:44",
"accountSystem": "soffid",
"accountName": "admin",
"userGroupCode": "admingroup",
"approvalPending": false,
"userFullName": "Soffid Administrator",
"bpmEnforced": "S",
"userCode": "admin",
"enabled": true,
"accountId": 103,
"informationSystemName": "Operation/Business 2/SOFFID",
"system": "soffid",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/480412"RoleAccount/110",
"resourceType": "GroupUser"RoleAccount"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"RoleAccount"
],
"start"roleName": "2020-07-02 12:14:48"SOFFID_ADMIN",
"fullName": "test User",
"disabled"removalPending": false,
"attributes"id": {}110,
"roleDescription": "SOFFID Administrator",
"id": 480412,
"user"startDate": "test2",2020-02-13 "primaryGroup": false,
"group": "enterprise"12:00:00"
},
{
"groupDescription"certificationDate": "World2020-12-15 Modified"10:48:44",
"accountSystem": "soffid",
"accountName": "admin",
"userGroupCode": "admingroup",
"approvalPending": false,
"userFullName": "Soffid Administrator",
"bpmEnforced": "N",
"userCode": "admin",
"ruleDescription": "Grants soffid user role to everyone",
"enabled": true,
"accountId": 103,
"informationSystemName": "Operation/Business 2/SOFFID",
"system": "soffid",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"RoleAccount/1059370",
"resourceType": "GroupUser"RoleAccount"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"RoleAccount"
],
"start"roleName": "2020-08-06 15:52:12"SOFFID_USER",
"fullName"removalPending": "test User",
"end": "2021-02-26 13:05:44",
"disabled": true,
"attributes": {},false,
"id": 503629,1059370,
"user"ruleId": 1059365,
"roleDescription": "test2",Soffid "primaryGroup": false,
"group": "world2"
},
{
"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"user",
"startDate": "2021-01-012020-12-15 00:00:00"
},
"id": 1182887,
"user": "jsmith",
"primaryGroup": false,
"group": "admingroup"
},
................
]
}List by filter
List all GroupUsersRoleAccounts with a filter expression.
It is allowed to use pagination and sort the information, for more information visit the SCIM Query parametersSorting page.and Pagination information.
Request
List all GroupUserRoleAccounts with a filter expression.
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser?RoleAccount?filter=groupDescriptionenabled eq "Worldtrue Modified"and system eq soffidResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 4,67,
"startIndex": 1,
"Resources": [
{
"groupDescription"certificationDate": "World2020-02-13 Modified"23:01:44",
"accountSystem": "soffid",
"accountName": "admin",
"userGroupCode": "admingroup",
"approvalPending": false,
"userFullName": "Soffid Administrator",
"bpmEnforced": "S",
"userCode": "admin",
"enabled": true,
"accountId": 103,
"informationSystemName": "Operation/Business 2/SOFFID",
"system": "soffid",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"RoleAccount/110",
"resourceType": "GroupUser"RoleAccount"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"RoleAccount"
],
"start"roleName": "2020-08-06 15:52:12"SOFFID_ADMIN",
"fullName"removalPending": "test User",
"end": "2021-02-26 13:05:44",
"disabled": true,
"attributes": {},false,
"id": 503629,110,
"user"roleDescription": "test2"SOFFID Administrator",
"primaryGroup": false,
"group"startDate": "world2"2020-02-13 12:00:00"
},
{
"groupDescription"certificationDate": "World2020-12-13 Modified"19:30:51",
"accountSystem": "soffid",
"accountName": "gbuades",
"userGroupCode": "enterprise",
"approvalPending": false,
"userFullName": "Gabriel Buades ..",
"bpmEnforced": "S",
"userCode": "gbuades",
"enabled": true,
"accountId": 1039860,
"informationSystemName": "Operation/Business 2/SOFFID",
"system": "soffid",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1519730"RoleAccount/1039866",
"resourceType": "GroupUser"RoleAccount"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"RoleAccount"
],
"start"roleName": "2021-02-20 18:08:23"SOFFID_ADMIN",
"fullName"removalPending": "Dilbert ADAMS .",
"end": "2021-02-20 19:07:45",
"disabled": true,
"attributes": {},false,
"id": 1519730,1039866,
"user"roleDescription": "dilbert"SOFFID Administrator",
"primaryGroup": false,
"group"startDate": "world2"2020-12-13 12:00:00"
},
{
"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 GroupUserRoleAccount by its id (primary key).
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1974296RoleAccount/110Response 200 OK
{
"groupDescription"certificationDate": "Help2020-02-13 desk23:01:44",
support"accountSystem": team""soffid",
"accountName": "admin",
"userGroupCode": "admingroup",
"approvalPending": false,
"userFullName": "Soffid Administrator",
"bpmEnforced": "S",
"userCode": "admin",
"enabled": true,
"accountId": 103,
"informationSystemName": "Operation/Business 2/SOFFID",
"system": "soffid",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1974296"RoleAccount/110",
"resourceType": "GroupUser"RoleAccount"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"RoleAccount"
],
"start"roleName": "2021-05-05 12:49:51"SOFFID_ADMIN",
"fullName": "John Smith",
"disabled"removalPending": false,
"attributes"id": {110,
"roleDescription": "SOFFID Administrator",
"startDate": "2021-05-042020-02-13 00:12:00:00"
},
"id": 1974296,
"user": "jsmith",
"primaryGroup": false,
"group": "it"
}Create
To create a GroupUser.RoleAccount.
Request
POST http://<your-domain>/soffid/webservice/scim2/v1/GroupUserRoleAccountJSON
{
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"RoleAccount"
],
"group": "it",
"groupDescription": "Help desk support team",
"user"accountName": "ckelp",
"fullName"userFullName": "Casey Kelp",
"primaryGroup"informationSystemName": "Operation/Business 2/SOFFID",
"system": "soffid",
"roleName": "SOFFID_ADMIN",
"roleDescription": "SOFFID Administrator",
"bpmEnforced": "N",
"enabled": true,
"attributes"approvalPending": {}false,
"certificationDate": "2021-05-10 12:00:00",
"startDate": "2021-05-10 12:00:00"
}Response 201 Created
{
"groupDescription"certificationDate": "Help2021-05-12 desk07:20:36",
support"accountSystem": team""soffid",
"accountName": "ckelp",
"userGroupCode": "it",
"approvalPending": false,
"userFullName": "Casey Kelp",
"bpmEnforced": "S",
"userCode": "ckelp",
"enabled": true,
"accountId": 1976677,
"informationSystemName": "Operation/Business 2/SOFFID",
"system": "soffid",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741"RoleAccount/1976862",
"resourceType": "GroupUser"RoleAccount"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"RoleAccount"
],
"start"roleName": "SOFFID_ADMIN",
"removalPending": false,
"id": 1976862,
"roleDescription": "SOFFID Administrator",
"startDate": "2021-05-1110 10:39:23",
"fullName": "Casey Kelp",
"disabled": false,
"attributes": {},
"id": 1976741,
"user": "ckelp",
"primaryGroup": true,
"group": "it"12:00:00"
}Update partialpartial
&&TODO&&No funciona
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/1976741RoleAccount/1976862JSON
{
"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
&&TODO&&No funciona
This operation replace all values in the GroupUser.RoleAccount.
- Note that the attribute id is required to confirm that the resource "...
GroupUser/RoleAccount/<id>" is the same that the JSONGroupUser.RoleAccount. - Note that all the attributes not included in the request will be cleared in the
GroupUserRoleAccount type and their data will be lost. - Note that not all the attributes are updatable, for
exampleexample, tag meta, avoid these tags. For more information see Resource data model page
Request
PUT http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1976741RoleAccount/1976862JSON
{
"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
&&TODO&&No funciona
Delete a role.RoleAccount.
Please note after this delete, the accountRoleAccount has to be created again to use it in the next examples.
Request
DELETE http://<your-omain>/soffid/webservice/scim2/v1/GroupUser/1976741RoleAccount/1976862Response 204 No Content
204 No ContentError response
For more infomation about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response