Skip to main content

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

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


Back to top