SCIM User type examples

Operations

List all

List all GroupUser types

Request

GET http://<your-domain>/soffid/webservice/scim2/v1/OUTypeUserType

Response 200 OK

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 2,3,
    "startIndex": 1,
    "Resources": [
        {
            "roleHolder": false,
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/504761"UserType/29",
                "resourceType": "OUType"UserType"
            },
            "unmanaged": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.OUType"UserType"
            ],
            "name": "CC"S",
            "description": "CostSSO Center"account (USE IT)",
            "id": 50476129
        },
        {
            "roleHolder": false,
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/504762"UserType/31",
                "resourceType": "OUType"UserType"
            },
            "unmanaged": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.OUType"UserType"
            ],
            "name": "PC"E",
            "description": "ProductiveExternal center"user",
            "id": 50476231
        },
        {
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/UserType/33",
                "resourceType": "UserType"
            },
            "unmanaged": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.UserType"
            ],
            "name": "I",
            "description": "Internal user",
            "id": 33
        }
    ]
}

List by filter

List all groupuser types 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 roles with a filter expression.

GET http://<your-domain>/soffid/webservice/scim2/v1/OUType?UserType?filter=description co Costsso

Response 200 OK

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 1,
    "startIndex": 1,
    "Resources": [
        {
            "roleHolder": false,
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/504761"UserType/29",
                "resourceType": "OUType"UserType"
            },
            "unmanaged": false,
            "schemas": [
                "urn:soffid:com.soffid.iam.api.OUType"UserType"
            ],
            "name": "CC"S",
            "description": "CostSSO Center"account (USE IT)",
            "id": 50476129
        }
    ]
}

Query by id

Query a groupuser type by its id (primary key). 

Request

GET http://<your-domain>/soffid/webservice/scim2/v1/OUType/504761UserType/33

Response 200 OK

{
    "roleHolder": false,
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/504761"UserType/33",
        "resourceType": "OUType"UserType"
    },
    "unmanaged": false,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.OUType"UserType"
    ],
    "name": "CC"I",
    "description": "CostInternal Center"user",
    "id": 50476133
}

Create

To create a gruopuser type .

Request

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

JSON

{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.Role"UserType"
    ],
    "name": "App Billing Role"O",
    "description": "RoleOther Admin for Billing application"user",
    "informationSystemName"unmanaged": "Operation/Business 2/App Billing",
    "system": "test",
    "password": false,
    "bpmEnabled": false,
    "enableByDefault": false,
    "granteeGroups": [],
    "ownedRoles": [],
    "ownerGroups": [],
    "ownerRoles": []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.OUType"UserType"
    ],
    "name": "NewOU"O",
    "description": "NewOther OU"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/OUType/1976710UserType/1976718

JSON

{
    "Operations": [
        {
            "op": "replace",
            "path": "name",
            "value": "OU"OT"
        }
    ]
}

Response 200 OK

{
    "roleHolder": false,
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/1976710"UserType/1976718",
        "resourceType": "OUType"UserType"
    },
    "unmanaged": false,
    "schemas": [
        "urn:soffid:com.soffid.iam.api.OUType"UserType"
    ],
    "name": "OU"OT",
    "description": "NewOther OU"user",
    "id": 19767101976718
}

Update all

This operation replace all values in the roole.

• Note that the attribute id is required to confirm that the resource "...OUType/UserType/<id>" is the same that the JSON groupuser type.
• 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/Role/1976590UserType/1976718

JSON

{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.OUType"
    ],
    "id": 1976710,1975535,
    "name": "ChangeOU"OY"
}

Response 200 OK

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

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/OUType/1976710UserType/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