ScimControllerDocs.md

Authorization (Required)

there is a token stored in appconfig table with key scim_token and appid federatedgroups it should be set to a randomly generated string.

You can also set it using

insert into oc_appconfig (appid, configkey, configvalue) VALUES ('federatedgroups', 'scim_token', 'something-super-secret');

please ask the administrator to share that token with you and then send requests with the below header:

"x-auth: Bearer <SCIM_TOKEN>"

IP Restriction (Optional)

You can restrict the incoming scim API calls from some whitelisted IPs.

an allowed_ips config key is set to * (all IPs are white-listed) by default. you can set your own white list (separated by ,). and then just a machine with listed IPs can send scim requests.

You can also set it using

insert into oc_appconfig (appid, configkey, configvalue) VALUES ('federatedgroups', 'allowed_ips', '<* | desiered white listed ips (seperated by comma)>');

getGroups

This Will return all groups in OwnCloud

curl --location '/index.php/apps/federatedgroups/scim/Groups'

RESPONSE STATUS 200

{
    "status": "succes",
    "message": "",
    "data": {
        "totalResults": 3,
        "Resources": [
            {
                "id": "admin",
                "displayName": "admin",
                "members": [
                    {
                        "value": "einstein",
                        "ref": "",
                        "displayName": ""
                    }
                ]
            },
            {
                "id": "federalists",
                "displayName": "federalists",
                "members": []
            },
            {
                "id": "customgroup_Custard with Mustard",
                "displayName": "Custard with Mustard",
                "members": [
                    {
                        "value": "einstein",
                        "ref": "",
                        "displayName": ""
                    },
                    {
                        "value": "marie#oc2.docker",
                        "ref": "",
                        "displayName": ""
                    }
                ]
            }
        ]
    }
}

getGroup($groupId)

curl --location '/index.php/apps/federatedgroups/scim/Groups/federalists'

RESPONSE STATUS 200

{
    "status": "succes",
    "message": "Succesfully deleted group: test_g",
    "data": {
        "id": "federalists",
        "displayName": "federalists",
        "members": [
            {
                "value": "fed_user_2#oc2.docker",
                "ref": "",
                "displayName": ""
            }
        ],
        "schemas": [],
        "meta": {
            "resourceType": "Group"
        },
        "urn:ietf:params:scim:schemas:cyberark:1.0:Group": []
    }
}

deleteGroup($groupId)

curl --location --request DELETE '/index.php/apps/federatedgroups/scim/Groups/federalists'

RESPONSE STATUS 204

{
    "status": "succes",
    "message": "Succesfully deleted group: test_g",
    "data": null
}

updateGroup($groupId)

curl --location --request PUT '/index.php/apps/federatedgroups/scim/Groups/federalists'

BODY

{
    "members": [
        {
            "value": "fed_user_2@oc2.docker",
            "ref": "",
            "displayName": ""
        }
    ]
}

RESPONSE STATUS: 200

{
    "status": "succes",
    "message": "",
    "data": {
        "members": [
            {
                "value": "fed_user_2@oc2.docker",
                "ref": "",
                "displayName": ""
            }
        ]
    }
}

createGroup

curl --location --request POST '/index.php/apps/federatedgroups/scim/Groups'

BODY

{
    "id": "federalists",
    "members": [
        {
            "value": "fed_user_2@oc2.docker",
            "ref": "",
            "displayName": ""
        }
    ]
}

RESPONSE STATUS: 201

{
    "status":  "succes"
    "message": ""
    "data":{
        "id": "federalists",
        "members": [
            {
                "value": "fed_user_2@oc2.docker",
                "ref": "",
                "displayName": ""
            }
        ]
    }
}