Skip to main content

Host resource data model

/Host

Dictionary table

The diagram service model of the object: http://www.soffid.org/doc/console/2.9.0/uml/com/soffid/iam/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 > Administration > Configure Soffid > Global Settings > Metadata

Query Schema

It is allowed to consult all the Host definition using the Schema query:

GET http://<your-domain>/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.api.Host

Full JSON example

Request

GET http://<your-domain>/webservice/scim2/v1/Host/1793068

Response 200 OK

{
    "os": "LIN",
    "mail": false,
    "ip": "10.129.120.7",
    "dynamicIp": false,
    "description": "Discovered host jira.dev.lab",
    "office": false,
    "lastSeen": "2021-04-05 20:05:39",
    "meta": {
        "location": "http://<your-domain>/soffid.pat.lab:8080/webservice/scim2/v1/Host/1793068"Schemas/urn:soffid:com.soffid.iam.api.Host",
        "resourceType": "Host"Schema"
    },
    "networkCode": "lab1",
    "schemas": [
        "urn:soffid:com.soffid.iam.api.Host"ietf:params:scim:schemas:core:2.0:Schema"
    ],
    "name": "Host",
    jira.dev.lab""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": "networkCode",
            "mutability": "readWrite",
            "type": "string",
            "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": "ip",
            "mutability": "readWrite",
            "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": true
        },
        {
            "uniqueness": "none",
            "name": "mail",
            "mutability": "readWrite",
            "type": "boolean",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "office",
            "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": "hostAlias",
            "mutability": "readWrite",
            "type": "string",
            "caseExact": true,
            "returned": "default",
            "multiValued": true,
            "required": false
        },
        {
            "uniqueness": "none",
            "name": "printersServer",
            "mutability": "readWrite",
            "type": "boolean",
            "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": "serialNumber",
            "mutability": "readOnly",
            "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
        }
    ],
    "id": 1793068,
    "hostAlias": [],
    "printersServer": falseurn:soffid:com.soffid.iam.api.Host"
}

Response

Full Error

JSON example

For more infomation about response error visitVisit https://bookstack.soffid.com/link/116#bkmrk-error-responseSCIM Host examples page

 

Back to top