SCIM Issue examples
Operations
This page shows the operations that can be performed for the issue object.
List all
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/IssueResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 4,
"startIndex": 1,
"Resources": [
{
"performedActions": "2023-06-09 07:17:25 admin Created\n2023-06-09 09:46:54 admin Acknowledged\n",
"acknowledged": "2023-06-09 09:46:54",
"created": "2023-06-09 07:17:25",
"hosts": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/44656",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"description": "Duplicated user bob bobm",
"id": 44656,
"type": "duplicated-user",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bob",
"userId": 3941
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bobm",
"userId": 3971
}
],
"status": "A"
},
{
"acknowledged": "2023-06-09 08:55:49",
"created": "2023-06-09 07:29:25",
"hosts": [],
"description": "Account etaylor@soffid has been locked",
"solved": "2023-06-09 08:56:09",
"type": "locked-account",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "etaylor",
"userId": 3821
}
],
"performedActions": "2023-06-09 07:29:25 $$INTERNAL$$ Created\n2023-06-09 08:49:49 admin User etaylor is disabled\n2023-06-09 08:55:09 admin The account etaylor has been locked\n2023-06-09 08:55:41 admin Notify pgarcia@soffid.com\n2023-06-09 08:55:49 admin Acknowledged\n2023-06-09 08:55:53 admin The account etaylor has been unlocked\n2023-06-09 08:56:09 admin Solved\n",
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/44672",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"id": 44672,
"account": {
"lastLogin": "2023-06-09 07:28:11",
"grantedRoles": [],
"description": "Elizabeth Taylor",
"type": "U",
"lastUpdated": "2023-06-09 08:56:07",
"ownerGroups": [],
"loginName": "etaylor",
"inheritNewPermissions": false,
"disabled": false,
"id": 4994,
"managerGroups": [],
"grantedGroups": [],
"lastPasswordSet": "2023-06-09 07:28:14",
"passwordExpiration": "2024-06-08 07:28:14",
"passwordPolicy": "I",
"accessLevel": "-",
"managerRoles": [],
"created": "2023-06-02 09:14:36",
"hasSnapshot": false,
"system": "soffid",
"ownerRoles": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Account/4994",
"resourceType": "Account"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Account"
],
"name": "etaylor",
"managerUsers": [],
"lastChange": "2023-06-09 08:55:53",
"attributes": {},
"status": "a",
"ownerUsers": [
"etaylor"
],
"grantedUsers": []
},
"status": "S"
},
{
"performedActions": "2023-06-14 06:56:42 admin Created\n",
"created": "2023-06-14 06:56:42",
"hosts": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/56710",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"description": "Duplicated user cdarwin cmartin etaylor",
"id": 56710,
"type": "duplicated-user",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "cdarwin",
"userId": 4037
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "cmartin",
"userId": 3890
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "etaylor",
"userId": 3821
}
],
"status": "N"
},
{
"performedActions": "2023-06-14 07:02:55 admin Created\n",
"created": "2023-06-14 07:02:55",
"hosts": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/56728",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"description": "Duplicated user cdarwin cmartin etaylor",
"id": 56728,
"type": "duplicated-user",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "cdarwin",
"userId": 4037
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "cmartin",
"userId": 3890
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "etaylor",
"userId": 3821
}
],
"status": "N"
}
]
}List by filter
List all Issues with a filter expression.
It is allowed to use pagination and sort the information, for more information visit the Sorting and Pagination information.
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/Issue?filter=type co "locked"Response 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 1,
"startIndex": 1,
"Resources": [
{
"acknowledged": "2023-06-09 08:55:49",
"created": "2023-06-09 07:29:25",
"hosts": [],
"description": "Account etaylor@soffid has been locked",
"solved": "2023-06-09 08:56:09",
"type": "locked-account",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "etaylor",
"userId": 3821
}
],
"performedActions": "2023-06-09 07:29:25 $$INTERNAL$$ Created\n2023-06-09 08:49:49 admin User etaylor is disabled\n2023-06-09 08:55:09 admin The account etaylor has been locked\n2023-06-09 08:55:41 admin Notify pgarcia@soffid.com\n2023-06-09 08:55:49 admin Acknowledged\n2023-06-09 08:55:53 admin The account etaylor has been unlocked\n2023-06-09 08:56:09 admin Solved\n",
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/44672",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"id": 44672,
"account": {
"lastLogin": "2023-06-09 07:28:11",
"grantedRoles": [],
"description": "Elizabeth Taylor",
"type": "U",
"lastUpdated": "2023-06-09 08:56:07",
"ownerGroups": [],
"loginName": "etaylor",
"inheritNewPermissions": false,
"disabled": false,
"id": 4994,
"managerGroups": [],
"grantedGroups": [],
"lastPasswordSet": "2023-06-09 07:28:14",
"passwordExpiration": "2024-06-08 07:28:14",
"passwordPolicy": "I",
"accessLevel": "-",
"managerRoles": [],
"created": "2023-06-02 09:14:36",
"hasSnapshot": false,
"system": "soffid",
"ownerRoles": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Account/4994",
"resourceType": "Account"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Account"
],
"name": "etaylor",
"managerUsers": [],
"lastChange": "2023-06-09 08:55:53",
"attributes": {},
"status": "a",
"ownerUsers": [
"etaylor"
],
"grantedUsers": []
},
"status": "S"
}
]
}Query by id
Query an Issue by its id (primary key).
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/Issue/44656Response 200 OK
{
"performedActions": "2023-06-09 07:17:25 admin Created\n2023-06-09 09:46:54 admin Acknowledged\n",
"acknowledged": "2023-06-09 09:46:54",
"created": "2023-06-09 07:17:25",
"hosts": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/44656",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"description": "Duplicated user bob bobm",
"id": 44656,
"type": "duplicated-user",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bob",
"userId": 3941
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bobm",
"userId": 3971
}
],
"status": "A"
}Create
Request
POST http://<your-domain>/soffid/webservice/scim2/v1/IssueJSON
{
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"type" : "duplicated-user",
"status" : "N",
"created" : "2023-06-19 15:30:00",
"users" : [{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bob",
"userId": 3941
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bobm",
"userId": 3971
}]
}Response 201 Created
{
"actor": "SOFFID_ADMIN@soffid",
"performedActions": "2023-06-21 08:49:22 admin Created\n2023-06-21 08:49:22 admin Executed automatic task start-workflow\n2023-06-21 08:49:22 admin Executed automatic task run-script\n2023-06-21 08:49:22 admin Executed automatic task send-email\n",
"created": "2023-06-21 08:49:22.516",
"hosts": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/167879",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"description": "Duplicated user bob bobm",
"id": 169336,
"type": "duplicated-user",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bob",
"userId": 3941
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bobm",
"userId": 3971
}
],
"status": "N"
}Update partial
Only attributes with changes will be updated, the others will maintain the same value.
Request
PATCH http://<your-domain>/soffid/webservice/scim2/v1/Issue/169336JSON
{
"Operations": [
{
"op": "replace",
"path": "status",
"value": "A"
}
]
}Response 200 OK
{
"performedActions": "2023-06-21 08:54:04 admin Created\n2023-06-21 08:58:59 admin Acknowledged\n",
"acknowledged": "2023-06-21 08:58:59.605",
"created": "2023-06-21 08:54:04",
"hosts": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/169336",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"description": "Duplicated user bobm bob",
"id": 169336,
"type": "duplicated-user",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bobm",
"userId": 3971
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bob",
"userId": 3941
}
],
"status": "A"
}Update all
This operation replaces all values in the Issues.
- Note that the attribute id is required to confirm that the resource "...Issue/<id>" is the same that the JSON Issue.
- Note that all the attributes not included in the request will be cleared in the Issue 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 visit Resource data model page
Request
PUT http://<your-domain>/soffid/webservice/scim2/v1/Issue/169336JSON
{
"performedActions": "2023-06-21 08:54:04 admin Created\n2023-06-21 08:58:59 admin Acknowledged\n",
"acknowledged": "2023-06-21 08:58:59.605",
"created": "2023-06-21 08:54:04",
"hosts": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/169336",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"description": "Duplicated user bobm bob",
"id": 169336,
"type": "duplicated-user",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bobm",
"userId": 3971
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bob",
"userId": 3941
}
],
"status": "S"
}Response 200 OK
{
"performedActions": "2023-06-21 08:54:04 admin Created\n2023-06-21 08:58:59 admin Acknowledged\n",
"acknowledged": "2023-06-21 08:58:59",
"created": "2023-06-21 08:54:04",
"hosts": [],
"meta": {
"location": "http://soffid.35x.lab:8089/soffid/webservice/scim2/v1/Issue/169336",
"resourceType": "Issue"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.Issue"
],
"description": "Duplicated user bobm bob",
"id": 169336,
"type": "duplicated-user",
"users": [
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bobm",
"userId": 3971
},
{
"schemas": [
"urn:soffid:com.soffid.iam.api.IssueUser"
],
"userName": "bob",
"userId": 3941
}
],
"status": "S"
}Delete
Please note after this delete, the issue has to be created again to use it in the next examples.
Request
DELETE http://<your-omain>/soffid/webservice/scim2/v1/Issue/169336Response 204 No Content
204 No ContentError response
For more information about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response