Sample Requests and Responses
This chapter contains a set example based on real world use cases to give an idea how SCIM works. These requests can easily be executed with a software program like Postman.
Get user groups - GET
Request: GET {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups
QueryParameters
count – To limit the number of records being fetched
startIndex – This determines the starting record to be fetched
Response:
{
"itemsPerPage":50,
"startIndex":1,
"totalResults":51,
"schemas":[
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources":[
{
"id":"5",
"displayName":"System administrator",
"members":[],
"meta":{
"location":"{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups",
"resourceType":"Group"
},
"schemas":[
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
},
{
"id":"8",
"displayName":"Planon Solution Bundle",
"members":[],
"meta":{
"location":"{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups",
"resourceType":"Group"
},
"schemas":[
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
}
]
}
Create user group - POST
Request: POST {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"displayName":""
}
Response:
{
"id": "125",
"displayName": "User Group 1",
"members": [],
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups",
"resourceType": "Group"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
}
Remove single user from user group - PATCH
Request: PATCH for group use Id (Syscode)
{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups/34
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:PatchOp"
],
"Operations": [
{
"op": "remove",
"path": "members",
"value": [
{
"value": "EXAMPLEUSER48121"
}
]
}
]
}
Response:
Remove multiple users from user group - PATCH
Request: PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups/34
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:PatchOp"
],
"Operations": [
{
"op": "remove",
"path": "members",
"value": [
{
"value": "EXAMPLEUSERAA1"
},
{
"value": "EXAMPLEUSERAA"
}
]
}
]
}
Response:
Remove user using filter from user group - PATCH
Request: PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups/34
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:PatchOp"
],
"Operations": [
{
"op": "remove",
"path": "members[value eq \"EXAMPLEUSERAA1\"]",
}
]
}
Response:
Remove all users from a user group- PATCH
Request: PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups/34
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:PatchOp"
],
"Operations": [
{
"op": "remove",
"path": "members",
}
]
}
Response:
Replace users in a user group- PATCH
This operation removes all the existing users and adds the users provided in the request
Request: PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Groups/34
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:PatchOp"
],
"Operations": [
{
"op": "replace",
"path": "members",
"value": [
{
"value": "EXAMPLEUSERAA1"
},
{
"value": "EXAMPLEUSERAA"
}
]
}
]
}
Response:
Get User by ID - GET
Request: GET {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/ADAMS
Response:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "ADAMS",
"userName": "ADAMS",
"name": {
"familyName": "Adams",
"givenName": "Harry",
"middleName": null
},
"active": true,
"groups": [
{
"value": "34",
"display": "Requestor"
},
{
"value": "8",
"display": "Planon Solution Bundle"
},
{
"value": "23",
"display": "Accelerator Integrated Services Mgt solution"
},
{
"value": "13",
"display": "Accelerator Asset & Maintenance Mgt solution"
}
],
"userType": "Requestor",
"emails": [
{
"value": "Harry.Adams@planon.co.uk",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "+44 (0) 2075015046",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Columbus Square",
"locality": "London",
"region": "London",
"postalCode": "N6 5TR",
"type": "work",
"primary": true
}
],
"timezone": "Europe/London",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/ADAMS",
"resourceType": "User"
},
"preferredLanguage": "en_US",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "047",
"department": "04",
"costCenter": "040000"
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Harry Adams",
"property": "14B123, Columbus Square",
"position": "24",
"freeValue1": null,
"freeValue2": null,
"freeValue3": null,
"freeValue4": null,
"previousLogInTime": "2025-07-10T06:46:15Z"
}
}
Get User by Username - GET
Request: GET {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users?filter=userName eq GIBBONS
Response:
{
"itemsPerPage": 1,
"startIndex": 1,
"totalResults": 1,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "GIBBONS",
"userName": "GIBBONS",
"name": {
"familyName": "Gibbons",
"givenName": "Peter",
"middleName": null
},
"active": true,
"groups": [
{
"value": "8",
"display": "Planon Solution Bundle"
},
{
"value": "44",
"display": "Developer"
}
],
"userType": "Requestor",
"emails": [
{
"value": "Peter.Gibbons@planon.co.uk",
"type": "work",
"primary": true
}
],
"phoneNumbers": [],
"addresses": [
{
"streetAddress": "Columbus Square",
"locality": "London",
"region": "London",
"postalCode": "N6 5TR",
"type": "work",
"primary": true
}
],
"timezone": "Europe/London",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/GIBBONS",
"resourceType": "User"
},
"preferredLanguage": "en_US",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "156",
"department": "04",
"costCenter": null
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Peter",
"property": "14B123, Columbus Square",
"position": "200",
"freeValue1": null,
"freeValue2": null,
"freeValue3": null,
"freeValue4": null,
"previousLogInTime": "2025-07-10T06:46:15Z"
}
}
]
}
Get All Users - GET
Request: GET {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users?count=50&startIndex=1
QueryParameters
count – To limit the number of records being fetched startIndex – This determines the starting record to be fetched
Response: As example only one user is given.
{
"itemsPerPage": 50,
"startIndex": 1,
"totalResults": 59,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "XXXXX",
"userName": "XXXXX",
"name": {
"familyName": "Noble",
"givenName": "Charlotte",
"middleName": null
},
"active": true,
"groups": [
{
"value": "5",
"display": "System administrator"
},
{
"value": "8",
"display": "Planon Solution Bundle"
},
{
"value": "44",
"display": "Developer"
}
],
"userType": null,
"emails": [
{
"value": "Charlotte.Noble@planon.co.uk",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "+44 (0) 2075016021",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Columbus Square",
"locality": "London",
"region": "London",
"postalCode": "N6 5TR",
"type": "work",
"primary": true
}
],
"timezone": "Europe/London",
"meta": {
"location": "/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/SUPERVISOR",
"resourceType": "User"
},
"preferredLanguage": "en_GB",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{
"employeeNumber": "320",
"department": "01.03",
"costCenter": null
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Xxxxxx",
"property": "14B123, Columbus Square",
"position": null,
"freeValue1": null,
"freeValue2": null,
"freeValue3": null,
"freeValue4": null
}
}
]
}
Create user with employee number, beginDate and manager - POST
Request: POST
{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"userName": "exampleuserAB2X",
"timezone": "Europe/Paris",
"name": {
"familyName": "exampleuserAB2X",
"givenName": "exampleuserAB2X"
},
"emails": [
{
"type": "work",
"value": "user4812.planon@testing.com",
"primary": true
}
],
"phoneNumbers": [
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Columbus Square",
"locality": "London",
"region": "London",
"postalCode": "N6 5TR",
"type": "work",
"primary": true
}
],
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User",
"freeValue1": "hello world",
"position": "Project manager",
"beginDate": "2015-10-31T00:00:00Z"
},
"userType": "Requestor",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "701984AB2",
"costCenter": "4130",
"manager": {
"value": "SUPERVISOR"
}
}
}
Response:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "EXAMPLEUSERAB2X",
"userName": "EXAMPLEUSERAB2X",
"name": {
"familyName": "exampleuserAB2X",
"givenName": "exampleuserAB2X",
"middleName": null
},
"active": true,
"groups": [
{
"value": "34",
"display": "Requestor"
}
],
"userType": "Requestor",
"emails": [
{
"value": "user4812.planon@testing.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [],
"timezone": "Europe/Paris",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/EXAMPLEUSERAB2X",
"resourceType": "User"
},
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "701984AB2",
"department": null,
"costCenter": null,
"manager": {
"value": "MEASE"
}
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User",
"property": null,
"position": "Project manager",
"propertySet": "BP",
"beginDate": "2015-10-31T00:00:00Z",
"endDate": null,
"freeValue1": "hello world",
"freeValue2": null,
"freeValue3": null,
"freeValue4": null,
"freeValue5": null,
"freeValue6": null,
"freeValue7": null,
"freeValue8": null
}
}
Update User data - PUT
Request: PUT {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/EXAMPLEUSERAB3XXA
Request:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"userName": "exampleuserAB3XXA",
"timezone": "Europe/Amsterdam",
"name": {
"familyName": "exampleuserAB3XXA",
"givenName": "exampleuserAB3XXA"
},
"emails": [
{
"type": "work",
"value": "user4812xx.planon@testing.com",
"primary": true
}
],
"phoneNumbers": [
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Columbus Square",
"locality": "London",
"region": "London",
"postalCode": "N6 5TR",
"type": "work",
"primary": true
}
],
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User exampleuserAB3XXA",
"freeValue1": "hello world",
"position": "Project manager"
},
"userType": "Requestor",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "P000000518",
"costCenter": "4130"
}
}
Response:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "EXAMPLEUSERAB3XXA",
"userName": "EXAMPLEUSERAB3XXA",
"name": {
"familyName": "exampleuserAB3XXA",
"givenName": "exampleuserAB3XXA",
"middleName": null
},
"active": true,
"groups": [
{
"value": "34",
"display": "Requestor"
}
],
"userType": "Requestor",
"emails": [
{
"value": "user4812xx.planon@testing.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Columbus Square",
"locality": "London",
"region": "London",
"postalCode": "N6 5TR",
"type": "work",
"primary": true
}
],
"timezone": "Europe/Amsterdam",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/EXAMPLEUSERAB3XXA",
"resourceType": "User"
},
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "P000000518",
"department": null,
"costCenter": null
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User exampleuserAB3XXA",
"property": "14B123, Columbus Square",
"position": null,
"freeValue1": null,
"freeValue2": null,
"freeValue3": null,
"freeValue4": null
}
}
Update User data - PATCH
Request: PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/EXAMPLEUSERAB3XXA
Request:
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "replace",
"value": {
"name": {
"givenName": "exampleuser9l"
}
}
},
{
"op": "replace",
"value": {
"emails": [
{
"type": "work",
"value": "test236.planon@testing.com",
"primary": true
}
]
}
},
{
"op": "replace",
"value": {
"addresses": [
{
"streetAddress": "Braintree Hill Park",
"locality": "Braintree",
"postalCode": "MA 02184",
"type": "work",
"primary": true
}
]
}
},
{
"op": "replace",
"path": "phoneNumbers[type eq \"mobile\"].value",
"value": "123-456-7890"
}
]
}
Response:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "EXAMPLEUSERAB3XXA",
"userName": "EXAMPLEUSERAB3XXA",
"name": {
"familyName": "exampleuserAB3XXA",
"givenName": "exampleuser9l",
"middleName": null
},
"active": true,
"groups": [
{
"value": "34",
"display": "Requestor"
}
],
"userType": "Requestor",
"emails": [
{
"value": "test236.planon@testing.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Braintree Hill Park",
"locality": "Braintree",
"region": null,
"postalCode": "MA 02184",
"type": "work",
"primary": true
}
],
"timezone": "Europe/Amsterdam",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/EXAMPLEUSERAB3XXA",
"resourceType": "User"
},
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "P000000518",
"department": null,
"costCenter": null
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User exampleuserAB3XXA",
"property": "12, Braintree Hill Park",
"position": null,
"freeValue1": null,
"freeValue2": null,
"freeValue3": null,
"freeValue4": null
}
}
Add person link – PATCH
Request PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/CAMATEST@TEST.COM
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Add",
"path": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber",
"value": "004"
}
]
}
Response:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "CAMATEST@TEST.COM",
"userName": "CAMATEST@TEST.COM",
"name": {
"familyName": "exampleuser99",
"givenName": "exampleuser99X",
"middleName": null
},
"active": true,
"groups": [
{
"value": "34",
"display": "Requestor"
}
],
"userType": "Requestor",
"emails": [
{
"value": "user4812.planon@testing.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "123",
"type": "mobile"
},
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Wijchenseweg",
"locality": "Nijmegen",
"region": null,
"postalCode": "6537TL",
"type": "work",
"primary": true
}
],
"timezone": "Europe/Paris",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/CAMATEST@TEST.COM",
"resourceType": "User"
},
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "004",
"department": "Corporate Real Estate",
"costCenter": "Corporate Real Estate",
"manager": {
"value": "MEASE"
}
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User",
"property": "14",
"position": "Project manager",
"propertySet": "BP",
"beginDate": "2022-11-21T00:00:00Z",
"endDate": null,
"freeValue1": "hello world",
"freeValue2": null,
"freeValue3": null,
"freeValue4": null,
"freeValue5": null,
"freeValue6": null,
"freeValue7": null,
"freeValue8": null
}
}
Inactivate User – PATCH
Request PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/CAMATEST@TEST.COM
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Replace",
"path": "active",
"value": false
}
]
}
Response:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "CAMATEST@TEST.COM",
"userName": "CAMATEST@TEST.COM",
"name": {
"familyName": "exampleuser99",
"givenName": "exampleuser99X",
"middleName": null
},
"active": false,
"groups": [
{
"value": "34",
"display": "Requestor"
}
],
"userType": "Requestor",
"emails": [
{
"value": "user4812.planon@testing.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "123",
"type": "mobile"
},
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Wijchenseweg",
"locality": "Nijmegen",
"region": null,
"postalCode": "6537TL",
"type": "work",
"primary": true
}
],
"timezone": "Europe/Paris",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/CAMATEST@TEST.COM",
"resourceType": "User"
},
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "004",
"department": "Corporate Real Estate",
"costCenter": "Corporate Real Estate",
"manager": {
"value": "MEASE"
}
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User",
"property": "14",
"position": "Project manager",
"propertySet": "BP",
"beginDate": "2022-11-21T00:00:00Z",
"endDate": null,
"freeValue1": "hello world",
"freeValue2": null,
"freeValue3": null,
"freeValue4": null,
"freeValue5": null,
"freeValue6": null,
"freeValue7": null,
"freeValue8": null
}
}
Activate User – PATCH
In this case, the link between person and active exists.
Request PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/CAMATEST@TEST.COM
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Replace",
"path": "active",
"value": true
}
]
}
Response:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "CAMATEST@TEST.COM",
"userName": "CAMATEST@TEST.COM",
"name": {
"familyName": "exampleuser99",
"givenName": "exampleuser99X",
"middleName": null
},
"active": true,
"groups": [
{
"value": "34",
"display": "Requestor"
}
],
"userType": "Requestor",
"emails": [
{
"value": "user4812.planon@testing.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "123",
"type": "mobile"
},
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Wijchenseweg",
"locality": "Nijmegen",
"region": null,
"postalCode": "6537TL",
"type": "work",
"primary": true
}
],
"timezone": "Europe/Paris",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/CAMATEST@TEST.COM",
"resourceType": "User"
},
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "004",
"department": "Corporate Real Estate",
"costCenter": "Corporate Real Estate",
"manager": {
"value": "MEASE"
}
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User",
"property": "14",
"position": "Project manager",
"propertySet": "BP",
"beginDate": "2022-11-21T00:00:00Z",
"endDate": null,
"freeValue1": "hello world",
"freeValue2": null,
"freeValue3": null,
"freeValue4": null,
"freeValue5": null,
"freeValue6": null,
"freeValue7": null,
"freeValue8": null
}
}
Activate User and link a person – PATCH
In this case, the link between person and active does not exists. So the patch request should contain the employee number to find the existing person in Planon and link it to the user.
Request PATCH {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/CAMATEST@TEST.COM
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Replace",
"path": "active",
"value": true
}, {
"op": "Replace",
"path": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber",
"value": "P000000563"
}
]
}
Response:
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:ietf:params:scim:schemas:extension:planon:2.0:User"
],
"id": "CAMATEST@TEST.COM",
"userName": "CAMATEST@TEST.COM",
"name": {
"familyName": "exampleuser99",
"givenName": "exampleuser99X",
"middleName": null
},
"active": true,
"groups": [
{
"value": "34",
"display": "Requestor"
}
],
"userType": "Requestor",
"emails": [
{
"value": "user4812.planon@testing.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "123",
"type": "mobile"
},
{
"value": "+44 (0) 2075015000",
"type": "work"
}
],
"addresses": [
{
"streetAddress": "Wijchenseweg",
"locality": "Nijmegen",
"region": null,
"postalCode": "6537TL",
"type": "work",
"primary": true
}
],
"timezone": "Europe/Paris",
"meta": {
"location": "{{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/CAMATEST@TEST.COM",
"resourceType": "User"
},
"preferredLanguage": "nl_NL",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "P000000563",
"department": "Corporate Real Estate",
"costCenter": "Corporate Real Estate",
"manager": {
"value": "MEASE"
}
},
"urn:ietf:params:scim:schemas:extension:planon:2.0:User": {
"userDescription": "Example User",
"property": "14",
"position": "Project manager",
"propertySet": "BP",
"beginDate": "2022-11-21T00:00:00Z",
"endDate": null,
"freeValue1": "hello world",
"freeValue2": null,
"freeValue3": null,
"freeValue4": null,
"freeValue5": null,
"freeValue6": null,
"freeValue7": null,
"freeValue8": null
}
}
Delete User – DELETE
Request: *DELETE* {{baseUrl}}/sdk/platform/jaxrs/planonsoftware/apps/scimuserprovisioning/scim/v2/Users/EXAMPLEUSERAB3XXA
Response: