RFC7644 SCIM(System for Cross-domain Identity Management) 2.0 implementation of the "Modifying with PATCH" section 3.5.2.
Important things to know, this library can :
- Validate a SCIM Patch query.
- Patch a SCIM resource from a SCIM Patch Query.
Want to have an example on how it works, check this example.
This library is implementing the 3.5.2. Modifying with PATCH chapter of the SCIM RFC https://tools.ietf.org/html/rfc7644#section-3.5.2.
It will allow you to create a SCIM resources and to patch them using the SCIM Query language.
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.
}This implements the PATCH of a SCIM object from a SCIM Query. You should create a valid SCIM resource by extending the ScimResource interface.
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: 'user1@test.com',
name: { familyName: 'user1', givenName: 'user2' },
active: true,
emails: [{value: 'user1@test.com', primary: true}],
meta: { resourceType: 'User', created: new Date(), lastModified: new Date() }
};
const patch: ScimPatchOperation = { op: 'replace', value: { active: false } };
const patchedUser = scimPatch(scimUser, patch);
// scimUser === patchedUser, see Options section if you want to avoid updating the original objectThis particular operation will return :
{
"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
"userName": "user1@test.com",
"name": { "familyName": "user1", "givenName": "user2" },
"active": false,
"emails": [{"value": "user1@test.com", "primary": true }],
"meta": { "resourceType": "User", "created": "2019-12-19T14:36:08.838Z", "lastModified": "2019-12-19T14:36:08.838Z" }
}By default scimPatch() is updating the scim resource you pass in the function.
If you want to avoid this, you can add an option while calling scimPatch(), it will do a copy of the object and work
on this copy.
Your call will look like this now:
const patchedUser = scimPatch(scimUser, patch, {mutateDocument: false});
// scimUser !== patchedUserBy default scimPatch() will treat as Add a replace operation that targets an attribute that does not exist.
If you prefer to throw an error instead, then set treatMissingAsAdd: false
// scimUser has no addresses
const patch = {
op: 'replace',
path: 'addresses[type eq "work"].country',
value: 'Australia',
};
const patchedUser = scimPatch(scimUser, patch, {treatMissingAsAdd: false});
// patchedUser.addresses[0].country === "Australia"See the contributor's guide for some helpful tips.
Thanks so much to our contributors.