Skip to main content

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

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
GET https://<your-domain>/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.InformationSystem
Response 200 OK
{
  "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 page

Back to top