scim-patch

SCIM-PATCH

RFC7644 SCIM(System for Cross-domain Identity Management) 2.0 implementation of the "Modifying with PATCH" section 3.5.2.

This library can :

• Validate a SCIM Patch query.
• Patch a SCIM resource from a SCIM Patch Query.

Validation of a SCIM Query.

import {patchBodyValidation} from 'scim-patch';

const scimBody: ScimPatchOperation = 
{
  'schemas': ['urn:ietf:params:scim:api:messages:2.0:PatchOp'],
  'Operations': [
    {op: 'replace', path: 'name.familyName', value: 'newFamilyName'}
  ]
};

try {
  patchBodyValidation(scimBody);
} catch (error) {
  // Here if there are an error in you SCIM request.
}

Patch a SCIM resource from a SCIM Patch Query.

This implements the PATCH of a SCIM object from a SCIM Query.

You should create a valid SCIM resource by extending the ScimResource type.

export interface ScimUser extends ScimResource {
    schemas: ['urn:ietf:params:scim:schemas:core:2.0:User'];
    userName: string;
    name: {
        familyName: string;
        givenName: string;
    };
    active: boolean;
    emails: Array<{
        value: string;
        primary: boolean;
    }>;
    roles?: Array<{
        value: string;
        type?: string;
    }>;
    meta: ScimMeta & { resourceType: 'User' };
};

After you have created your object you can patch it by calling the scimPatch operation.

const scimUser: ScimUser = {
  schemas: ['urn:ietf:params:scim:schemas:core:2.0:User'],
  userName: '[e-mail]',
  name: {
    familyName: 'user1',
    givenName: 'user2'
  },
  active: true,
  emails: [
    {value: '[e-mail]', primary: true}
  ],
  meta: {
    resourceType: 'User',
    created: new Date(),
    lastModified: new Date()
  }
};

const patch: ScimPatchOperation = {
  op: 'replace',
  value: {
    active: false
  }
};

const patchedUser = scimPatch(scimUser, patch);

This particular operation will return :

{ 
  "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "userName": "[e-mail]",
  "name": { 
    "familyName": "user1", 
    "givenName": "user2"
  },
  "active": false,
  "emails": [
    {"value": "[e-mail]", "primary": true } 
  ],
  "meta": { 
    "resourceType": "User",
    "created": "2019-12-19T14:36:08.838Z",
    "lastModified": "2019-12-19T14:36:08.838Z" 
  }
}