menno-pieters-sp/sample-node-scim-server

This is a sample NodeJS SCIM server that includes debug features

Okta-Scim-Server

Sample SCIM server written in NodeJS that supports Users and Groups (with group memberships!). This can be used in conjunction with the Okta SCIM application to test SCIM capabilities. Includes action logging.

Users endpoint

1. Create User (POST to {SCIM Base Url}/Users)

2. Get Users (GET to {SCIM Base Url}/Users)

3. Get User By Id (GET to {SCIM Base Url}/Users/:UserId)

4. Deactivate User (PATCH to {SCIM Base Url}/Users/:UserId)

5. Modify/Update User (PUT to {SCIM Base Url}/Users/:UserId)

Groups endpoint

1. Create Group (POST to {SCIM Base Url}/Groups)

2. Get Groups (GET to {SCIM Base Url}/Groups)

3. Get Group By Id (GET to {SCIM Base Url}/Groups/:GroupId)

4. Modify Group Name (PATCH to {SCIM Base Url}/Groups/:GroupId)

5. Update Group (PUT to {SCIM Base Url}/Groups/:GroupId)

Required Packages

You need to install NodeJS and npm (comes with NodeJS). The project contains a package.json file that npm can use to install dependencies. To do this, follow these steps:

1. Open Command Prompt (or Terminal)

2. cd to the place where you extracted this project

3. npm install in the folder where the package.json file is located

Running and Testing the Server

Once all above is install run the node server "node SCIMServer.js". Make the following cals from any REST Client (Postman, cURL, etc.) or API validation tools Runscope.

IMPORTANT: All requests must contain the following two headers:

Accept: application/scim+json
Content-Type: application/scim+json

You can use ngrok "ngrok http 8081" to make server available online. use https://xxxxx.ngrok.io in Okta SCIM app or Runscope to test online.

Using Postman

You can get the collection for the supported actions by clicking this link.

IMPORTANT: If you change the body type to JSON, Postman will reset the Content-Type header to application/json and your calls will fail.

Requests

Users

1. POST {SCIM_Base_Url}/scim/v2/Users

{  
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "[email protected]",
  "name":
  {  
    "givenName": "<GivenName>",
    "middleName": "undefined",
    "familyName": "<FaimlyName>"
  },
  "emails":
  [{
    "primary": true,
    "value": "[email protected]",
    "type": "work"
  }],
  "displayName": "<display name>",
  "externalId": "<externalId>",
  "groups": [],
  "active": true
}

2. GET {SCIM_Base_Url}/scim/v2/Users?count=2&startIndex=1

3. GET {SCIM_Base_Url}/scim/v2/Users?count=1&filter=userName eq "[email protected]"&startIndex=1

4. PUT {SCIM_Base_Url}/scim/v2/Users/

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "id": "a5222dc0-4dec-11e6-866c-5b600f3e2809",
  "userName": "[email protected]",
  "name":
  {
    "givenName": "<GivenName>",
    "middleName": "undefined",
    "familyName": "<FamilyName>"
  },
  "active": "true",
  "meta":
  {
    "resourceType": "User",
    "location": "<location uri>"
  },
  "emails":
  [{
    "primary": true,
    "type": "work",
    "value": "[email protected]"
  }],
  "displayName": "<display Name>",
  "externalId": "<externalId>",
  "groups": []
}

5. PATCH {SCIM_Base_Url}/scim/v2/Users/

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations":
  [{
    "op": "replace",
    "value": { "active":true }
  }]
}

Groups

1. POST {SCIM_Base_Url}/scim/v2/Groups

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "Test Group 1",
  "members":
  [{
    "value": "<UserID>",
    "$ref": "<UserSCIMLocation>",
    "display": "First Last"
  }]
}

2. GET {SCIM_Base_Url}/scim/v2/Groups?count=2&startIndex=1

3. GET {SCIM_Base_Url}/scim/v2/Groups?count=1&startIndex=1&filter=displayName eq Test Group 1

4. PUT {SCIM_Base_Url}/scim/v2/Groups/

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "id": "<GroupID>",
  "displayName": "<DisplayName>",
  "members":
  [{
    "value": "<UserID>",
    "$ref": "<UserSCIMLocation>",
    "display": "First Last"
  }]
}

5. PATCH {SCIM_Base_Url}/scim/v2/Groups/

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations":
  [{
    "op": "replace",
    "value": { "displayName":"Test" }
  }]
}