Skip to main content

SCIM Network examples

Operations

List all

List all GroupUser.Network.

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUserNetwork
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 25,6,
    "startIndex": 1,
    "Resources": [
        {
            "groupDescription": "Enterprise",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/480412"Network/67",
                "resourceType": "GroupUser"Network"
            },
            "ip": "127.0.0.0",
            "lanAccess": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"Network"
            ],
            "start"name": "2020-07-02 12:14:48"loopback",
            "fullName"description": "test User",
            "disabled": false,
            "attributes": {}Description",
            "id": 480412,67,
            "user"mask": "test2"255.255.255.128",
            "primaryGroup"dhcpSupport": false,
            "group": "enterprise"false
        },
        {
            "groupDescription": "World Modified",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"Network/505167",
                "resourceType": "GroupUser"Network"
            },
            "ip": "172.0.0.0",
            "lanAccess": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"Network"
            ],
            "start"name": "2020-08-06 15:52:12"int1",
            "fullName"description": "testInternal User",network "end": "2021-02-26 13:05:44",
            "disabled": true,
            "attributes": {}1",
            "id": 503629,505167,
            "user"mask": "test2"255.240.0.0",
            "primaryGroup"dhcpSupport": 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 GroupUsersNetworks 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 GroupUserNetworks with a filter expression.

GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser?Network?filter=groupDescriptiondescription eqco "World Modified"labora
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 4,3,
    "startIndex": 1,
    "Resources": [
        {
            "groupDescription": "World Modified",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"Network/1790267",
                "resourceType": "GroupUser"Network"
            },
            "ip": "10.129.120.0",
            "lanAccess": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"Network"
            ],
            "start"name": "2020-08-06 15:52:12"lab1",
            "fullName"description": "testLaboratory User",network "end": "2021-02-26 13:05:44",
            "disabled": true,
            "attributes": {}1",
            "id": 503629,1790267,
            "user"mask": "test2"255.255.255.0",
            "primaryGroup"dhcpSupport": false,
            "group": "world2"false
        },
        {
            "groupDescription": "World Modified",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1519730"Network/1790319",
                "resourceType": "GroupUser"Network"
            },
            "ip": "10.129.121.0",
            "lanAccess": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"Network"
            ],
            "start"name": "2021-02-20 18:08:23"lab2",
            "fullName"description": "DilbertLaboratory ADAMSnetwork .",
            "end": "2021-02-20 19:07:45",
            "disabled": true,
            "attributes": {}2",
            "id": 1519730,1790319,
            "user"mask": "dilbert"255.255.255.0",
            "primaryGroup"dhcpSupport": false,
            "group": "world2"false
        },
        {
            "groupDescription": "World Modified",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1521501"Network/1858961",
                "resourceType": "GroupUser"Network"
            },
            "ip": "10.129.122.0",
            "lanAccess": true,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.GroupUser"Network"
            ],
            "start"name": "2021-02-20 20:21:06"lab3",
            "fullName"description": "DilbertLaboratory ADAMS .",
            "disabled": false,
            "attributes": {}network",
            "id": 1521501,1858961,
            "user"mask": "dilbert"255.255.255.0",
            "primaryGroup"dhcpSupport": 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 GroupUserNetwork by its id (primary key). 

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1974296Network/1038187
Response 200 OK
{
    "groupDescription": "Help desk support team",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1974296"Network/1038187",
        "resourceType": "GroupUser"Network"
    },
    "ip": "192.168.133.0",
    "lanAccess": true,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"Network"
    ],
    "start"name": "2021-05-05 12:49:51"internal",
    "fullName"description": "JohnInternal Smith"Network",
    "disabled"loginRestriction": false,
    "attributes"id": {1038187,
    "startDate"mask": "2021-05-04 00:00:00"
    }255.255.255.0",
    "id"dhcpSupport": 1974296,
    "user": "jsmith",
    "primaryGroup": false,
    "group": "it"true
}

Create

To create a GroupUser.Network.

Request

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

JSON

{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"Network"
    ],
    "group"name": "it"Laboratory",
    "groupDescription"description": "HelpLaboratory desk support team"Network",
    "user"ip": "ckelp"192.168.123.0",
    "fullName"mask": "Casey Kelp"255.255.255.0",
    "primaryGroup"loginRestriction": false,
    "lanAccess": true,
    "attributes"dhcpSupport": {}true
}
Response 201 Created
{
    "groupDescription": "Help desk support team",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741"Network/1977114",
        "resourceType": "GroupUser"Network"
    },
    "ip": "192.168.123.0",
    "lanAccess": true,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"Network"
    ],
    "start"name": "2021-05-11 10:39:23"Laboratory",
    "fullName"description": "CaseyLaboratory Kelp"Network",
    "disabled"loginRestriction": false,
    "attributes"id": {}1977114,
    "mask": "255.255.255.0",
    "id"dhcpSupport": 1976741,
    "user": "ckelp",
    "primaryGroup": true,
    "group": "it"true
}

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/1976741Network/1977114

JSON

{
    "Operations": [
        {
            "op": "replace",
            "path": "groupDescription"ip",
            "value": "Enterprise engineering team"
        },
        {
            "op": "replace",
            "path": "group",
            "value": "EngineeringTeam"192.168.125.0"
        }
    ]
}
Response 200 OK
{
    "groupDescription": "Enterprise engineering team",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741"Network/1977114",
        "resourceType": "GroupUser"Network"
    },
    "ip": "192.168.123.0",
    "lanAccess": true,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.GroupUser"Network"
    ],
    "start"name": "2021-05-11 10:39:23"Laboratory",
    "fullName"description": "CaseyLaboratory Kelp"Network",
    "disabled"loginRestriction": false,
    "attributes"id": {}1977114,
    "mask": "255.255.255.0",
    "id"dhcpSupport": 1976741,
    "user": "ckelp",
    "primaryGroup": true,
    "group": "EngineeringTeam"true
}

Update all

This operation replace all values in the GroupUser.Network.

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

JSON

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

Delete

Delete a role.Network.

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

Request
DELETE http://<your-omain>/soffid/webservice/scim2/v1/GroupUser/1976741Network/1977114
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