# Resource data model & schema
The data model of the Soffid objects is mapped to JSON objects to enable the data transport between client and server.
# User resource
## /User
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/base/api/User.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/base/api/User.html)
Soffid allows you to add customized data to the user object. You can do that on metadata, on the proper object.
- Main Menu > Configuration > Global Settings > Metadata
## Query schema
It is allowed to consult all the User definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.base.api.User
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.base.api.User",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "User",
"description": "User object",
"attributes": [
{
"uniqueness": "none",
"name": "userName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "firstName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "lastName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "middleName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "fullName",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "userType",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "primaryGroup",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "homeServer",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "profileServer",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "emailAddress",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "mailAlias",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "mailServer",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "active",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "multiSession",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "comments",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "modifiedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "modifiedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"subattributes": [
{
"uniqueness": "none",
"name": "avatar",
"description": "Avatar",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"uniqueness": "none",
"name": "attributes",
"description": "Custom attributes",
"mutability": "readWrite",
"type": "complex",
"returned": "default",
"multiValued": false
},
{
"subattributes": [
{
"uniqueness": "none",
"name": "domain",
"description": "Password domain to be changed. By default, the DEFAULT domain is changed",
"mutability": "writeOnly",
"type": "string",
"caseExact": true,
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "value",
"description": "The password itself, in clear text",
"mutability": "writeOnly",
"type": "string",
"caseExact": true,
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "expired",
"description": "If not set to false, the user will be prompted to change it on next logon",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"multiValued": false,
"required": false
}
],
"uniqueness": "none",
"name": "password",
"description": "Change current user password",
"mutability": "writeOnly",
"type": "complex",
"caseExact": true,
"multiValued": true,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.base.api.User"
}
```
## Full JSON example
Visit [SCIM User examples](https://bookstack.soffid.com/books/scim/page/scim-user-examples "SCIM User examples") page
# Group resource
## /Group
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/Group.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/Group.html)
Soffid allows you to add customized data to the group object. You can do that on the metadata option:
- Main Menu > Configuration > Global Settings > Metadata
## Query Schema
It is allowed to consult all the Group definitions using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.Group
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.Group",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "Group",
"description": "Group object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "driveLetter",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "parentGroup",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "type",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "driveServerName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "obsolete",
"mutability": "readOnly",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "startDate",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "endDate",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.Group"
}
```
## Full JSON example
Visit [SCIM Group examples](https://bookstack.soffid.com/books/scim/page/scim-group-examples "SCIM Group examples") page
# Account resource
## /Account
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/base/api/Account.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/base/api/Account.html)
Soffid allows you to add customized data to the Account object. You can do that on metadata option:
- Main Menu > Configuration > Global Settings > Metadata
## Query Schema
It is allowed to consult all the Account definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.base.api.Account
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.base.api.Account",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "Account",
"description": "Account object",
"attributes": [
{
"uniqueness": "none",
"name": "system",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "loginName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "type",
"canonicalValues": [
"U",
"S",
"P",
"I"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "status",
"canonicalValues": [
"a",
"FA",
"l",
"d",
"FD",
"r",
"x"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "credentialType",
"canonicalValues": [
"PASS",
"SSH",
"KUBE"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "passwordPolicy",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "ownerGroups",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "ownerUsers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "ownerRoles",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "managerGroups",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "managerUsers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "managerRoles",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "grantedGroups",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "grantedUsers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "grantedRoles",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "serverType",
"canonicalValues": [
"Windows",
"Linux",
"Database"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "serverName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "sshPublicKey",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "vaultFolderId",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "inheritNewPermissions",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "loginUrl",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "launchType",
"canonicalValues": [
"S",
"W",
"P"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "jumpServerGroup",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "externalId",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "lastLogin",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "lastUpdated",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "lastPasswordSet",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "passwordExpiration",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "lockedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "passwordStatus",
"canonicalValues": [
"PASSWORD_GOOD",
"PASSWORD_WRONG",
"PASSWORD_GOOD_EXPIRED"
],
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "created",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "lastChange",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"subattributes": [
{
"uniqueness": "none",
"name": "value",
"description": "The password itself, in clear text",
"mutability": "writeOnly",
"type": "string",
"caseExact": true,
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "expired",
"description": "If not set to false, the user will be prompted to change it on next logon",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"multiValued": false,
"required": false
}
],
"uniqueness": "none",
"name": "password",
"description": "Change current account password",
"mutability": "writeOnly",
"type": "complex",
"caseExact": true,
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "attributes",
"mutability": "readWrite",
"type": "complex",
"caseExact": true,
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.base.api.Account"
}
```
## Full JSON example
Visit [SCIM Account examples](https://bookstack.soffid.com/books/scim/page/scim-account-examples "SCIM Account examples") page
# Application resource
## /Application (addon version 1.2.0+)
### Dictionary table
The diagram service model of the object : [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/InformationSystem.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/InformationSystem.html)
Soffid allows you to add customized data to the Application object (System Information). You can do that on metadata option:
- Main Menu > Configuration > Global Settings > Metadata
## Query Schema
It is allowed to consult all the Application definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.InformationSystem
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.InformationSystem",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "Application",
"description": "Application object",
"attributes": [
{
"uniqueness": "none",
"name": "type",
"canonicalValues": [
"container",
"application",
"business"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "parent",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "relativeName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "owner",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "sourceDir",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "targetDir",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "database",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "bpmEnabled",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "notificationEmails",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "approvalProcess",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "roleDefinitionProcess",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "singleRole",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.InformationSystem"
}
```
## Full JSON example
Visit [SCIM Application examples](https://bookstack.soffid.com/books/scim/page/scim-application-examples-informationsystem "SCIM Application examples") page
# Role resource
## /Role (addon version 1.2.0+)
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/Role.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/Role.html)
Soffid allows you to add customized data to the Role object. You can do that on metadata option:
- Main Menu > Configuration > Global Settings > Metadata
## Query schema
It is allowed to consult all the Role definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.Role
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.Role",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "Role",
"description": "Role object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "system",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "category",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "informationSystemName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "domainType",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "bpmEnabled",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "externalId",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "approvalStart",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "approvalEnd",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.Role"
}
```
## Full JSON example
Visit[ SCIM Role examples](https://bookstack.soffid.com/books/scim/page/scim-role-examples "SCIM Role examples") page
# Group type resource
## /GroupType
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/cohttps://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/GroupType.htmlnsole/latest/uml/com/soffid/iam/api/OUType.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/GroupType.html)
## Query Schema
It is allowed to consult all the Group Type definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.GroupType
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.GroupType",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "OUType",
"description": "OUType object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "roleHolder",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.GroupType"
}
```
## Full JSON example
Visit [SCIM Group type examples](https://bookstack.soffid.com/books/scim/page/scim-group-type-examples "SCIM Group type examples") page
# User type resource
## /UserType
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/UserType.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/UserType.html)
## Query Schema
It is allowed to consult all the User Type definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.UserType
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.UserType",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "UserType",
"description": "UserType object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "managed",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.UserType"
}
```
## Full JSON example
Visit [SCIM User type examples](https://bookstack.soffid.com/books/scim/page/scim-user-type-examples "SCIM User type examples") page
# GroupUser resource
## /UserGroup
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/UserGroup.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/UserGroup.html)
Soffid allows you to add customized data to the GroupUser object. You can do that on metadata option:
- Main Menu > Configuration > Global Settings > Metadata
## Query Schema
It is allowed to consult all the GroupUser definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.UserGroup
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.UserGroup",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "GroupUser",
"description": "GroupUser object",
"attributes": [
{
"uniqueness": "none",
"name": "user",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "group",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.UserGroup"
}
```
## Full JSON example
Visit [SCIM GroupUser examples](https://bookstack.soffid.com/books/scim/page/scim-groupuser-examples "SCIM GroupUser examples") page
# RoleAccount resource
## /RoleAccount
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/RoleAccount.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/RoleAccount.html)
## Query Schema
It is allowed to consult all the RoleAccount definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.RoleAccount
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.RoleAccount",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "RoleAccount",
"description": "RoleAccount object",
"attributes": [
{
"uniqueness": "none",
"name": "id",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "accountName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "accountSystem",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "roleName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "domainValue",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "system",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "userName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "startDate",
"mutability": "readWrite",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "endDate",
"mutability": "readWrite",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "holderGroup",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "certificationDate",
"mutability": "readWrite",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "externalId",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.RoleAccount"
}
```
## Full JSON example
Visit [SCIM RoleAccount examples](https://bookstack.soffid.com/books/scim/page/scim-roleaccount-examples "SCIM RoleAccount examples") page
# Host resource
## /Host
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/am/api/Host.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/am/api/Host.html)
Soffid allows you to add customized data to the user object. You can do that on metadata, on the proper object.
- Main Menu > Configuration > Global Settings > Metadata
## Query Schema
It is allowed to consult all the Host definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.am.api.Host
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.am.api.Host",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "Host",
"description": "Host object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "network",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "ip",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "dynamicIp",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "mail",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "folders",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "mac",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "printersServer",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "serialNumber",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "os",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "hostAlias",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "dhcp",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "lastSeen",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "created",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "locked",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"subattributes": [
{
"uniqueness": "none",
"name": "device",
"description": "Device type",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "detectedOs",
"description": "Operating system",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "browser",
"description": "Internet browser",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "cpu",
"description": "CPU type",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"uniqueness": "none",
"name": "attributes",
"description": "Custom attributes",
"mutability": "readWrite",
"type": "complex",
"returned": "default",
"multiValued": false
}
],
"id": "urn:soffid:com.soffid.iam.am.api.Host"
}
```
## Full JSON example
Visit [SCIM Host examples](https://bookstack.soffid.com/books/scim/page/scim-host-examples "SCIM Host examples") page
# MailList resource
## /MailList
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/MailList.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/MailList.html)
Soffid allows you to add customized data to the user object. You can do that on metadata, on the proper object.
- Main Menu > Administration > Configure Soffid > Global Settings > Metadata
## Query Schema
It is allowed to consult all the MailList definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.MailList
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.MailList",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "MailList",
"description": "MailList object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "domainName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "lists",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "externalList",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "roleMembers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "groupMembers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "usersList",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "listsBelong",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "explodedUsersList",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.MailList"
}
```
## Full JSON example
Visit [SCIM MailList examples](https://bookstack.soffid.com/books/scim/page/scim-maillist-examples "SCIM MailList examples") page.
# MailDomain resource
## /MailDomain
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/MailDomain.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/MailDomain.html)
## Query Schema
It is allowed to consult all the MailDomain definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.MailDomain
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.MailDomain",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "MailDomain",
"description": "MailDomain object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "id",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "obsolete",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.MailDomain"
}
```
### Full JSON example
Visit [SCIM MailDomain examples](https://bookstack.soffid.com/books/scim/page/scim-maildomain-examples "SCIM MailDomain examples") page.
# Network resource
## /Network
## Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/am/api/Network.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/am/api/Network.html)
## Query Schema
It is allowed to consult all the Network definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.am.api.Network
```
##### Response 200
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.am.api.Network",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "Network",
"description": "Network object",
"attributes": [
{
"uniqueness": "none",
"name": "id",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "ip",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "mask",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "type",
"canonicalValues": [
"l",
"w",
"e"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "lanAccess",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "dhcp",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "dhcpSupport",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "loginRestriction",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "discovery",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "discoveryServer",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "discoveryRanges",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "countryCode",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.am.api.Network"
}
```
### Full JSON example
Visit [SCIM Network examples](https://bookstack.soffid.com/books/scim/page/scim-network-examples "SCIM Network examples") page.
# DomainValue resource
## /DomainValue
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/DomainValue.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/DomainValue.html)
## Query Schema
It is allowed to consult all the DomainValue definition using the Schema query:
##### Request
```XML
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.DomainValue
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.DomainValue",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "DomainValue",
"description": "DomainValue object",
"attributes": [
{
"uniqueness": "none",
"name": "id",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "value",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "domainName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "informationSystemName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.DomainValue"
}
```
## Full JSON example
Visit[ SCIM DomainValue examples](https://bookstack.soffid.com/books/scim/page/scim-domainvalue-examples "SCIM DomainValue examples") page.
# VaultFolder resource
## /VaultFolder
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/am/api/VaultFolder.html](https://download.soffid.com/doc/console/latest/uml/com/soffid/iam/api/VaultFolder.htmlhttps://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/am/api/VaultFolder.html)
## Query Schema
It is allowed to consult all the VaultFolder definitions using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.am.api.VaultFolder
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.am.api.VaultFolder",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "VaultFolder",
"description": "VaultFolder object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "parentFolder",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "grantedGroups",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "grantedUsers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "grantedRoles",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "managerGroups",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "managerUsers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "managerRoles",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "ownerGroups",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "ownerUsers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "ownerRoles",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "navigateGroups",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "navigateUsers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "navigateRoles",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "accessLevel",
"canonicalValues": [
"N",
"U",
"M",
"O",
"-"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "pamPolicy",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.am.api.VaultFolder"
}
```
## Full JSON example
Visit [SCIM VaultFolder examples](https://bookstack.soffid.com/books/scim/page/scim-vaultfolder-examples "SCIM VaultFolder examples") page.
# System resource
## /System
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/System.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/System.html)
## Query Schema
It is allowed to consult all the System definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.System
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.System",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "System",
"description": "System object",
"attributes": [
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "className",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "url",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "url2",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "rolebased",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "trusted",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "userTypes",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "manualAccountCreation",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "fullReconciliation",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "generateTasksOnLoad",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "groupsList",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "accessControl",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "passwordsDomainId",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "passwordsDomain",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "usersDomain",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "readOnly",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "pause",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "authoritative",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "timeStamp",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "created",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "authoritativeProcess",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "sharedDispatcher",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "threads",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "timeout",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "longTimeout",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "usage",
"canonicalValues": [
"IAM",
"PAM",
"SSE"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "deltaChanges",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "removeRolesFromDisabledAccounts",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createDisabledAccounts",
"mutability": "readWrite",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.System"
}
```
## Full JSON example
Visit [SCIM System examples](https://bookstack.soffid.com/books/scim/page/scim-system-examples "SCIM System examples") page.
# CustomObject resource
## /CustomObject
## Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/CustomObject.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/iga/api/CustomObject.html)
## Query Schema
It is allowed to consult all the CustomObject definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.CustomObject
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.CustomObject",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "CustomObject",
"description": "CustomObject object",
"attributes": [
{
"uniqueness": "none",
"name": "id",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "name",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "type",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "attributes",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.iga.api.CustomObject"
}
```
## Full JSON example
Visit [SCIM CustomObject examples](https://bookstack.soffid.com/books/scim/page/scim-customobject-examples "SCIM CustomObject examples") page.
# ProcessDefinition resource
## /ProcessDefinition
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/bpm/api/ProcessDefinition.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/bpm/api/ProcessDefinition.html)
## Query Schema
It is allowed to consult all the ProcessDefinition definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "ProcessDefinition",
"description": "ProcessDefinition object",
"attributes": [
{
"uniqueness": "none",
"name": "version",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "tag",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "name",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "server",
"name": "id",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "enabled",
"mutability": "readOnly",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "appliesTo",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "type",
"mutability": "readOnly",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "deployed",
"mutability": "readOnly",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "author",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.bpm.api.ProcessDefinition"
}
```
## Full JSON example
Visit [SCIM ProcessDefinition examples](https://bookstack.soffid.com/books/scim/page/scim-processdefinition-examples "SCIM ProcessDefinition examples") page.
# ProcessInstance resource
## /ProcessInstance
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/bpm/api/ProcessInstance.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/bpm/api/ProcessInstance.html)
## QUery Schema
It is allowed to consult all the ProcessInstance definitions using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.ProcessInstance
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.ProcessInstance",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "ProcessInstance",
"description": "ProcessInstance object",
"attributes": [
{
"uniqueness": "server",
"name": "id",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "start",
"mutability": "readOnly",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "end",
"mutability": "readOnly",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "variables",
"mutability": "readWrite",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "currentTask",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "comments",
"mutability": "readWrite",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "processDefinition",
"mutability": "immutable",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "dummyProcess",
"mutability": "readOnly",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "transition",
"mutability": "writeOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.bpm.api.ProcessInstance"
}
```
### Full JSON example
Visit [SCIM ProcessInstance examples](https://bookstack.soffid.com/books/scim/page/scim-processinstance-examples "SCIM ProcessInstance examples") page.
# TaskInstance resource
## /TaskInstance
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/bpm/api/TaskInstance.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/bpm/api/TaskInstance.html)
## Query Schema
It is allowed to consult all the TaskInstance definition using the Schema query:
##### Request
```MarkDown
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.TaskInstance
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.bpm.api.TaskInstance",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "TaskInstance",
"description": "TaskInstance object",
"attributes": [
{
"uniqueness": "server",
"name": "id",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "processName",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "server",
"name": "processId",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "processDefinition",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "dummyTask",
"mutability": "readOnly",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "name",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "actorId",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "create",
"mutability": "readOnly",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "start",
"mutability": "readOnly",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "end",
"mutability": "readOnly",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "dueDate",
"mutability": "readOnly",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "priority",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "cancelled",
"mutability": "readOnly",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "open",
"mutability": "readOnly",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "signalling",
"mutability": "readOnly",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "blocking",
"mutability": "readOnly",
"type": "boolean",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "swimlane",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "pooledActors",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "variables",
"mutability": "readWrite",
"type": "complex",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "transitions",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "transition",
"mutability": "writeOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.bpm.api.TaskInstance"
}
```
## Full JSON example
Visit [SCIM TaskInstance examples](https://bookstack.soffid.com/books/scim/page/scim-taskinstance-examples "SCIM TaskInstance examples") page.
# Issue resource
## /Issue
### Dictionary table
The diagram service model of the object: [https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/rc/api/Issue.html](https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/rc/api/Issue.html)
## Query Schema
It is allowed to consult all the Issue definition using the Schema query:
##### Request
```shell
GET https:///soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.rc.api.Issue
```
##### Response 200 OK
```JSON
{
"meta": {
"location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.rc.api.Issue",
"resourceType": "Schema"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"name": "Issue",
"description": "Issue object",
"attributes": [
{
"uniqueness": "none",
"name": "number",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "requester",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "type",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "description",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "times",
"mutability": "readOnly",
"type": "integer",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "status",
"canonicalValues": [
"N",
"A",
"S",
"D"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": true
},
{
"uniqueness": "none",
"name": "failedLoginPct",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "humanConfidence",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "system",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "otpDevice",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "exception",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "risk",
"canonicalValues": [
"L",
"H",
"F",
"N"
],
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "roleAccount",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "rule",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "jobName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "ip",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "country",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "account",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "loginName",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "hosts",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "browsers",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "users",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": true,
"required": false
},
{
"uniqueness": "none",
"name": "breachedEmail",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "dataBreach",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "htmlDescription",
"mutability": "readWrite",
"type": "binary",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "created",
"mutability": "readWrite",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "acknowledged",
"mutability": "readWrite",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "solved",
"mutability": "readWrite",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "actor",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "performedActions",
"mutability": "readWrite",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "updatedBy",
"mutability": "readOnly",
"type": "string",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
},
{
"uniqueness": "none",
"name": "createdOn",
"mutability": "readOnly",
"type": "dateTime",
"caseExact": true,
"returned": "default",
"multiValued": false,
"required": false
}
],
"id": "urn:soffid:com.soffid.iam.rc.api.Issue"
}
```
## Full JSON example
Visit [SCIM Issue examples](https://bookstack.soffid.com/books/scim/page/scim-issue-examples) page