SCIMWeb Class

Properties   Methods   Events   Config Settings   Errors  

The SCIMWeb class provides an easy way to add automatic user and group provisioning to your web application.

Syntax

cloudsso.scimweb()

Remarks

The System for Cross-domain Identity Management (SCIM) protocol gives an Identity Provider (e.g., Okta or Microsoft Entra ID) a standardized way to automatically create, update, and deactivate accounts in your application. Instead of an administrator manually managing an account in every connected application, SCIM lets the Identity Provider push those changes out over a simple REST/JSON API whenever a user is hired, changes departments, or leaves the company.

The Identity Provider acts as the client, and your application is the SCIM service provider. This class implements the service provider role. It parses incoming HTTP requests, fires an event so your application can create, look up, update, or delete the corresponding record in its own data store, and then builds the SCIM JSON response.

Unlike the SCIMDesktop class, which hosts its own embedded HTTP server, this class is designed to be embedded within an existing web application or framework, using the ProcessRequest method to handle each incoming request. This makes it well suited to an application that is already running within an existing web server or framework.

Setup

The ProcessRequest method should be called from your web framework's request handler whenever a request arrives for the SCIM base URL. The incoming request is supplied to the class through the RequestMethod, RequestURI, RequestHeaders, and RequestBody properties, which should be set before calling ProcessRequest. The ResponseStatus, ResponseHeaders, and ResponseBody properties may then be read afterward to write the response.

scim.RequestMethod = request.Method; scim.RequestURI = request.RawUrl; scim.RequestHeaders = GetHeaderString(request); scim.RequestBody = requestBodyString; scim.ProcessRequest(); response.StatusCode = scim.ResponseStatus; WriteHeaders(response, scim.ResponseHeaders); response.Write(scim.ResponseBody);

The class may also be configured with information about which SCIM operations to support and how requests should be routed. The BaseURL property is the path prefix used to recognize SCIM resource paths, and the SupportedOperations property is a bitmask that controls which combinations of HTTP method and resource type are accepted. The MaxResults property dictates how many resources can be returned from a single list request.

scim.BaseURL = "/scim/v2"; scim.SupportedOperations = SupportedOperations.sopAll; scim.MaxResults = 200;

Authentication

Every incoming request fires the AuthRequest event before any resource-specific event is raised, giving the application the chance to accept or reject the request, unless the AuthEnabled configuration setting has been disabled. The AuthMethod parameter identifies the scheme supplied by the client, detailed below.

A static bearer token may be supplied to the class as shown.

scim.AuthToken = "the-token-issued-to-your-identity-provider";

Alternatively, custom validation may be performed as shown.

scim.OnAuthRequest += (sender, e) => { e.Accept = e.AuthMethod == "Bearer" && tokenStore.IsValid(e.Token); };

User Management

The class fires an event for each standard SCIM user operation, giving the application full control over how users are stored.

Creating a User

A POST /Users request causes the CreateUser event to be fired with the submitted attributes, including any addresses and phone numbers through the UserEmails and UserPhones collections and enterprise attributes (department, employee number, manager, and so on) through the UserExtension property. The handler must assign and return a unique UserId and set the StatusCode parameter to 201.

Retrieving and Listing Users

A GET /Users/{id} request causes the GetUser event to be fired. The handler populates the user's current attributes and the AddUserEmail, AddUserPhone, and AddUserExtension methods may be called to include any related data.

A GET /Users request causes the ListUsers event to be fired instead, with pagination reflected in the StartIndex and Count parameters and, for simple single-term filters such as userName eq "jsmith", the parsed FilterAttribute, FilterOperator, and FilterValue parameters. The AddUser method should be called once per matching user, and the TotalResults parameter should be set to the total across all pages.

scim.OnListUsers += (sender, e) => { var page = db.QueryUsers(e.FilterAttribute, e.FilterOperator, e.FilterValue, e.StartIndex - 1, e.Count); foreach (var user in page.Results) { scim.AddUser(user.Id, user.UserName, user.DisplayName, user.ExternalId, user.Active); } e.TotalResults = page.TotalCount; e.StatusCode = 200; };

Updating and Deleting Users

Both PUT /Users/{id} and PATCH /Users/{id} requests cause the UpdateUser event to be fired. For a PATCH request, the class first fires the GetUser event to load the current record, applies the patch operations from the request (including path-filtered operations such as emails[type eq "work"]) internally, and then fires the UpdateUser event with the fully merged result, so the handler always sees a complete, final representation of the user regardless of which method was used. The read-only RequestType property should be used if the handler needs to distinguish which method triggered the current event.

A DELETE /Users/{id} request causes the DeleteUser event to be fired. Deactivating a user without deleting their record is done the standard SCIM way, by setting the Active parameter to false through an update rather than issuing a delete.

Group Management

Groups follow the same pattern as users, and the CreateGroup, GetGroup, ListGroups, UpdateGroup, and DeleteGroup events all mirror their user counterparts. Group members are provided through the GroupMembers collection on create and update, and are added to an outgoing response with the AddGroupMember method. The AddGroup method is used to add each group to a ListGroups event response.

Discovery Endpoints

The class automatically answers the standard SCIM discovery endpoints so an Identity Provider can inspect your service provider's capabilities before provisioning begins.

A GET /ServiceProviderConfig request, which causes the GetServiceProviderConfig event to be fired, advertises the supported authentication scheme and which operations are enabled, based on the SupportedOperations property. GET /ResourceTypes requests, which cause the GetResourceTypes event to be fired, and GET /Schemas requests, which cause the GetSchemas event to be fired, describe the User and Group resource and schema definitions, including the enterprise user extension. All three events are informational, so the response body has already been generated by the time each one fires.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

SCIMWeb.AuthToken Property

The Bearer token used to authenticate incoming SCIM requests.

Syntax

getAuthToken(): string | null;
setAuthToken(authToken: string | null): void;

Default Value

""

Remarks

When this property is set, the class compares the incoming authorization bearer token against its value and initializes the Accept parameter of the AuthRequest event accordingly before the event fires. If the token is missing or does not match, the Accept parameter will be set to false. Likewise, if a match is found, the Accept parameter will be set to true. This value may be overridden in the handler when the AuthRequest event fires (e.g., the handler can reject a matching token to enforce expiry or check a revocation list).

This property only takes effect for Bearer authentication and has no influence on other authentication schemes.

When this property is empty, no automatic comparison is performed and Accept defaults to false. Without an AuthRequest handler that explicitly accepts the request, all incoming requests receive a 401 Unauthorized response.

SCIMWeb.BaseURL Property

The base URL path for SCIM endpoints.

Syntax

getBaseURL(): string | null;
setBaseURL(baseURL: string | null): void;

Default Value

"/scim/v2"

Remarks

This property defines the base path prefix the class uses when routing incoming requests to SCIM endpoints. All SCIM resource paths are resolved relative to this value (e.g., with the default value of /scim/v2, a request for /scim/v2/Users is recognized as a User list request).

This value must begin with a forward slash. Trailing slashes are removed automatically, so /scim/v2/ and /scim/v2 are equivalent.

SCIMWeb.GroupMembers Property

A collection of members for the current group.

Syntax

getGroupMembers(): SCIMMemberList;

Default Value

Remarks

This collection holds a list of SCIMMember items.

When the CreateGroup event is fired, this collection is populated with the members provided in the request. When the UpdateGroup event is fired, it is populated with the complete final member list. For a PATCH request, this reflects the group loaded via the GetGroup event with the patch operations applied. For a PUT request, it reflects the member list from the request body directly.

This property is read-only and not available at design time.

Please refer to the SCIMMember type for a complete list of fields.

SCIMWeb.MaxResults Property

The maximum number of resources requested from the application in a single list request.

Syntax

getMaxResults(): number;
setMaxResults(maxResults: number): void;

Default Value

200

Remarks

This property limits the Count parameter of the ListUsers and ListGroups events. When the Identity Provider omits the count query parameter or requests more results than this value, Count is set to this value. The class does not remove resources from the response, so the event handler should add no more than Count resources.

This value is also reported in the ServiceProviderConfig discovery endpoint as the maximum allowed value for pagination.

SCIMWeb.RequestBody Property

The body of the incoming SCIM request.

Syntax

getRequestBody(): string | null;
setRequestBody(requestBody: string | null): void;

Default Value

""

Remarks

This property is used before calling the ProcessRequest method to provide the request body directly. For SCIM operations that include a body (e.g., POST, PUT, PATCH), this must contain the raw JSON payload.

The request is passed to the class by setting the request properties before calling ProcessRequest, as shown.

scim.RequestMethod = request.Method; scim.RequestURI = request.RawUrl; scim.RequestHeaders = GetHeaderString(request); scim.RequestBody = new StreamReader(request.InputStream).ReadToEnd(); scim.ProcessRequest(); response.StatusCode = scim.ResponseStatus; response.Write(scim.ResponseBody);

SCIMWeb.RequestHeaders Property

The HTTP headers of the incoming SCIM request.

Syntax

getRequestHeaders(): string | null;
setRequestHeaders(requestHeaders: string | null): void;

Default Value

""

Remarks

This property is used before calling the ProcessRequest method to provide the request headers directly. Headers must be formatted as Name: Value pairs separated by CRLF or newline.

Authorization: Bearer secret-token Content-Type: application/scim+json

The request is passed to the class by setting the request properties before calling ProcessRequest, as shown.

scim.RequestMethod = request.Method; scim.RequestURI = request.RawUrl; scim.RequestHeaders = GetHeaderString(request); scim.RequestBody = new StreamReader(request.InputStream).ReadToEnd(); scim.ProcessRequest(); response.StatusCode = scim.ResponseStatus; response.Write(scim.ResponseBody);

SCIMWeb.RequestMethod Property

The HTTP method of the incoming SCIM request.

Syntax

getRequestMethod(): string | null;
setRequestMethod(requestMethod: string | null): void;

Default Value

""

Remarks

This property is used before calling the ProcessRequest method to provide the HTTP method directly. Common values include GET, POST, PUT, PATCH, and DELETE.

The request is passed to the class by setting the request properties before calling ProcessRequest, as shown.

scim.RequestMethod = request.Method; scim.RequestURI = request.RawUrl; scim.RequestHeaders = GetHeaderString(request); scim.RequestBody = new StreamReader(request.InputStream).ReadToEnd(); scim.ProcessRequest(); response.StatusCode = scim.ResponseStatus; response.Write(scim.ResponseBody);

SCIMWeb.RequestType Property

The HTTP method of the request currently being processed.

Syntax

getRequestType(): string | null;

Default Value

""

Remarks

This read-only property is used to determine the HTTP method (GET, POST, PUT, PATCH, or DELETE) of the request being processed. It is eligible to be queried during any event fired by the class.

When the class processes a PATCH request, it fires the GetUser or GetGroup event to retrieve the current resource first. When the ETagEnabled configuration setting is true and the client includes an If-Match header on a PUT or DELETE request, the GetUser or GetGroup event also fires to validate the ETag before the update or delete event.

This property is read-only.

SCIMWeb.RequestURI Property

The URI of the incoming SCIM request.

Syntax

getRequestURI(): string | null;
setRequestURI(requestURI: string | null): void;

Default Value

""

Remarks

This property is used before calling the ProcessRequest method to provide the request URI directly. The value should include the path and query string (e.g., /scim/v2/Users?filter=userName+eq+"jsmith").

The request is passed to the class by setting the request properties before calling ProcessRequest, as shown.

scim.RequestMethod = request.Method; scim.RequestURI = request.RawUrl; scim.RequestHeaders = GetHeaderString(request); scim.RequestBody = new StreamReader(request.InputStream).ReadToEnd(); scim.ProcessRequest(); response.StatusCode = scim.ResponseStatus; response.Write(scim.ResponseBody);

SCIMWeb.ResponseBody Property

The body of the SCIM response generated by the class.

Syntax

getResponseBody(): string | null;

Default Value

""

Remarks

After the ProcessRequest method returns, this property contains the JSON response body that must be written to the HTTP response. The value is a complete SCIM JSON document. For operations that produce no body (e.g., a successful DELETE, or a 304 Not Modified response when the ETagEnabled configuration setting is enabled), this property is empty.

This property is read-only.

SCIMWeb.ResponseHeaders Property

The HTTP headers of the SCIM response generated by the class.

Syntax

getResponseHeaders(): string | null;

Default Value

""

Remarks

After the ProcessRequest method returns, this property contains the CRLF-delimited response headers that must be written to the HTTP response. For responses with a JSON body, this includes a Content-Type header of application/scim+json, the media type specified for SCIM by RFC 7644. For 204 No Content responses, such as successful deletes, and 304 Not Modified responses, no Content-Type header is included.

This property is read-only.

SCIMWeb.ResponseStatus Property

The HTTP status code of the SCIM response generated by the class.

Syntax

getResponseStatus(): number;

Default Value

0

Remarks

After the ProcessRequest method returns, this property contains the HTTP status code that must be written to the HTTP response (e.g., 200, 201, 204, 400, 401, 404).

This property is read-only.

SCIMWeb.SupportedOperations Property

A bitmask that controls which SCIM operations the class accepts.

Syntax

getSupportedOperations(): number;
setSupportedOperations(supportedOperations: number): void;

Default Value

65535

Remarks

This property determines which SCIM operations are enabled. Requests for disabled operations receive a 501 Not Implemented response. The following flags are defined (specified in hexadecimal notation) and may be combined:

Bits not listed above are reserved for future use and are currently ignored. sopAll is defined as 0xFFFF to include any operations added in future versions.

Note that PUT and PATCH requests share the same flag (sopUserUpdate / sopGroupUpdate). Enabling the flag accepts both methods, and disabling it rejects both. For PATCH requests, the class retrieves the current resource via GetUser or GetGroup, applies the patch operations, then fires UpdateUser or UpdateGroup with the merged result.

When the ETagEnabled configuration setting is enabled and a PUT or DELETE request includes an If-Match header, the class also fires GetUser or GetGroup to validate the ETag before the update or delete event fires.

The discovery endpoints (/ServiceProviderConfig, /ResourceTypes, /Schemas) are always available regardless of this property's value.

The capabilities advertised in the ServiceProviderConfig discovery endpoint are derived from this property automatically.

SCIMWeb.UserEmails Property

A collection of email addresses for the current inbound user.

Syntax

getUserEmails(): SCIMEmailList;

Default Value

Remarks

This collection holds a list of SCIMEmail items.

When the CreateUser event is fired, this collection is populated with the email addresses provided in the request. When the UpdateUser event is fired, it is populated with the complete final email address list. For a PATCH request, this reflects the user loaded via the GetUser event with the patch operations applied. For a PUT request, it reflects the email address list from the request body directly. Each entry exposes an Address, EmailType, and Primary field.

To include email addresses in an outgoing response, the Address value should be passed to the Address parameter when calling the AddUserEmail method.

This property is read-only and not available at design time.

Please refer to the SCIMEmail type for a complete list of fields.

SCIMWeb.UserExtension Property

The enterprise extension attributes for the current inbound user.

Syntax

getUserExtension(): SCIMExtension | null;

Default Value

Remarks

When the CreateUser event is fired, this property contains the enterprise extension attributes provided in the request. When the UpdateUser event is fired, it contains the final values. For a PATCH request, this reflects the user loaded via the GetUser event with the patch operations applied. For a PUT request, it reflects the enterprise extension attributes from the request body directly.

This property exposes the following fields: Department, EmployeeNumber, CostCenter, Organization, Division, ManagerId, ManagerRef, and ManagerDisplayName. The class will set any fields not included in the request to "" (empty string).

To include enterprise extension data in an outgoing response, the AddUserExtension method should be called.

The class natively supports the SCIM enterprise user extension schema (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User). The extension schema namespace is handled internally. The API exposes extension attributes directly without requiring the URN to be specified. Additional extension schemas may be supported in future releases.

This property is read-only and not available at design time.

Please refer to the SCIMExtension type for a complete list of fields.

SCIMWeb.UserPhones Property

A collection of phone numbers for the current inbound user.

Syntax

getUserPhones(): SCIMPhoneList;

Default Value

Remarks

This collection holds a list of SCIMPhone items.

When the CreateUser event is fired, this collection is populated with the phone numbers provided in the request. When the UpdateUser event is fired, it is populated with the complete final phone number list. For a PATCH request, this reflects the user loaded via the GetUser event with the patch operations applied. For a PUT request, it reflects the phone number list from the request body directly. Each entry exposes a Number, PhoneType, and Primary field.

To include phone numbers in an outgoing response, the Number value should be passed to the Number parameter when calling the AddUserPhone method.

This property is read-only and not available at design time.

Please refer to the SCIMPhone type for a complete list of fields.

SCIMWeb.addGroup Method

Adds a group entry to the outgoing list response.

Syntax

async scimweb.addGroup(groupId : string | null, displayName : string | null, externalId : string | null): Promise<void>

Remarks

This method should be called within a ListGroups event handler once for each group in the current page of results. The class then assembles all added entries into the SCIM ListResponse envelope.

GroupId is the unique identifier for the group, and DisplayName may be empty if not available.

The stored ExternalId should be passed for the group (or "" (empty string) if not recorded).

After all entries have been added, the TotalResults event parameter should be set to the total number of matching groups across all pages, which may be greater than the number of entries added in the current method call.

scim.OnListGroups += (sender, e) => { var page = db.QueryGroups(e.FilterAttribute, e.FilterOperator, e.FilterValue, e.StartIndex - 1, e.Count); foreach (var group in page.Results) { scim.AddGroup(group.Id, group.DisplayName, group.ExternalId); } e.TotalResults = page.TotalCount; e.StatusCode = 200; };

SCIMWeb.addGroupMember Method

Adds a member to the outgoing group response.

Syntax

async scimweb.addGroupMember(groupId : string | null, memberId : string | null, memberDisplay : string | null): Promise<void>

Remarks

This method should be called within a GetGroup or ListGroups event handler once for each group member to be included in the SCIM response.

GroupId identifies the group to which the member belongs, and MemberId and MemberDisplay represent the SCIM resource ID and display name of the member user, respectively.

scim.OnGetGroup += (sender, e) => { var group = db.FindGroup(e.GroupId); e.DisplayName = group.DisplayName; e.ExternalId = group.ExternalId; foreach (var member in group.Members) { scim.AddGroupMember(e.GroupId, member.UserId, member.DisplayName); } e.StatusCode = 200; };

SCIMWeb.addUser Method

Adds a user entry to the outgoing list response.

Syntax

async scimweb.addUser(userId : string | null, userName : string | null, displayName : string | null, externalId : string | null, active : boolean): Promise<void>

Remarks

This method should be called within a ListUsers event handler once for each user in the current page of results. The class then assembles all added entries into the SCIM ListResponse envelope.

UserId is the unique identifier for the user, UserName is the user's SCIM username, and DisplayName may be empty if not available.

The stored ExternalId should be passed for the user (or "" (empty string) if not recorded). Active indicates whether the user account is enabled.

After all entries have been added, the TotalResults event parameter should be set to the total number of matching users across all pages, which may be greater than the number of entries added in the current method call.

void scim_ListUsers(object sender, SCIMWebListUsersEventArgs e) { var results = db.QueryUsers(e.FilterAttribute, e.FilterOperator, e.FilterValue, e.StartIndex - 1, e.Count); foreach (var user in results.Page) scim.AddUser(user.Id, user.UserName, user.DisplayName, user.ExternalId, user.Active); e.TotalResults = results.TotalCount; e.StatusCode = 0; }

SCIMWeb.addUserEmail Method

Adds an email address to the outgoing user response.

Syntax

async scimweb.addUserEmail(userId : string | null, address : string | null, emailType : string | null, primary : boolean): Promise<void>

Remarks

This method should be called within a GetUser or ListUsers event handler once for each user's email address to be included in the response.

UserId identifies which user the address belongs to. Address is the email address string, and EmailType classifies the address (common values include work, home, and other). Primary should be set to true only for the user's primary address.

scim.OnGetUser += (sender, e) => { var user = db.FindUser(e.UserId); e.UserName = user.UserName; e.DisplayName = user.DisplayName; e.Active = user.Active; foreach (var email in user.Emails) { scim.AddUserEmail(e.UserId, email.Address, email.EmailType, email.Primary); } e.StatusCode = 200; };

SCIMWeb.addUserExtension Method

Adds enterprise extension attributes to the outgoing user response.

Syntax

async scimweb.addUserExtension(userId : string | null, department : string | null, employeeNumber : string | null, costCenter : string | null, organization : string | null, division : string | null, managerId : string | null, managerRef : string | null, managerDisplayName : string | null): Promise<void>

Remarks

This method should be called within a GetUser or ListUsers event handler once for each user's enterprise extension data to be included in the response.

UserId identifies which user the data belongs to. Department, EmployeeNumber, CostCenter, Organization, and Division are the enterprise user attributes.

ManagerId is the user identifier of the user's manager, ManagerRef is the full URI of the manager's user resource, and ManagerDisplayName is the manager's display name.

"" (empty string) should be passed for any attribute that is not applicable or not stored.

scim.OnGetUser += (sender, e) => { var user = db.FindUser(e.UserId); e.UserName = user.UserName; e.DisplayName = user.DisplayName; e.Active = user.Active; if (user.HasManager) { scim.AddUserExtension(e.UserId, user.Department, user.EmployeeNumber, user.CostCenter, user.Organization, user.Division, user.ManagerId, "", user.ManagerDisplayName); } e.StatusCode = 200; };

The class natively supports the SCIM enterprise user extension schema (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User). The extension schema namespace is handled internally. The API exposes extension attributes directly without requiring the URN to be specified. Additional extension schemas may be supported in future releases.

SCIMWeb.addUserPhone Method

Adds a phone number to the outgoing user response.

Syntax

async scimweb.addUserPhone(userId : string | null, number : string | null, phoneType : string | null, primary : boolean): Promise<void>

Remarks

This method should be called within a GetUser or ListUsers event handler once for each user's phone number to be included in the response.

UserId identifies which user the number belongs to. Number is the phone number string, and PhoneType classifies the number (common values include work, mobile, home, and other). Primary should be set to true only for the user's primary number.

scim.OnGetUser += (sender, e) => { var user = db.FindUser(e.UserId); e.UserName = user.UserName; e.DisplayName = user.DisplayName; e.Active = user.Active; foreach (var phone in user.Phones) { scim.AddUserPhone(e.UserId, phone.Number, phone.PhoneType, phone.Primary); } e.StatusCode = 200; };

SCIMWeb.config Method

Sets or retrieves a configuration setting.

Syntax

async scimweb.config(configurationString : string | null): Promise<string | null>

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

SCIMWeb.processRequest Method

Processes an incoming SCIM request and generates a response.

Syntax

async scimweb.processRequest(): Promise<void>

Remarks

This method is used as the primary entry point for the SCIMWeb class and should be called from your web framework's request handler whenever a request is received for the SCIM base URL.

The RequestMethod, RequestURI, RequestHeaders, and RequestBody properties supply the request to the class and must be set before this method is called. These properties are not cleared automatically after ProcessRequest returns, so when they are set explicitly, a new value should be assigned to each of them before every subsequent call.

Internally, the class authenticates the request (i.e., fires the AuthRequest event), routes it to the appropriate resource handler, fires the corresponding event (such as CreateUser or ListGroups), and assembles the response. The ResponseStatus, ResponseHeaders, and ResponseBody properties are populated with the response.

Manual Request Passing Example

scim.RequestMethod = request.Method; scim.RequestURI = request.RawUrl; scim.RequestHeaders = GetHeaderString(request); scim.RequestBody = new StreamReader(request.InputStream).ReadToEnd(); scim.ProcessRequest(); response.StatusCode = scim.ResponseStatus; response.Write(scim.ResponseBody);

SCIMWeb.reset Method

This method will reset the class.

Syntax

async scimweb.reset(): Promise<void>

Remarks

This method will reset the class's properties to their default values.

SCIMWeb.AuthRequest Event

Fired for every incoming request to control access to specific endpoints.

Syntax

scimweb.on('AuthRequest', listener: (e: {readonly requestId: string | null, readonly authMethod: string | null, readonly user: string | null, readonly token: string | null, accept: boolean}) => void )

Remarks

This event fires for every incoming request before any resource event is raised, allowing the application to implement custom authentication logic.

The AuthMethod parameter identifies the authentication scheme supplied by the client.

The Accept value may be changed when additional logic outside of the class is required (e.g., to enforce token expiry, check a revocation list, or accept an alternative authentication scheme).

Requests rejected by this event receive a 401 Unauthorized response.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

Note that this event is not fired when the AuthEnabled configuration setting is disabled.

Custom validation covering multiple authentication schemes may be performed as shown.

scim.OnAuthRequest += (sender, e) => { if (e.AuthMethod == "Bearer") { e.Accept = tokenStore.IsValid(e.Token); } else if (e.AuthMethod == "Basic") { e.Accept = userStore.CheckPassword(e.User, e.Token); } else { e.Accept = false; } };

SCIMWeb.CreateGroup Event

Fired when a request to create a new group is received.

Syntax

scimweb.on('CreateGroup', listener: (e: {readonly requestId: string | null, readonly externalId: string | null, readonly displayName: string | null, groupId: string | null, statusCode: number}) => void )

Remarks

This event fires when the class receives a POST /Groups request from the Identity Provider. The inbound group attributes are provided as event parameters.

If the Identity Provider included an externalId in the request, it is made available in the ExternalId parameter. This value should be stored alongside the group record so it can be returned in future GetGroup event responses.

If the request includes group members, they are made available via the GroupMembers collection, where each entry exposes a MemberId and MemberDisplay field.

If the group is created successfully, the GroupId parameter must be set to the newly assigned identifier, and the StatusCode parameter must be set to 201. The full created resource is returned to the Identity Provider in the 201 Created response body. To signal an error, StatusCode must be set to the appropriate HTTP status code (e.g., 409 for a duplicate group). The StatusCode parameter defaults to 500, and a value of 0 is treated as 201.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.CreateUser Event

Fired when a request to create a new user is received.

Syntax

scimweb.on('CreateUser', listener: (e: {readonly requestId: string | null, readonly externalId: string | null, readonly userName: string | null, readonly givenName: string | null, readonly familyName: string | null, readonly displayName: string | null, readonly active: boolean, userId: string | null, statusCode: number}) => void )

Remarks

This event fires when the class receives a POST /Users request from the Identity Provider. The inbound user attributes are provided as event parameters.

If the Identity Provider included an externalId in the request, it is made available in the ExternalId parameter. This value should be stored alongside the user record so it can be returned in future GetUser event responses.

The Active parameter indicates whether the new user account should be enabled. If the Identity Provider does not include an active attribute in the request, Active defaults to true.

Email addresses and phone numbers supplied in the request are made available via the UserEmails and UserPhones collections, where each entry exposes an Address, EmailType, and Primary field (for emails) or a Number, PhoneType, and Primary field (for phones). If the Identity Provider included enterprise extension attributes in the request, they are also made available via the UserExtension property.

If the user is created successfully, the UserId parameter must be set to the newly assigned identifier, and the StatusCode parameter must be set to 201. The full created resource is returned to the Identity Provider in the 201 Created response body. To signal an error, StatusCode must be set to the appropriate HTTP status code (e.g., 409 for a duplicate user). The StatusCode parameter defaults to 500, and a value of 0 is treated as 201.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.DeleteGroup Event

Fired when a request to delete a group is received.

Syntax

scimweb.on('DeleteGroup', listener: (e: {readonly requestId: string | null, readonly groupId: string | null, statusCode: number}) => void )

Remarks

This event fires when the class receives a DELETE /Groups/{id} request from the Identity Provider. The GroupId parameter identifies the group to delete.

If the deletion is successful, the StatusCode parameter must be set to 204. The class then returns a 204 No Content response. If the group is not found, StatusCode must be set to 404. The StatusCode parameter defaults to 500, and a value of 0 is treated as 204.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.DeleteUser Event

Fired when a request to delete a user is received.

Syntax

scimweb.on('DeleteUser', listener: (e: {readonly requestId: string | null, readonly userId: string | null, statusCode: number}) => void )

Remarks

This event fires when the class receives a DELETE /Users/{id} request from the Identity Provider. The UserId parameter identifies the user to delete.

If the deletion is successful, the StatusCode parameter must be set to 204. The class then returns a 204 No Content response. If the user is not found, StatusCode must be set to 404. The StatusCode parameter defaults to 500, and a value of 0 is treated as 204.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.Error Event

Fired when an error occurs while processing a SCIM request.

Syntax

scimweb.on('Error', listener: (e: {readonly requestId: string | null, readonly errorCode: number, readonly description: string | null}) => void )

Remarks

This event fires when the class cannot complete a SCIM request, immediately before the error response is returned to the Identity Provider. It fires both for requests the class itself rejects, such as a malformed request body or a failed authentication, and for requests an application event handler rejects by setting its StatusCode parameter to 400 or higher.

ErrorCode identifies the condition. Requests rejected by the class report one of the codes listed in the Error Codes section, while a status returned by an application event handler reports the generic error code 1.

Description is the message carried in the detail field of the SCIM error response body.

This event is informational. The HTTP status and the response body have already been determined by the time it fires, so a handler cannot suppress the error or change what is returned to the Identity Provider.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.GetGroup Event

Fired when a request to retrieve a group is received, before a PATCH group update, or when ETags are enabled and a PUT or DELETE request includes an If-Match header.

Syntax

scimweb.on('GetGroup', listener: (e: {readonly requestId: string | null, readonly groupId: string | null, externalId: string | null, displayName: string | null, statusCode: number}) => void )

Remarks

This event fires when the class receives a GET /Groups/{id} request from the Identity Provider. It also fires before processing a PATCH /Groups/{id} request, or when the ETagEnabled configuration setting is true and a PUT /Groups/{id} or DELETE /Groups/{id} request includes an If-Match header. The GroupId parameter identifies the group to retrieve.

The DisplayName must be set to the group's display name. If an ExternalId was stored for this group, it must be set as well. To include group members in the response, the AddGroupMember method should be called once for each member. This event must supply the full group for a PATCH request to work correctly.

When the group is found, the StatusCode parameter must be set to 200. If the group is not found, StatusCode must be set to 404.

The RequestType property may be used to determine whether this event was fired by a direct GET request or internally before a PATCH or a conditional PUT/DELETE.

The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.GetResourceTypes Event

Fired when a request for the resource type definitions is received.

Syntax

scimweb.on('GetResourceTypes', listener: (e: {readonly requestId: string | null, readonly responseBody: string, readonly responseBodyB: Uint8Array | null}) => void )

Remarks

This event fires when the class receives a GET /ResourceTypes request from the Identity Provider. The class returns the standard SCIM User and Group resource type definitions automatically and populates the ResponseBody parameter with the serialized JSON before firing this event.

This event is informational and may be used to log or audit discovery requests and inspect the generated response.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.GetSchemas Event

Fired when a request for the schema definitions is received.

Syntax

scimweb.on('GetSchemas', listener: (e: {readonly requestId: string | null, readonly responseBody: string, readonly responseBodyB: Uint8Array | null}) => void )

Remarks

This event fires when the class receives a GET /Schemas request from the Identity Provider. The class returns the standard SCIM User and Group schema definitions, including the enterprise user extension, automatically and populates the ResponseBody parameter with the serialized JSON before firing this event.

This event is informational and may be used to log or audit discovery requests and inspect the generated response.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.GetServiceProviderConfig Event

Fired when a request for the service provider configuration is received.

Syntax

scimweb.on('GetServiceProviderConfig', listener: (e: {readonly requestId: string | null, readonly responseBody: string, readonly responseBodyB: Uint8Array | null}) => void )

Remarks

This event fires when the class receives a GET /ServiceProviderConfig request from the Identity Provider. The class generates the configuration document automatically based on the SupportedOperations and MaxResults properties and populates the ResponseBody parameter with the serialized JSON before firing this event.

This event is informational and may be used to log or audit discovery requests and inspect the generated response.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.GetUser Event

Fired when a request to retrieve a user is received, before a PATCH user update, or when ETags are enabled and a PUT or DELETE request includes an If-Match header.

Syntax

scimweb.on('GetUser', listener: (e: {readonly requestId: string | null, readonly userId: string | null, externalId: string | null, userName: string | null, givenName: string | null, familyName: string | null, displayName: string | null, active: boolean, statusCode: number}) => void )

Remarks

This event fires when the class receives a GET /Users/{id} request from the Identity Provider. It also fires before processing a PATCH /Users/{id} request, or when the ETagEnabled configuration setting is true and a PUT /Users/{id} or DELETE /Users/{id} request includes an If-Match header. The UserId parameter identifies the user to retrieve.

The output parameters (i.e., UserName, GivenName, FamilyName, DisplayName, Active) must be set to the current user data. If an ExternalId was stored for this user, it must be set as well. To include email addresses, phone numbers, and enterprise extension data in the response, the AddUserEmail, AddUserPhone, and AddUserExtension methods should be called once for each address, number, and user with extension data on record. This event must supply the full user for a PATCH request to work correctly.

When the user is found, the StatusCode parameter must be set to 200. If the user is not found, StatusCode must be set to 404.

The RequestType property may be used to determine whether this event was fired by a direct GET request or internally before a PATCH or a conditional PUT/DELETE.

The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.ListGroups Event

Fired when a request to list groups is received.

Syntax

scimweb.on('ListGroups', listener: (e: {readonly requestId: string | null, readonly filter: string | null, readonly filterAttribute: string | null, readonly filterOperator: string | null, readonly filterValue: string | null, readonly startIndex: number, readonly count: number, totalResults: number, statusCode: number}) => void )

Remarks

This event fires when the class receives a GET /Groups request from the Identity Provider. The Filter parameter contains the raw SCIM filter expression from the request, or "" (empty string) if no filter was specified. For simple single-term filters (e.g., displayName eq "Admins"), the FilterAttribute, FilterOperator, and FilterValue parameters are also populated with the parsed components for convenience. For compound or nested filter expressions, only Filter is populated. The application must parse it directly.

The StartIndex and Count parameters reflect the pagination values from the request. StartIndex is 1-based, and Count is capped by the value of the MaxResults property. When the Identity Provider does not include a count parameter, Count defaults to MaxResults. The application should use these values to query its data source and return only the matching page of results. The sortBy and sortOrder query parameters are not currently supported and are ignored when received.

The AddGroup method must be called once for each group in the current page of results, after which the TotalResults parameter must be set to the total number of matching groups across all pages. To include members for each group, the AddGroupMember method may be called as needed. The StatusCode must be set to 200 when the operation succeeds.

To signal an error, StatusCode must be set to the appropriate HTTP status code. The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.ListUsers Event

Fired when a request to list users is received.

Syntax

scimweb.on('ListUsers', listener: (e: {readonly requestId: string | null, readonly filter: string | null, readonly filterAttribute: string | null, readonly filterOperator: string | null, readonly filterValue: string | null, readonly startIndex: number, readonly count: number, totalResults: number, statusCode: number}) => void )

Remarks

This event fires when the class receives a GET /Users request from the Identity Provider. The Filter parameter contains the raw SCIM filter expression from the request, or "" (empty string) if no filter was specified. For simple single-term filters (e.g., userName eq "jsmith"), the FilterAttribute, FilterOperator, and FilterValue parameters are also populated with the parsed components for convenience. For compound or nested filter expressions, only Filter is populated. The application must parse it directly.

The StartIndex and Count parameters reflect the pagination values from the request. StartIndex is 1-based, and Count is capped by the value of the MaxResults property. When the Identity Provider does not include a count parameter, Count defaults to MaxResults. The application should use these values to query its data source and return only the matching page of results. The sortBy and sortOrder query parameters are not currently supported and are ignored when received.

The AddUser method must be called once for each user in the current page of results. To include email addresses, phone numbers, or enterprise extension data for each user, the AddUserEmail, AddUserPhone, and AddUserExtension methods may be called as needed. After all users have been added, the TotalResults parameter must be set to the total number of matching users across all pages. This value may be greater than Count if the result set is paginated. The StatusCode must be set to 200 when the operation succeeds.

To signal an error, StatusCode must be set to the appropriate HTTP status code. The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.Log Event

Fired once for each log message.

Syntax

scimweb.on('Log', listener: (e: {readonly requestId: string | null, readonly logLevel: number, readonly message: string | null, readonly logType: string | null}) => void )

Remarks

This event fires once for each log message generated by the class while it processes a SCIM request. The verbosity is controlled by the LogLevel configuration setting.

LogLevel indicates the level of the message. Possible values are as follows:

Message is the log entry.

LogType is always SCIM for this class.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.UpdateGroup Event

Fired after the current group has been loaded and a replace or update request has been applied.

Syntax

scimweb.on('UpdateGroup', listener: (e: {readonly requestId: string | null, readonly groupId: string | null, readonly externalId: string | null, readonly displayName: string | null, statusCode: number}) => void )

Remarks

This event fires when the class receives a PUT /Groups/{id} or PATCH /Groups/{id} request from the Identity Provider. For PUT, the event parameters reflect the full group representation from the request body directly. For PATCH, the class first retrieves the current group via the GetGroup event, applies the patch operations, then fires this event.

For a PUT request, the ExternalId parameter contains the externalId value from the request body, or "" (empty string) if not provided.

For a PUT request, the provided DisplayName and member list should be applied to the group identified by GroupId, and any attributes not present in the request should be cleared. For a PATCH request, the event parameters likewise reflect the complete final group, with the values loaded through the GetGroup event and the patch operations applied on top. All parameters should be applied in the same way, since any attribute the patch did not touch carries its original value.

Updated members are made available via the GroupMembers collection. The collection always reflects the full current member list after the request is applied. All stored members should be replaced with the collection contents.

When the update succeeds, StatusCode must be set to 200. It may also be set to 204, which is valid when the updated resource does not need to be returned, causing the class to return a 204 No Content response with no body. Some Identity Providers require a 200 response with the updated resource body. Check your Identity Provider's SCIM implementation guide before returning 204. If the group is not found, StatusCode must be set to 404. The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMWeb.UpdateUser Event

Fired after the current user has been loaded and a replace or update request has been applied.

Syntax

scimweb.on('UpdateUser', listener: (e: {readonly requestId: string | null, readonly userId: string | null, readonly externalId: string | null, readonly userName: string | null, readonly givenName: string | null, readonly familyName: string | null, readonly displayName: string | null, readonly active: boolean, statusCode: number}) => void )

Remarks

This event fires when the class receives a PUT /Users/{id} or PATCH /Users/{id} request from the Identity Provider. For PUT, the event parameters reflect the full user representation from the request body directly. For PATCH, the class first retrieves the current user via the GetUser event, applies the patch operations, then fires this event.

For a PUT request, the ExternalId parameter contains the externalId value from the request body, or "" (empty string) if not provided.

For a PUT request, all event parameters should be applied to the user identified by UserId, and any attributes not present in the request should be cleared. For a PATCH request, the event parameters likewise reflect the complete final user, with the values loaded through the GetUser event and the patch operations applied on top. All parameters should be applied in the same way, since any attribute the patch did not touch carries its original value.

The Active parameter reflects the user's active state. For a PUT request, Active defaults to true if active is absent from the request body.

Email addresses and phone numbers are made available via the UserEmails and UserPhones collections. The collections always reflect the full current state of the user after the request is applied. All stored entries should be replaced with the collection contents. Enterprise extension attributes are made available via the UserExtension property and likewise reflect the full current state after the request is applied.

When the update succeeds, StatusCode must be set to 200. It may also be set to 204, which is valid when the updated resource does not need to be returned, causing the class to return a 204 No Content response with no body. Some Identity Providers require a 200 response with the updated resource body. Check your Identity Provider's SCIM implementation guide before returning 204. If the user is not found, StatusCode must be set to 404. The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.

SCIMEmail Type

An email address associated with a SCIM user.

Remarks

This type represents a single email address entry in a SCIM user resource, including its type classification and whether it is the primary address.

• Address
• EmailType
• Primary

Fields

Constructors

public SCIMEmail();

SCIMExtension Type

Enterprise extension attributes associated with a SCIM user.

Remarks

This type represents the enterprise extension attributes defined by the urn:ietf:params:scim:schemas:extension:enterprise:2.0:User schema. It is exposed via the UserExtension property during create and update events, and populated via the AddUserExtension method in get and list events.

• CostCenter
• Department
• Division
• EmployeeNumber
• ManagerDisplayName
• ManagerId
• ManagerRef
• Organization

Fields

Constructors

public SCIMExtension();

SCIMMember Type

A member entry associated with a SCIM group.

Remarks

This type represents a single member of a SCIM group resource, including the member's resource ID and display name.

• MemberDisplay
• MemberId

Fields

Constructors

public SCIMMember();

SCIMPhone Type

A phone number associated with a SCIM user.

Remarks

This type represents a single phone number entry in a SCIM user resource, including its type classification and whether it is the primary number.

• Number
• PhoneType
• Primary

Fields

Constructors

public SCIMPhone();

Config Settings (SCIMWeb Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SCIMWeb Config Settings

Base Config Settings

Trappable Errors (SCIMWeb Class)

SCIMWeb Errors