Get started
Public API
User management

Creating users

Official SCIM documentation

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

Creating users

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

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

Example curl command for creating user:

curl -X POST https://masterplan.com/public_api/scim/v2/Users
-H 'Authorization: Bearer ACCESS_TOKEN'
-H "Content-type: application/json"
-d '{
         "schemas": [
            "urn:masterplan:scim:UserAttributes", 
            "urn:ietf:params:scim:schemas:core:2.0:User", 
            "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
            ],
         "emails": [{"type": "work", "value": "johndoe@example.com"}],
         "phoneNumbers": [{"type": "work", "value": "123-8800-12"}],
         "name": {"givenName": "john", "familyName": "Doe"},
         "roles": ["manager"],
         "title": "mr",
         "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
             "department": "Backend"
         },
         "urn:masterplan:scim:UserAttributes": {
             "licenses": 10
         },
         "userType": "Engineering Lead"
     }'

Server responds with User resource and 201 status code.

Example response

{
    "active": true,
    "emails": [
      {
        "primary": true,
        "type": "work",
        "value": "johndoe@example.com"
      }
    ],
    "external_id": "kxzpnRDKNtFgRVa_eygO9LWIJeGKOXqXSrYIfowsxS8",
    "id": "d3a1177f-a9f0-4027-83a4-80d06368fcf3",
    "meta": {
        "created": "2023-05-14T22:18:16.572467+00:00",
        "location": "https://masterplan.com/public_api/scim/v2/Users/d3a1177f-a9f0-4027-83a4-80d06368fcf3",
        "resourceType": "User"
    },
    "name": {
        "familyName": "John",
        "givenName": "Doe"
    },
    "schemas": [
        "urn:masterplan:scim:UserAttributes", 
        "urn:ietf:params:scim:schemas:core:2.0:User", 
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "userName": "johndoe@example.com",
    "phoneNumbers": [
        {
          "primary": true,
          "type": "work",
          "value": "123-8800-12"
        }
    ],
    "roles": [
        "manager"
    ],
    "title": "Mr",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "department": "Backend"
    },
    "urn:masterplan:scim:UserAttributes": {
        "licenses": 10
    },
    "userType": "Engineering Lead"
}
PAGE CONTENT