Get started
Public API
User management

Downloading user groups list

Official SCIM documentation

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

Downloading users

To query user groups use following url with valid access token in Authorization header:

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

Optional query parameters:

Parameter Description Default
startIndex Index of first result. 1
count Number of user groups to retrieve per page 25
filter String with the structure specified in the official documentation.
Currently supported field is displayName.		 None

Example curl command for obtaining users list:

curl -X GET https://masterplan.com/public_api/scim/v2/Groups \
     -H 'Authorization: Bearer ACCESS_TOKEN'

Server responds with List of Group resources.

Example response

{
    "Resources": [
        {
            "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"
            }
        }
    ],
    "itemsPerPage": 1,
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "startIndex": 1,
    "totalResults": 1
}
PAGE CONTENT