Skip to main content

SCIM Group type examples

Operations

This page shows the operations that can be performed for the Group Type object

List all

List all Group types

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/OUType
Response 200 OK
{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 2,
    "startIndex": 1,
    "Resources": [
        {
            "roleHolder": false,
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/504761",
                "resourceType": "OUType"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.api.OUType"
            ],
            "name": "CC",
            "description": "Cost Center",
            "id": 504761
        },
        {
            "roleHolder": false,
            "meta": {
                "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/504762",
                "resourceType": "OUType"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.api.OUType"
            ],
            "name": "PC",
            "description": "Productive center",
            "id": 504762
        }
    ]
}

List by filter

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

GET http://<your-domain>/soffid/webservice/scim2/v1/OUType?filter=description co Cost
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",
                "resourceType": "OUType"
            },
            "schemas": [
                "urn:soffid:com.soffid.iam.api.OUType"
            ],
            "name": "CC",
            "description": "Cost Center",
            "id": 504761
        }
    ]
}

Query by id

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

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/OUType/504761
Response 200 OK
{
    "roleHolder": false,
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/504761",
        "resourceType": "OUType"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.api.OUType"
    ],
    "name": "CC",
    "description": "Cost Center",
    "id": 504761
}

Create

To create a group type .

Request

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

JSON

{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.Role"
    ],
    "name": "App Billing Role",
    "description": "Role Admin for Billing application",
    "informationSystemName": "Operation/Business 2/App Billing",
    "system": "test",
    "password": false,
    "bpmEnabled": false,
    "enableByDefault": false,
    "granteeGroups": [],
    "ownedRoles": [],
    "ownerGroups": [],
    "ownerRoles": []
}
Response 201 Created
{
    "schemas": [
        "urn:soffid:com.soffid.iam.api.OUType"
    ],
    "name": "NewOU",
    "description": "New OU"
}

Update partial

Only attributes with changes will be updated, the other will maintain the same value.

Request
PATCH http://<your-domain>/soffid/webservice/scim2/v1/OUType/1976710

JSON

{
    "Operations": [
        {
            "op": "replace",
            "path": "name",
            "value": "OU"
        }
    ]
}
Response 200 OK
{
    "roleHolder": false,
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/OUType/1976710",
        "resourceType": "OUType"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.api.OUType"
    ],
    "name": "OU",
    "description": "New OU",
    "id": 1976710
}

Update all

This operation replaces all values in the roole.

  • Note that the attribute id is required to confirm that the resource "...OUType/<id>" is the same that the JSON group type.
  • Note that all the attributes not included in the request will be cleared in the group 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 visit Resource data model page
Request
PUT http://<your-domain>/soffid/webservice/scim2/v1/Role/1976590

JSON

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

Delete

Delete a role.

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

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

Error response

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

 

Back to top