SCIM Application examples
Operations
List all
List all applications.
GET http://<domain>/webservice/scim2/v1/Application
HTTP 200
{
"totalResults": 3,
"resources": [
{
"description": "AD",
"singleRole": false,
"bpmEnforced": false,
"database": "ad",
"meta": {
"location": "http://<domain>/webservice/scim2/v1/Application/1573127",
"resourceType": "Application"
},
"name": "ad",
"attributes": {},
"id": 1573127
},
{
"description": "Test linux host",
"singleRole": false,
"bpmEnforced": true,
"database": "LinuxHost",
"meta": {
"location": "http://<domain>/webservice/scim2/v1/Application/1623994",
"resourceType": "Application"
},
"name": "LINUX",
"attributes": {},
"id": 1623994
},
{
"description": "SOFFID Identity Manager",
"singleRole": true,
"bpmEnforced": false,
"database": "",
"meta": {
"location": "http//<domain>/webservice/scim2/v1/Application/28",
"resourceType": "Application"
},
"name": "SOFFID",
"attributes": {
"owner": [
"ppig"
]
},
"id": 28
}
]
}
Retrieve by id
RetriveRetrieve by its id (primary key). For instance, the admin user listed previously.
GET http://<domain>/webservice/scim2/v1/Application/28
HTTP 200
{
"description": "SOFFID Identity Manager",
"singleRole": true,
"bpmEnforced": false,
"database": "",
"meta": {
"location": "http://<domain>/webservice/scim2/v1/Application/28",
"resourceType": "Application"
},
"name": "SOFFID",
"attributes": {
"owner": [
"ppig"
]
},
"id": 28
}
List by filter
List all application with a filter expression. For example, one can search roles for system SOFFID.
GET http://<domain>/webservice/scim2/v1/Application?filter=name eq "SOFFID"
HTTP 200
{
"totalResults": 1,
"resources": [
{
"description": "SOFFID Identity Manager",
"singleRole": true,
"bpmEnforced": false,
"database": "",
"meta": {
"location": "http://<domain>/webservice/scim2/v1/Application/28",
"resourceType": "Application"
},
"name": "SOFFID",
"attributes": {
"owner": [
"ppig"
]
},
"id": 28
}
]
}
Create
One may create a role. This role will be used for the following examples.
POST http://<domain>/webservice/scim2/v1/Application
Put the user JSON in the body of the request:
{
"description": "Test application",
"singleRole": true,
"bpmEnforced": false,
"name": "test app",
"attributes": {
"owner": [
"ppig"
]
}
}
HTTP 201
{
"description": "Test application",
"singleRole": true,
"bpmEnforced": false,
"meta": {
"location": "http://<domain>/webservice/scim2/v1/Application/2236428",
"resourceType": "Application"
},
"name": "test app",
"attributes": {
"owner": [
"ppig"
]
},
"id": 2236428
}
Update partial
Update only the attributes with changes, only these attributes will be updated in the user, the rest will maintain the same value.
PATCH http://<domain>/webservice/scim2/v1/Application/2236428
Put the user JSON in the body of the request:
{
"description": "SOFFID test role (modified)"
}
HTTP 200
{
"description": "Test application (modified 2)",
"singleRole": false,
"bpmEnforced": false,
"meta": {
"location": "http://<domain>/webservice/scim2/v1/Application/2236428",
"resourceType": "Application"
},
"name": "test app",
"attributes": {
"owner": [
"ppig"
]
},
"id": 2236428
}
Update all
This operation replaces all values in the user. For example we will update nationalID.
- Note that the attribute id is required to confirm that the resource "...User/<id>" is the same that the JSON user.
- Note that all the attributes not included in the request will be cleared in the user and their data will be lost.
- Note that not all the attributes are updatable, for example tag meta, avoid these tags. For more information see Resource data model page.
PUT http://<domain>/webservice/scim2/v1/Application/2236428
Put the user JSON in the body of the request:
{
"description": "Test application",
"singleRole": true,
"bpmEnforced": false,
"name": "test app",
"attributes": {
"owner": [
"ppig"
]
}
}
HTTP 200
{
"description": "Test application (modified2 )",
"singleRole": false,
"bpmEnforced": false,
"meta": {
"location": "http://<domain>/webservice/scim2/v1/Application/2236428",
"resourceType": "Application"
},
"name": "test app",
"attributes": {
"owner": [
"ppig"
]
},
"id": 2236428
}
Delete
Delete a user and its relations (groups, accounts, attributes, secondary groups, etc).
- Please note that after this delete action, you will need to create again the user to use it in the next examples.
DELETE http://<domain>/webservice/scim2/v1/Application/2236428
HTTP 204