Skip to main content

SCIM GroupUser examples

Operations

List all

List all User typesGroupUser.

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/UserTypeGroupUser
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 3,25,
    "startIndex": 1,
    "Resources": [
        {
            "groupDescription": "Enterprise",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/29"GroupUser/480412",
                "resourceType": "UserType"GroupUser"
            },
            "unmanaged": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.UserType"GroupUser"
            ],
            "name"start": "S"2020-07-02 12:14:48",
            "description"fullName": "SSOtest accountUser",
            (USE"disabled": IT)false,
            "attributes": {},
            "id": 29480412,
            "user": "test2",
            "primaryGroup": false,
            "group": "enterprise"
        },
        {
            "groupDescription": "World Modified",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/31"GroupUser/503629",
                "resourceType": "UserType"GroupUser"
            },
            "unmanaged": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.UserType"GroupUser"
            ],
            "name"start": "E"2020-08-06 15:52:12",
            "description"fullName": "Externaltest user"User",
            "end": "2021-02-26 13:05:44",
            "disabled": true,
            "attributes": {},
            "id": 31503629,
            "user": "test2",
            "primaryGroup": false,
            "group": "world2"
        },
        {
            "groupDescription": "Enterprise Administrators Group",
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/33"GroupUser/1182887",
                "resourceType": "UserType"GroupUser"
            },
            "unmanaged": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.UserType"GroupUser"
            ],
            "name"start": "I"2020-12-31 16:48:58",
            "description"fullName": "InternalJohn user"Smith",
            "disabled": false,
            "attributes": {
                "comments": "This is a test",
                "startDate": "2021-01-01 00:00:00"
            },
            "id": 331182887,
            "user": "jsmith",
            "primaryGroup": false,
            "group": "admingroup"
        },
      ...........
    ]
}

List by filter

List all user typesGroupUsers with a filter expression.

It is allowed to use pagination and sort the information, for more information visit SCIM Query parameters page.

Request

List all rolesGroupUser with a filter expression.

GET http://<your-domain>/soffid/webservice/scim2/v1/UserType?GroupUser?filter=descriptiongroupDescription coeq  sso"World Modified"
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 1,
    "startIndex": 1,
    "Resources": [
        {
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/29",
                "resourceType": "UserType"
            },
            "unmanaged": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.UserType"
            ],
            "name": "S",
            "description": "SSO account (USE IT)",
            "id": 29
        }
    ]
}

Query by id

Query a user typeGroupUser by its id (primary key). 

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/UserType/33GroupUser/1974296
Response 200 OK
{
    "groupDescription": "Help desk support team",
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/33"GroupUser/1974296",
        "resourceType": "UserType"GroupUser"
    },
    "unmanaged": false,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.UserType"GroupUser"
    ],
    "name"start": "I"2021-05-05 12:49:51",
    "description"fullName": "InternalJohn user"Smith",
    "disabled": false,
    "attributes": {
        "startDate": "2021-05-04 00:00:00"
    },
    "id": 331974296,
    "user": "jsmith",
    "primaryGroup": false,
    "group": "it"
}

Create

To create a user type .

Request

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

JSON

{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.UserType"
    ],
    "name": "O",
    "description": "Other user",
    "unmanaged": false
}
Response 201 Created
{
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/1976718",
        "resourceType": "UserType"
    },
    "unmanaged": false,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.UserType"
    ],
    "name": "O",
    "description": "Other user",
    "id": 1976718
}

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/UserType/1976718

JSON

{
    "Operations": [
        {
            "op": "replace",
            "path": "name",
            "value": "OT"
        }
    ]
}
Response 200 OK
{
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/1976718",
        "resourceType": "UserType"
    },
    "unmanaged": false,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.UserType"
    ],
    "name": "OT",
    "description": "Other user",
    "id": 1976718
}

Update all

This operation replace all values in the roole.

  • Note that the attribute id is required to confirm that the resource "...UserType/<id>" is the same that the JSON user type.
  • Note that all the attributes not included in the request will be cleared in the user 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/UserType/1976718

JSON

{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.OUType"
    ],
    "id": 1975535,
    "name": "OY"
}
Response 200 OK
{
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/1976718",
        "resourceType": "UserType"
    },
    "unmanaged": false,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.UserType"
    ],
    "name": "OY",
    "id": 1976718
}

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/UserType/1976718
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