Get started
Public API
User management

Creating user groups

Official SCIM documentation

https://datatracker.ietf.org/group/scim/documents/

Creating user groups

To create user group use following url with valid payload and valid access token in Authorization header:

POST https://masterplan.com/public_api/scim/v2/Groups

Example curl command for creating user group:

curl -X POST https://masterplan.com/public_api/scim/v2/Groups
-H 'Authorization: Bearer ACCESS_TOKEN'
-H "Content-type: application/json"
-d '{
         "schemas": [
             "urn:ietf:params:scim:schemas:core:2.0:Group", 
             "urn:masterplan:scim:UserGroupAttributes", 
             ],
         "displayName": "Backend developers",
         "members": [
             {
                 "value": "406a917c-8c8d-4579-8045-e7fafd2dda56",
                 "type": "User"
             }, 
             {
                 "value": "99be05d3-a828-458b-aa92-3256f7b029c0",
                 "type": "User"
             }, 
         ],
         "urn:masterplan:scim:UserGroupAttributes": {
             "is_private": false
         },
     }'

Server responds with Group resource and 201 status code.

Example response

{
    "displayName": "Backend developers",
    "id": "88efb36a-7ff3-4170-b81f-691a8c86561e",
    "members": [
        {
            "$ref": "https://masterplan.com/public_api/scim/v2/Users/406a917c-8c8d-4579-8045-e7fafd2dda56",
            "type": "User",
            "value": "406a917c-8c8d-4579-8045-e7fafd2dda56"
        },
        {
            "$ref": "https://masterplan.com/public_api/scim/v2/Users/99be05d3-a828-458b-aa92-3256f7b029c0",
            "type": "User",
            "value": "99be05d3-a828-458b-aa92-3256f7b029c0"
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:masterplan:scim:UserGroupAttributes"
    ],
    "urn:masterplan:scim:UserGroupAttributes": {
        "is_private": false,
        "owner": {
            "$ref": "https://masterplan.com/public_api/scim/v2/Users/3a0d0c3d-f3dd-482d-9721-b89132d03391",
            "type": "User",
            "value": "3a0d0c3d-f3dd-482d-9721-b89132d03391"
        }
    },
    "meta": {
        "created": "2023-05-14T22:18:16.572467+00:00",
        "location": "https://masterplan.com/public_api/scim/v2/Groups/88efb36a-7ff3-4170-b81f-691a8c86561e",
        "resourceType": "Group"
    }
}
PAGE CONTENT