Skip to main content

SCIM Host examples

Operations

List all

List all GroupUser.Hosts.

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUserHost
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 25,12,
    "startIndex": 1,
    "Resources": [
        {
            "groupDescription"serialNumber": "Enterprise"soffid.bubu.lab:192.168.133.1",
            "os": "ALT",
            "mail": false,
            "ip": "192.168.133.1",
            "dynamicIp": true,
            "description": "Autocreated on  12/13/20 6:49:34 PM",
            "office": false,
            "lastSeen": "2020-12-13 18:49:34",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/480412"Host/1039055",
                "resourceType": "GroupUser"Host"
            },
            "networkCode": "internal",
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"Host"
            ],
            "start"name": "2020-07-02 12:14:48",
            "fullName": "test User",
            "disabled": false,
            "attributes": {}soffid.bubu.lab",
            "id": 480412,1039055,
            "user"hostAlias": "test2"[],
            "primaryGroup"printersServer": false,
            "group": "enterprise"false
        },
        {
            "groupDescription"os": "WorldALT",
            Modified""mail": false,
            "ip": "10.129.120.4",
            "dynamicIp": false,
            "description": "Discovered host iam.soffid.com",
            "office": false,
            "lastSeen": "2021-04-05 20:06:19",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"Host/1793093",
                "resourceType": "GroupUser"Host"
            },
            "networkCode": "lab1",
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"Host"
            ],
            "start"name": "2020-08-06 15:52:12",
            "fullName": "test User",
            "end": "2021-02-26 13:05:44",
            "disabled": true,
            "attributes": {}iam.soffid.com",
            "id": 503629,1793093,
            "user"hostAlias": "test2"[],
            "primaryGroup"printersServer": false,
            "group": "world2"false
        },
      {
            "groupDescription": "Enterprise Administrators Group",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1182887",
                "resourceType": "GroupUser"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"
            ],
            "start": "2020-12-31 16:48:58",
            "fullName": "John Smith",
            "disabled": false,
            "attributes": {
                "comments": "This is a test",
                "startDate": "2021-01-01 00:00:00"
            },
            "id": 1182887,
            "user": "jsmith",
            "primaryGroup": false,
            "group": "admingroup"
        },
      ...........
    ]
}

List by filter

List all GroupUsersHosts with a filter expression.

It is allowed to use pagination and sort the information, for more information visit the Sorting and Pagination information.

Request

List all GroupUserHosts with a filter expression.

GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser?Host?filter=groupDescriptionos eq "WorldLIN Modified"and name co archiva
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 4,1,
    "startIndex": 1,
    "Resources": [
        {
            "groupDescription"os": "WorldLIN",
            Modified""mail": false,
            "ip": "10.129.120.2",
            "dynamicIp": false,
            "description": "Discovered host archiva.dev.lab",
            "office": false,
            "lastSeen": "2021-04-05 20:04:49",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"Host/1793026",
                "resourceType": "GroupUser"Host"
            },
            "networkCode": "lab1",
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"Host"
            ],
            "start"name": "2020-08-06 15:52:12",
            "fullName": "test User",
            "end": "2021-02-26 13:05:44",
            "disabled": true,
            "attributes": {}archiva.dev.lab",
            "id": 503629,1793026,
            "user": "test2",
            "primaryGroup": false,
            "group": "world2"
        },
        {
            "groupDescription": "World Modified",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1519730",
                "resourceType": "GroupUser"
            },
            "schemas"hostAlias": [
                "urn:soffid:com.soffid.iam.api.GroupUser"
            ],
            "start"printersServer": "2021-02-20 18:08:23",
            "fullName": "Dilbert ADAMS .",
            "end": "2021-02-20 19:07:45",
            "disabled": true,
            "attributes": {},
            "id": 1519730,
            "user": "dilbert",
            "primaryGroup": false,
            "group": "world2"
        },
        {
            "groupDescription": "World Modified",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1521501",
                "resourceType": "GroupUser"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"
            ],
            "start": "2021-02-20 20:21:06",
            "fullName": "Dilbert ADAMS .",
            "disabled": false,
            "attributes": {},
            "id": 1521501,
            "user": "dilbert",
            "primaryGroup": false,
            "group": "world2"
        },
        {
            "groupDescription": "World Modified",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1558480",
                "resourceType": "GroupUser"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"
            ],
            "start": "2021-02-26 13:06:24",
            "fullName": "test User",
            "disabled": false,
            "attributes": {},
            "id": 1558480,
            "user": "test2",
            "primaryGroup": false,
            "group": "world2"false
        }
    ]
}

Query by id

Query a GroupUserHost by its id (primary key). 

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1974296Host/1793093
Response 200 OK
{
    "groupDescription"os": "HelpALT",
    desk"mail": supportfalse,
    team""ip": "10.129.120.4",
    "dynamicIp": false,
    "description": "Discovered host iam.soffid.com",
    "office": false,
    "lastSeen": "2021-04-05 20:06:19",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1974296"Host/1793093",
        "resourceType": "GroupUser"Host"
    },
    "networkCode": "lab1",
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"Host"
    ],
    "start"name": "2021-05-05 12:49:51",
    "fullName": "John Smith",
    "disabled": false,
    "attributes": {
        "startDate": "2021-05-04 00:00:00"
    }iam.soffid.com",
    "id": 1974296,1793093,
    "user"hostAlias": "jsmith"[],
    "primaryGroup"printersServer": false,
    "group": "it"false
}

Create

To create a GroupUser.Host.

Request

POST http://<your-domain>/soffid/webservice/scim2/v1/GroupUserHost

JSON

{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"Host"
    ],
    "group"name": "it"billing.dev.lab",
    "groupDescription"description": "HelpHost desk support team"billing.dev.lab",
    "user"os": "ckelp"LIN",
    "fullName"mail": false,
    "dynamicIp": false,
    "networkCode": "Casey Kelp"internal",
    "primaryGroup"hostAlias": true,[
        "attributes"aliasHost_1",
        "aliasHost_2"
    ],
    "serialNumber": {}"123456789",
    "printersServer": false
}
Response 201 Created
{
    "groupDescription": "Help desk support team",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741",
        "resourceType": "GroupUser"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"
    ],
    "start": "2021-05-11 10:39:23",
    "fullName": "Casey Kelp",
    "disabled": false,
    "attributes": {},
    "id": 1976741,
    "user": "ckelp",
    "primaryGroup": true,
    "group": "it"
}

Update partial

Update only of the attributes with changes, only these atrributes will be updated, the rest will maintain the same value.

Request
PATCH http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1976741

JSON

{
    "Operations": [
        {
            "op": "replace",
            "path": "groupDescription",
            "value": "Enterprise engineering team"
        },
        {
            "op": "replace",
            "path": "group",
            "value": "EngineeringTeam"
        }
    ]
}
Response 200 OK
{
    "groupDescription": "Enterprise engineering team",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741",
        "resourceType": "GroupUser"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"
    ],
    "start": "2021-05-11 10:39:23",
    "fullName": "Casey Kelp",
    "disabled": false,
    "attributes": {},
    "id": 1976741,
    "user": "ckelp",
    "primaryGroup": true,
    "group": "EngineeringTeam"
}

Update all

This operation replace all values in the GroupUser.

  • Note that the attribute id is required to confirm that the resource "...GroupUser/<id>" is the same that the JSON GroupUser.
  • Note that all the attributes not included in the request will be cleared in the GroupUser type and their data will be lost.
  • Note that not all the attributes are updatable, for example tag meta, avoid these tags. For more information see Resource data model page
Request
PUT http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1976741

JSON

{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"
    ],
    "id": 1976741,
    "group": "it",
    "groupDescription": "Help desk support team",
     "user": "ckelp",
    "fullName": "Casey Kelp",
    "primaryGroup": true,
    "attributes": {}
}
Response 200 OK
{
    "groupDescription": "Help desk support team",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741",
        "resourceType": "GroupUser"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"
    ],
    "fullName": "Casey Kelp",
    "disabled": false,
    "attributes": {},
    "id": 1976741,
    "user": "ckelp",
    "primaryGroup": true,
    "group": "it"
}

Delete

Delete a role.

Please note after this delete, the account has to be created again to use it in the next examples.

Request
DELETE http://<your-omain>/soffid/webservice/scim2/v1/GroupUser/1976741
Response 204 No Content
204 No Content

Error response

For more infomation about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response

 

Back to top