SCIMWeb Component
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 component 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 component, which hosts its own embedded HTTP server, this component 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 component 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 component 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.
| Bearer | The scheme used by most Identity Provider integrations. The Token parameter contains the raw bearer token. If the AuthToken property has been set, the component automatically compares it against the incoming token and pre-initializes the Accept parameter with the result, so a simple deployment does not need an AuthRequest handler at all. |
| Basic | The component decodes the credentials and provides the username and password through the User and Token parameters. No automatic comparison is performed. |
| Other/Unrecognized | The Accept parameter defaults to false and the application must explicitly accept the request from within an AuthRequest handler. |
| "" (empty string) | No Authorization header was present. User and Token are both empty and the Accept parameter defaults to false. |
A static bearer token may be supplied to the component 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 component 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 properties 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 component 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 properties 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 component 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 component with short descriptions. Click on the links for further details.
| AuthToken | The Bearer token used to authenticate incoming SCIM requests. |
| BaseURL | The base URL path for SCIM endpoints. |
| GroupMemberCount | The number of records in the GroupMember arrays. |
| GroupMemberMemberDisplay | The display name of the group member. |
| GroupMemberMemberId | The SCIM resource ID of the group member. |
| MaxResults | The maximum number of resources requested from the application in a single list request. |
| RequestBody | The body of the incoming SCIM request. |
| RequestHeaders | The HTTP headers of the incoming SCIM request. |
| RequestMethod | The HTTP method of the incoming SCIM request. |
| RequestType | The HTTP method of the request currently being processed. |
| RequestURI | The URI of the incoming SCIM request. |
| ResponseBody | The body of the SCIM response generated by the class. |
| ResponseHeaders | The HTTP headers of the SCIM response generated by the class. |
| ResponseStatus | The HTTP status code of the SCIM response generated by the class. |
| SupportedOperations | A bitmask that controls which SCIM operations the class accepts. |
| UserEmailCount | The number of records in the UserEmail arrays. |
| UserEmailAddress | The email address. |
| UserEmailType | The type of email address. |
| UserEmailPrimary | Whether this is the primary email address. |
| UserExtensionCostCenter | The user's cost center. |
| UserExtensionDepartment | The user's department. |
| UserExtensionDivision | The user's division. |
| UserExtensionEmployeeNumber | The user's employee number. |
| UserExtensionManagerDisplayName | The display name of the user's manager. |
| UserExtensionManagerId | The user identifier of the user's manager. |
| UserExtensionManagerRef | The URI of the manager's user resource. |
| UserExtensionOrganization | The user's organization. |
| UserPhoneCount | The number of records in the UserPhone arrays. |
| UserPhoneNumber | The phone number. |
| UserPhoneType | The type of phone number. |
| UserPhonePrimary | Whether this is the primary phone number. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddGroup | Adds a group entry to the outgoing list response. |
| AddGroupMember | Adds a member to the outgoing group response. |
| AddUser | Adds a user entry to the outgoing list response. |
| AddUserEmail | Adds an email address to the outgoing user response. |
| AddUserExtension | Adds enterprise extension attributes to the outgoing user response. |
| AddUserPhone | Adds a phone number to the outgoing user response. |
| Config | Sets or retrieves a configuration setting. |
| ProcessRequest | Processes an incoming SCIM request and generates a response. |
| Reset | This method will reset the class. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| AuthRequest | Fired for every incoming request to control access to specific endpoints. |
| CreateGroup | Fired when a request to create a new group is received. |
| CreateUser | Fired when a request to create a new user is received. |
| DeleteGroup | Fired when a request to delete a group is received. |
| DeleteUser | Fired when a request to delete a user is received. |
| Error | Fired when an error occurs while processing a SCIM request. |
| GetGroup | 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. |
| GetResourceTypes | Fired when a request for the resource type definitions is received. |
| GetSchemas | Fired when a request for the schema definitions is received. |
| GetServiceProviderConfig | Fired when a request for the service provider configuration is received. |
| GetUser | 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. |
| ListGroups | Fired when a request to list groups is received. |
| ListUsers | Fired when a request to list users is received. |
| Log | Fired once for each log message. |
| UpdateGroup | Fired after the current group has been loaded and a replace or update request has been applied. |
| UpdateUser | Fired after the current user has been loaded and a replace or update request has been applied. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
| AuthEnabled | Whether incoming HTTP authentication credentials are validated. |
| ETagEnabled | Whether to include ETag headers in user and group responses. |
| IgnoreUnknownPatchAttributes | Whether to ignore PATCH operations that target unsupported attributes. |
| LogLevel | Controls the level of detail that is logged through the Log event. |
| RequestBody | The body of the most recently received SCIM request. |
| XChildCount | The number of child elements of the current JSON element. |
| XChildName[i] | The name of a child JSON element. |
| XChildXText[i] | The text of a child JSON element. |
| XElement | The name of the current JSON element. |
| XParent | The parent of the current JSON element. |
| XPath | Selects an element in the most recently received SCIM JSON request. |
| XSubTree | A snapshot of the current JSON element. |
| XText | The text of the current JSON element. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AuthToken Property (SCIMWeb Component)
The Bearer token used to authenticate incoming SCIM requests.
Syntax
func (obj *SCIMWeb) AuthToken() (string, error)
func (obj *SCIMWeb) SetAuthToken(value string) error
Default Value
""
Remarks
When this property is set, the component 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.
Data Type
string
BaseURL Property (SCIMWeb Component)
The base URL path for SCIM endpoints.
Syntax
func (obj *SCIMWeb) BaseURL() (string, error)
func (obj *SCIMWeb) SetBaseURL(value string) error
Default Value
"/scim/v2"
Remarks
This property defines the base path prefix the component 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.
Data Type
string
GroupMemberCount Property (SCIMWeb Component)
The number of records in the GroupMember arrays.
Syntax
func (obj *SCIMWeb) GroupMemberCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at GroupMemberCount - 1.This property is read-only.
Data Type
int32
GroupMemberMemberDisplay Property (SCIMWeb Component)
The display name of the group member.
Syntax
func (obj *SCIMWeb) GroupMemberMemberDisplay(GroupMemberIndex int32) (string, error)
Default Value
""
Remarks
The display name of the group member.
This property contains the display name of the member user as provided by the Identity Provider. It may be empty if the Identity Provider did not supply a display name.
The GroupMemberIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupMemberCount property.
This property is read-only.
Data Type
string
GroupMemberMemberId Property (SCIMWeb Component)
The SCIM resource ID of the group member.
Syntax
func (obj *SCIMWeb) GroupMemberMemberId(GroupMemberIndex int32) (string, error)
Default Value
""
Remarks
The SCIM resource ID of the group member.
This property contains the unique identifier of the member user as assigned by the service provider.
The GroupMemberIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupMemberCount property.
This property is read-only.
Data Type
string
MaxResults Property (SCIMWeb Component)
The maximum number of resources requested from the application in a single list request.
Syntax
func (obj *SCIMWeb) MaxResults() (int32, error)
func (obj *SCIMWeb) SetMaxResults(value int32) error
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 component 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.
Data Type
int32
RequestBody Property (SCIMWeb Component)
The body of the incoming SCIM request.
Syntax
func (obj *SCIMWeb) RequestBody() (string, error)
func (obj *SCIMWeb) SetRequestBody(value string) error
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 component 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);
Data Type
string
RequestHeaders Property (SCIMWeb Component)
The HTTP headers of the incoming SCIM request.
Syntax
func (obj *SCIMWeb) RequestHeaders() (string, error)
func (obj *SCIMWeb) SetRequestHeaders(value string) error
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 component 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);
Data Type
string
RequestMethod Property (SCIMWeb Component)
The HTTP method of the incoming SCIM request.
Syntax
func (obj *SCIMWeb) RequestMethod() (string, error)
func (obj *SCIMWeb) SetRequestMethod(value string) error
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 component 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);
Data Type
string
RequestType Property (SCIMWeb Component)
The HTTP method of the request currently being processed.
Syntax
func (obj *SCIMWeb) RequestType() (string, error)
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 component.
When the component 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.
Data Type
string
RequestURI Property (SCIMWeb Component)
The URI of the incoming SCIM request.
Syntax
func (obj *SCIMWeb) RequestURI() (string, error)
func (obj *SCIMWeb) SetRequestURI(value string) error
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 component 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);
Data Type
string
ResponseBody Property (SCIMWeb Component)
The body of the SCIM response generated by the class.
Syntax
func (obj *SCIMWeb) ResponseBody() (string, error)
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.
Data Type
string
ResponseHeaders Property (SCIMWeb Component)
The HTTP headers of the SCIM response generated by the class.
Syntax
func (obj *SCIMWeb) ResponseHeaders() (string, error)
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.
Data Type
string
ResponseStatus Property (SCIMWeb Component)
The HTTP status code of the SCIM response generated by the class.
Syntax
func (obj *SCIMWeb) ResponseStatus() (int32, error)
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.
Data Type
int32
SupportedOperations Property (SCIMWeb Component)
A bitmask that controls which SCIM operations the class accepts.
Syntax
func (obj *SCIMWeb) SupportedOperations() (int32, error)
func (obj *SCIMWeb) SetSupportedOperations(value int32) error
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:
| 0x0001 (sopUserCreate) | Accept POST /Users requests. Fires the CreateUser event. |
| 0x0002 (sopUserRead) | Accept GET /Users/{id} requests. Fires the GetUser event. |
| 0x0004 (sopUserUpdate) | Accept PUT /Users/{id} and PATCH /Users/{id} requests. Fires the GetUser and UpdateUser events. |
| 0x0008 (sopUserDelete) | Accept DELETE /Users/{id} requests. Fires the DeleteUser event. |
| 0x0010 (sopUserList) | Accept GET /Users requests. Fires the ListUsers event. |
| 0x0100 (sopGroupCreate) | Accept POST /Groups requests. Fires the CreateGroup event. |
| 0x0200 (sopGroupRead) | Accept GET /Groups/{id} requests. Fires the GetGroup event. |
| 0x0400 (sopGroupUpdate) | Accept PUT /Groups/{id} and PATCH /Groups/{id} requests. Fires the GetGroup and UpdateGroup events. |
| 0x0800 (sopGroupDelete) | Accept DELETE /Groups/{id} requests. Fires the DeleteGroup event. |
| 0x1000 (sopGroupList) | Accept GET /Groups requests. Fires the ListGroups event. |
| 0xFFFF (sopAll) | Enable all operations, which is the default. |
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 component 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 component 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.
Data Type
int32
UserEmailCount Property (SCIMWeb Component)
The number of records in the UserEmail arrays.
Syntax
func (obj *SCIMWeb) UserEmailCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at UserEmailCount - 1.This property is read-only.
Data Type
int32
UserEmailAddress Property (SCIMWeb Component)
The email address.
Syntax
func (obj *SCIMWeb) UserEmailAddress(UserEmailIndex int32) (string, error)
Default Value
""
Remarks
The email address.
This property contains the email address value.
The UserEmailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserEmailCount property.
This property is read-only.
Data Type
string
UserEmailType Property (SCIMWeb Component)
The type of email address.
Syntax
func (obj *SCIMWeb) UserEmailType(UserEmailIndex int32) (string, error)
Default Value
""
Remarks
The type of email address.
This property classifies the email address. Common values include work, home, and other.
The UserEmailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserEmailCount property.
This property is read-only.
Data Type
string
UserEmailPrimary Property (SCIMWeb Component)
Whether this is the primary email address.
Syntax
func (obj *SCIMWeb) UserEmailPrimary(UserEmailIndex int32) (bool, error)
Default Value
false
Remarks
Whether this is the primary email address.
This property indicates whether this email address is the user's primary address. Only one entry in the collection should have Primary set to true.
The UserEmailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserEmailCount property.
This property is read-only.
Data Type
bool
UserExtensionCostCenter Property (SCIMWeb Component)
The user's cost center.
Syntax
func (obj *SCIMWeb) UserExtensionCostCenter() (string, error)
Default Value
""
Remarks
The user's cost center.
This property identifies the cost center the user is associated with.
This property is read-only.
Data Type
string
UserExtensionDepartment Property (SCIMWeb Component)
The user's department.
Syntax
func (obj *SCIMWeb) UserExtensionDepartment() (string, error)
Default Value
""
Remarks
The user's department.
This property contains the name of the department the user belongs to.
This property is read-only.
Data Type
string
UserExtensionDivision Property (SCIMWeb Component)
The user's division.
Syntax
func (obj *SCIMWeb) UserExtensionDivision() (string, error)
Default Value
""
Remarks
The user's division.
This property contains the name of the division the user belongs to within the organization.
This property is read-only.
Data Type
string
UserExtensionEmployeeNumber Property (SCIMWeb Component)
The user's employee number.
Syntax
func (obj *SCIMWeb) UserExtensionEmployeeNumber() (string, error)
Default Value
""
Remarks
The user's employee number.
This property contains a string identifier for the user within the organization, such as a payroll or HR system identifier.
This property is read-only.
Data Type
string
UserExtensionManagerDisplayName Property (SCIMWeb Component)
The display name of the user's manager.
Syntax
func (obj *SCIMWeb) UserExtensionManagerDisplayName() (string, error)
Default Value
""
Remarks
The display name of the user's manager.
This property contains the human-readable name of the manager. It corresponds to the displayName sub-attribute of the manager complex attribute in the enterprise extension schema.
This property is read-only.
Data Type
string
UserExtensionManagerId Property (SCIMWeb Component)
The user identifier of the user's manager.
Syntax
func (obj *SCIMWeb) UserExtensionManagerId() (string, error)
Default Value
""
Remarks
The user identifier of the user's manager.
This property contains the identifier of the manager's user resource within the application. It corresponds to the value sub-attribute of the manager complex attribute in the enterprise extension schema.
This property is read-only.
Data Type
string
UserExtensionManagerRef Property (SCIMWeb Component)
The URI of the manager's user resource.
Syntax
func (obj *SCIMWeb) UserExtensionManagerRef() (string, error)
Default Value
""
Remarks
The URI of the manager's user resource.
This property contains the full URI reference to the manager's user resource (e.g., /scim/v2/Users/{id}). It corresponds to the $ref sub-attribute of the manager complex attribute in the enterprise extension schema.
This property is read-only.
Data Type
string
UserExtensionOrganization Property (SCIMWeb Component)
The user's organization.
Syntax
func (obj *SCIMWeb) UserExtensionOrganization() (string, error)
Default Value
""
Remarks
The user's organization.
This property contains the name of the organization the user belongs to.
This property is read-only.
Data Type
string
UserPhoneCount Property (SCIMWeb Component)
The number of records in the UserPhone arrays.
Syntax
func (obj *SCIMWeb) UserPhoneCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at UserPhoneCount - 1.This property is read-only.
Data Type
int32
UserPhoneNumber Property (SCIMWeb Component)
The phone number.
Syntax
func (obj *SCIMWeb) UserPhoneNumber(UserPhoneIndex int32) (string, error)
Default Value
""
Remarks
The phone number.
This property contains the phone number value.
The UserPhoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserPhoneCount property.
This property is read-only.
Data Type
string
UserPhoneType Property (SCIMWeb Component)
The type of phone number.
Syntax
func (obj *SCIMWeb) UserPhoneType(UserPhoneIndex int32) (string, error)
Default Value
""
Remarks
The type of phone number.
This property classifies the phone number. Common values include work, mobile, home, and other.
The UserPhoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserPhoneCount property.
This property is read-only.
Data Type
string
UserPhonePrimary Property (SCIMWeb Component)
Whether this is the primary phone number.
Syntax
func (obj *SCIMWeb) UserPhonePrimary(UserPhoneIndex int32) (bool, error)
Default Value
false
Remarks
Whether this is the primary phone number.
This property indicates whether this phone number is the user's primary number. Only one entry in the collection should have Primary set to true.
The UserPhoneIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserPhoneCount property.
This property is read-only.
Data Type
bool
AddGroup Method (SCIMWeb Component)
Adds a group entry to the outgoing list response.
Syntax
func (obj *SCIMWeb) AddGroup(GroupId string, DisplayName string, ExternalId string) error
Remarks
This method should be called within a ListGroups event handler once for each group in the current page of results. The component 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;
};
AddGroupMember Method (SCIMWeb Component)
Adds a member to the outgoing group response.
Syntax
func (obj *SCIMWeb) AddGroupMember(GroupId string, MemberId string, MemberDisplay string) error
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;
};
AddUser Method (SCIMWeb Component)
Adds a user entry to the outgoing list response.
Syntax
func (obj *SCIMWeb) AddUser(UserId string, UserName string, DisplayName string, ExternalId string, Active bool) error
Remarks
This method should be called within a ListUsers event handler once for each user in the current page of results. The component 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;
}
AddUserEmail Method (SCIMWeb Component)
Adds an email address to the outgoing user response.
Syntax
func (obj *SCIMWeb) AddUserEmail(UserId string, Address string, EmailType string, Primary bool) error
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;
};
AddUserExtension Method (SCIMWeb Component)
Adds enterprise extension attributes to the outgoing user response.
Syntax
func (obj *SCIMWeb) AddUserExtension(UserId string, Department string, EmployeeNumber string, CostCenter string, Organization string, Division string, ManagerId string, ManagerRef string, ManagerDisplayName string) error
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 component 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.
AddUserPhone Method (SCIMWeb Component)
Adds a phone number to the outgoing user response.
Syntax
func (obj *SCIMWeb) AddUserPhone(UserId string, Number string, PhoneType string, Primary bool) error
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;
};
Config Method (SCIMWeb Component)
Sets or retrieves a configuration setting.
Syntax
func (obj *SCIMWeb) Config(ConfigurationString string) (string, error)
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.
ProcessRequest Method (SCIMWeb Component)
Processes an incoming SCIM request and generates a response.
Syntax
func (obj *SCIMWeb) ProcessRequest() error
Remarks
This method is used as the primary entry point for the SCIMWeb component 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 component 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 component 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);
Reset Method (SCIMWeb Component)
This method will reset the class.
Syntax
func (obj *SCIMWeb) Reset() error
Remarks
This method will reset the component's properties to their default values.
AuthRequest Event (SCIMWeb Component)
Fired for every incoming request to control access to specific endpoints.
Syntax
// SCIMWebAuthRequestEventArgs carries the SCIMWeb AuthRequest event's parameters.
type SCIMWebAuthRequestEventArgs struct {...}
func (args *SCIMWebAuthRequestEventArgs) RequestId() int32
func (args *SCIMWebAuthRequestEventArgs) AuthMethod() string
func (args *SCIMWebAuthRequestEventArgs) User() string
func (args *SCIMWebAuthRequestEventArgs) Token() string
func (args *SCIMWebAuthRequestEventArgs) Accept() bool
func (args *SCIMWebAuthRequestEventArgs) SetAccept(value bool)
// SCIMWebAuthRequestEvent defines the signature of the SCIMWeb AuthRequest event's handler function.
type SCIMWebAuthRequestEvent func(sender *SCIMWeb, args *SCIMWebAuthRequestEventArgs)
func (obj *SCIMWeb) GetOnAuthRequestHandler() SCIMWebAuthRequestEvent
func (obj *SCIMWeb) SetOnAuthRequestHandler(handlerFunc SCIMWebAuthRequestEvent)
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.
| Bearer | The Token parameter contains the raw bearer token, and the User parameter remains empty. If the AuthToken property has been set, the component automatically compares it against the incoming token and pre-initializes the Accept parameter with the result. When AuthToken is not set, Accept defaults to false. |
| Basic | The component decodes the base64 credentials and splits them on the colon separator. User contains the username and Token contains the password. Accept defaults to false. No automatic credential check is performed. |
| Other/Unrecognized | The AuthMethod parameter contains the scheme name as supplied by the client. Token contains everything following it and User is empty. Accept defaults to false. |
| "" (empty string) | No Authorization header was present. User and Token are both set to "" (empty string). Accept defaults to false. |
The Accept value may be changed when additional logic outside of the component 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;
}
};
CreateGroup Event (SCIMWeb Component)
Fired when a request to create a new group is received.
Syntax
// SCIMWebCreateGroupEventArgs carries the SCIMWeb CreateGroup event's parameters.
type SCIMWebCreateGroupEventArgs struct {...}
func (args *SCIMWebCreateGroupEventArgs) RequestId() int32
func (args *SCIMWebCreateGroupEventArgs) ExternalId() string
func (args *SCIMWebCreateGroupEventArgs) DisplayName() string
func (args *SCIMWebCreateGroupEventArgs) GroupId() string
func (args *SCIMWebCreateGroupEventArgs) SetGroupId(value string)
func (args *SCIMWebCreateGroupEventArgs) StatusCode() int32
func (args *SCIMWebCreateGroupEventArgs) SetStatusCode(value int32)
// SCIMWebCreateGroupEvent defines the signature of the SCIMWeb CreateGroup event's handler function.
type SCIMWebCreateGroupEvent func(sender *SCIMWeb, args *SCIMWebCreateGroupEventArgs)
func (obj *SCIMWeb) GetOnCreateGroupHandler() SCIMWebCreateGroupEvent
func (obj *SCIMWeb) SetOnCreateGroupHandler(handlerFunc SCIMWebCreateGroupEvent)
Remarks
This event fires when the component 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 property.
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.
CreateUser Event (SCIMWeb Component)
Fired when a request to create a new user is received.
Syntax
// SCIMWebCreateUserEventArgs carries the SCIMWeb CreateUser event's parameters.
type SCIMWebCreateUserEventArgs struct {...}
func (args *SCIMWebCreateUserEventArgs) RequestId() int32
func (args *SCIMWebCreateUserEventArgs) ExternalId() string
func (args *SCIMWebCreateUserEventArgs) UserName() string
func (args *SCIMWebCreateUserEventArgs) GivenName() string
func (args *SCIMWebCreateUserEventArgs) FamilyName() string
func (args *SCIMWebCreateUserEventArgs) DisplayName() string
func (args *SCIMWebCreateUserEventArgs) Active() bool
func (args *SCIMWebCreateUserEventArgs) UserId() string
func (args *SCIMWebCreateUserEventArgs) SetUserId(value string)
func (args *SCIMWebCreateUserEventArgs) StatusCode() int32
func (args *SCIMWebCreateUserEventArgs) SetStatusCode(value int32)
// SCIMWebCreateUserEvent defines the signature of the SCIMWeb CreateUser event's handler function.
type SCIMWebCreateUserEvent func(sender *SCIMWeb, args *SCIMWebCreateUserEventArgs)
func (obj *SCIMWeb) GetOnCreateUserHandler() SCIMWebCreateUserEvent
func (obj *SCIMWeb) SetOnCreateUserHandler(handlerFunc SCIMWebCreateUserEvent)
Remarks
This event fires when the component 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 property (for emails) or a Number, PhoneType, and Primary property (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.
DeleteGroup Event (SCIMWeb Component)
Fired when a request to delete a group is received.
Syntax
// SCIMWebDeleteGroupEventArgs carries the SCIMWeb DeleteGroup event's parameters.
type SCIMWebDeleteGroupEventArgs struct {...}
func (args *SCIMWebDeleteGroupEventArgs) RequestId() int32
func (args *SCIMWebDeleteGroupEventArgs) GroupId() string
func (args *SCIMWebDeleteGroupEventArgs) StatusCode() int32
func (args *SCIMWebDeleteGroupEventArgs) SetStatusCode(value int32)
// SCIMWebDeleteGroupEvent defines the signature of the SCIMWeb DeleteGroup event's handler function.
type SCIMWebDeleteGroupEvent func(sender *SCIMWeb, args *SCIMWebDeleteGroupEventArgs)
func (obj *SCIMWeb) GetOnDeleteGroupHandler() SCIMWebDeleteGroupEvent
func (obj *SCIMWeb) SetOnDeleteGroupHandler(handlerFunc SCIMWebDeleteGroupEvent)
Remarks
This event fires when the component 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 component 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.
DeleteUser Event (SCIMWeb Component)
Fired when a request to delete a user is received.
Syntax
// SCIMWebDeleteUserEventArgs carries the SCIMWeb DeleteUser event's parameters.
type SCIMWebDeleteUserEventArgs struct {...}
func (args *SCIMWebDeleteUserEventArgs) RequestId() int32
func (args *SCIMWebDeleteUserEventArgs) UserId() string
func (args *SCIMWebDeleteUserEventArgs) StatusCode() int32
func (args *SCIMWebDeleteUserEventArgs) SetStatusCode(value int32)
// SCIMWebDeleteUserEvent defines the signature of the SCIMWeb DeleteUser event's handler function.
type SCIMWebDeleteUserEvent func(sender *SCIMWeb, args *SCIMWebDeleteUserEventArgs)
func (obj *SCIMWeb) GetOnDeleteUserHandler() SCIMWebDeleteUserEvent
func (obj *SCIMWeb) SetOnDeleteUserHandler(handlerFunc SCIMWebDeleteUserEvent)
Remarks
This event fires when the component 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 component 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.
Error Event (SCIMWeb Component)
Fired when an error occurs while processing a SCIM request.
Syntax
// SCIMWebErrorEventArgs carries the SCIMWeb Error event's parameters.
type SCIMWebErrorEventArgs struct {...}
func (args *SCIMWebErrorEventArgs) RequestId() int32
func (args *SCIMWebErrorEventArgs) ErrorCode() int32
func (args *SCIMWebErrorEventArgs) Description() string
// SCIMWebErrorEvent defines the signature of the SCIMWeb Error event's handler function.
type SCIMWebErrorEvent func(sender *SCIMWeb, args *SCIMWebErrorEventArgs)
func (obj *SCIMWeb) GetOnErrorHandler() SCIMWebErrorEvent
func (obj *SCIMWeb) SetOnErrorHandler(handlerFunc SCIMWebErrorEvent)
Remarks
This event fires when the component cannot complete a SCIM request, immediately before the error response is returned to the Identity Provider. It fires both for requests the component 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 component 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.
GetGroup Event (SCIMWeb Component)
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
// SCIMWebGetGroupEventArgs carries the SCIMWeb GetGroup event's parameters.
type SCIMWebGetGroupEventArgs struct {...}
func (args *SCIMWebGetGroupEventArgs) RequestId() int32
func (args *SCIMWebGetGroupEventArgs) GroupId() string
func (args *SCIMWebGetGroupEventArgs) ExternalId() string
func (args *SCIMWebGetGroupEventArgs) SetExternalId(value string)
func (args *SCIMWebGetGroupEventArgs) DisplayName() string
func (args *SCIMWebGetGroupEventArgs) SetDisplayName(value string)
func (args *SCIMWebGetGroupEventArgs) StatusCode() int32
func (args *SCIMWebGetGroupEventArgs) SetStatusCode(value int32)
// SCIMWebGetGroupEvent defines the signature of the SCIMWeb GetGroup event's handler function.
type SCIMWebGetGroupEvent func(sender *SCIMWeb, args *SCIMWebGetGroupEventArgs)
func (obj *SCIMWeb) GetOnGetGroupHandler() SCIMWebGetGroupEvent
func (obj *SCIMWeb) SetOnGetGroupHandler(handlerFunc SCIMWebGetGroupEvent)
Remarks
This event fires when the component 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.
GetResourceTypes Event (SCIMWeb Component)
Fired when a request for the resource type definitions is received.
Syntax
// SCIMWebGetResourceTypesEventArgs carries the SCIMWeb GetResourceTypes event's parameters.
type SCIMWebGetResourceTypesEventArgs struct {...}
func (args *SCIMWebGetResourceTypesEventArgs) RequestId() int32
func (args *SCIMWebGetResourceTypesEventArgs) ResponseBody() []byte
// SCIMWebGetResourceTypesEvent defines the signature of the SCIMWeb GetResourceTypes event's handler function.
type SCIMWebGetResourceTypesEvent func(sender *SCIMWeb, args *SCIMWebGetResourceTypesEventArgs)
func (obj *SCIMWeb) GetOnGetResourceTypesHandler() SCIMWebGetResourceTypesEvent
func (obj *SCIMWeb) SetOnGetResourceTypesHandler(handlerFunc SCIMWebGetResourceTypesEvent)
Remarks
This event fires when the component receives a GET /ResourceTypes request from the Identity Provider. The component 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.
GetSchemas Event (SCIMWeb Component)
Fired when a request for the schema definitions is received.
Syntax
// SCIMWebGetSchemasEventArgs carries the SCIMWeb GetSchemas event's parameters.
type SCIMWebGetSchemasEventArgs struct {...}
func (args *SCIMWebGetSchemasEventArgs) RequestId() int32
func (args *SCIMWebGetSchemasEventArgs) ResponseBody() []byte
// SCIMWebGetSchemasEvent defines the signature of the SCIMWeb GetSchemas event's handler function.
type SCIMWebGetSchemasEvent func(sender *SCIMWeb, args *SCIMWebGetSchemasEventArgs)
func (obj *SCIMWeb) GetOnGetSchemasHandler() SCIMWebGetSchemasEvent
func (obj *SCIMWeb) SetOnGetSchemasHandler(handlerFunc SCIMWebGetSchemasEvent)
Remarks
This event fires when the component receives a GET /Schemas request from the Identity Provider. The component 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.
GetServiceProviderConfig Event (SCIMWeb Component)
Fired when a request for the service provider configuration is received.
Syntax
// SCIMWebGetServiceProviderConfigEventArgs carries the SCIMWeb GetServiceProviderConfig event's parameters.
type SCIMWebGetServiceProviderConfigEventArgs struct {...}
func (args *SCIMWebGetServiceProviderConfigEventArgs) RequestId() int32
func (args *SCIMWebGetServiceProviderConfigEventArgs) ResponseBody() []byte
// SCIMWebGetServiceProviderConfigEvent defines the signature of the SCIMWeb GetServiceProviderConfig event's handler function.
type SCIMWebGetServiceProviderConfigEvent func(sender *SCIMWeb, args *SCIMWebGetServiceProviderConfigEventArgs)
func (obj *SCIMWeb) GetOnGetServiceProviderConfigHandler() SCIMWebGetServiceProviderConfigEvent
func (obj *SCIMWeb) SetOnGetServiceProviderConfigHandler(handlerFunc SCIMWebGetServiceProviderConfigEvent)
Remarks
This event fires when the component receives a GET /ServiceProviderConfig request from the Identity Provider. The component 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.
GetUser Event (SCIMWeb Component)
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
// SCIMWebGetUserEventArgs carries the SCIMWeb GetUser event's parameters.
type SCIMWebGetUserEventArgs struct {...}
func (args *SCIMWebGetUserEventArgs) RequestId() int32
func (args *SCIMWebGetUserEventArgs) UserId() string
func (args *SCIMWebGetUserEventArgs) ExternalId() string
func (args *SCIMWebGetUserEventArgs) SetExternalId(value string)
func (args *SCIMWebGetUserEventArgs) UserName() string
func (args *SCIMWebGetUserEventArgs) SetUserName(value string)
func (args *SCIMWebGetUserEventArgs) GivenName() string
func (args *SCIMWebGetUserEventArgs) SetGivenName(value string)
func (args *SCIMWebGetUserEventArgs) FamilyName() string
func (args *SCIMWebGetUserEventArgs) SetFamilyName(value string)
func (args *SCIMWebGetUserEventArgs) DisplayName() string
func (args *SCIMWebGetUserEventArgs) SetDisplayName(value string)
func (args *SCIMWebGetUserEventArgs) Active() bool
func (args *SCIMWebGetUserEventArgs) SetActive(value bool)
func (args *SCIMWebGetUserEventArgs) StatusCode() int32
func (args *SCIMWebGetUserEventArgs) SetStatusCode(value int32)
// SCIMWebGetUserEvent defines the signature of the SCIMWeb GetUser event's handler function.
type SCIMWebGetUserEvent func(sender *SCIMWeb, args *SCIMWebGetUserEventArgs)
func (obj *SCIMWeb) GetOnGetUserHandler() SCIMWebGetUserEvent
func (obj *SCIMWeb) SetOnGetUserHandler(handlerFunc SCIMWebGetUserEvent)
Remarks
This event fires when the component 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.
ListGroups Event (SCIMWeb Component)
Fired when a request to list groups is received.
Syntax
// SCIMWebListGroupsEventArgs carries the SCIMWeb ListGroups event's parameters.
type SCIMWebListGroupsEventArgs struct {...}
func (args *SCIMWebListGroupsEventArgs) RequestId() int32
func (args *SCIMWebListGroupsEventArgs) Filter() string
func (args *SCIMWebListGroupsEventArgs) FilterAttribute() string
func (args *SCIMWebListGroupsEventArgs) FilterOperator() string
func (args *SCIMWebListGroupsEventArgs) FilterValue() string
func (args *SCIMWebListGroupsEventArgs) StartIndex() int32
func (args *SCIMWebListGroupsEventArgs) Count() int32
func (args *SCIMWebListGroupsEventArgs) TotalResults() int32
func (args *SCIMWebListGroupsEventArgs) SetTotalResults(value int32)
func (args *SCIMWebListGroupsEventArgs) StatusCode() int32
func (args *SCIMWebListGroupsEventArgs) SetStatusCode(value int32)
// SCIMWebListGroupsEvent defines the signature of the SCIMWeb ListGroups event's handler function.
type SCIMWebListGroupsEvent func(sender *SCIMWeb, args *SCIMWebListGroupsEventArgs)
func (obj *SCIMWeb) GetOnListGroupsHandler() SCIMWebListGroupsEvent
func (obj *SCIMWeb) SetOnListGroupsHandler(handlerFunc SCIMWebListGroupsEvent)
Remarks
This event fires when the component 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.
ListUsers Event (SCIMWeb Component)
Fired when a request to list users is received.
Syntax
// SCIMWebListUsersEventArgs carries the SCIMWeb ListUsers event's parameters.
type SCIMWebListUsersEventArgs struct {...}
func (args *SCIMWebListUsersEventArgs) RequestId() int32
func (args *SCIMWebListUsersEventArgs) Filter() string
func (args *SCIMWebListUsersEventArgs) FilterAttribute() string
func (args *SCIMWebListUsersEventArgs) FilterOperator() string
func (args *SCIMWebListUsersEventArgs) FilterValue() string
func (args *SCIMWebListUsersEventArgs) StartIndex() int32
func (args *SCIMWebListUsersEventArgs) Count() int32
func (args *SCIMWebListUsersEventArgs) TotalResults() int32
func (args *SCIMWebListUsersEventArgs) SetTotalResults(value int32)
func (args *SCIMWebListUsersEventArgs) StatusCode() int32
func (args *SCIMWebListUsersEventArgs) SetStatusCode(value int32)
// SCIMWebListUsersEvent defines the signature of the SCIMWeb ListUsers event's handler function.
type SCIMWebListUsersEvent func(sender *SCIMWeb, args *SCIMWebListUsersEventArgs)
func (obj *SCIMWeb) GetOnListUsersHandler() SCIMWebListUsersEvent
func (obj *SCIMWeb) SetOnListUsersHandler(handlerFunc SCIMWebListUsersEvent)
Remarks
This event fires when the component 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.
Log Event (SCIMWeb Component)
Fired once for each log message.
Syntax
// SCIMWebLogEventArgs carries the SCIMWeb Log event's parameters.
type SCIMWebLogEventArgs struct {...}
func (args *SCIMWebLogEventArgs) RequestId() int32
func (args *SCIMWebLogEventArgs) LogLevel() int32
func (args *SCIMWebLogEventArgs) Message() string
func (args *SCIMWebLogEventArgs) LogType() string
// SCIMWebLogEvent defines the signature of the SCIMWeb Log event's handler function.
type SCIMWebLogEvent func(sender *SCIMWeb, args *SCIMWebLogEventArgs)
func (obj *SCIMWeb) GetOnLogHandler() SCIMWebLogEvent
func (obj *SCIMWeb) SetOnLogHandler(handlerFunc SCIMWebLogEvent)
Remarks
This event fires once for each log message generated by the component 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:
| 0 (None) | No messages are logged. |
| 1 (Info - default) | Each request received, its completion status, and the result of authenticating the request are logged. |
| 2 (Verbose) | Equivalent to 1 (Info) for this component. No additional detail is logged at this level. |
| 3 (Debug) | Additionally logs which event (e.g., CreateUser or ListGroups) is about to be invoked to handle the current request. |
Message is the log entry.
LogType is always SCIM for this component.
The RequestId parameter identifies the current request. It may be used to correlate events that are fired when processing the same request.
UpdateGroup Event (SCIMWeb Component)
Fired after the current group has been loaded and a replace or update request has been applied.
Syntax
// SCIMWebUpdateGroupEventArgs carries the SCIMWeb UpdateGroup event's parameters.
type SCIMWebUpdateGroupEventArgs struct {...}
func (args *SCIMWebUpdateGroupEventArgs) RequestId() int32
func (args *SCIMWebUpdateGroupEventArgs) GroupId() string
func (args *SCIMWebUpdateGroupEventArgs) ExternalId() string
func (args *SCIMWebUpdateGroupEventArgs) DisplayName() string
func (args *SCIMWebUpdateGroupEventArgs) StatusCode() int32
func (args *SCIMWebUpdateGroupEventArgs) SetStatusCode(value int32)
// SCIMWebUpdateGroupEvent defines the signature of the SCIMWeb UpdateGroup event's handler function.
type SCIMWebUpdateGroupEvent func(sender *SCIMWeb, args *SCIMWebUpdateGroupEventArgs)
func (obj *SCIMWeb) GetOnUpdateGroupHandler() SCIMWebUpdateGroupEvent
func (obj *SCIMWeb) SetOnUpdateGroupHandler(handlerFunc SCIMWebUpdateGroupEvent)
Remarks
This event fires when the component 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 component 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 component 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.
UpdateUser Event (SCIMWeb Component)
Fired after the current user has been loaded and a replace or update request has been applied.
Syntax
// SCIMWebUpdateUserEventArgs carries the SCIMWeb UpdateUser event's parameters.
type SCIMWebUpdateUserEventArgs struct {...}
func (args *SCIMWebUpdateUserEventArgs) RequestId() int32
func (args *SCIMWebUpdateUserEventArgs) UserId() string
func (args *SCIMWebUpdateUserEventArgs) ExternalId() string
func (args *SCIMWebUpdateUserEventArgs) UserName() string
func (args *SCIMWebUpdateUserEventArgs) GivenName() string
func (args *SCIMWebUpdateUserEventArgs) FamilyName() string
func (args *SCIMWebUpdateUserEventArgs) DisplayName() string
func (args *SCIMWebUpdateUserEventArgs) Active() bool
func (args *SCIMWebUpdateUserEventArgs) StatusCode() int32
func (args *SCIMWebUpdateUserEventArgs) SetStatusCode(value int32)
// SCIMWebUpdateUserEvent defines the signature of the SCIMWeb UpdateUser event's handler function.
type SCIMWebUpdateUserEvent func(sender *SCIMWeb, args *SCIMWebUpdateUserEventArgs)
func (obj *SCIMWeb) GetOnUpdateUserHandler() SCIMWebUpdateUserEvent
func (obj *SCIMWeb) SetOnUpdateUserHandler(handlerFunc SCIMWebUpdateUserEvent)
Remarks
This event fires when the component 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 component 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 component 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.
Config Settings (SCIMWeb Component)
The component 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 component, access to these internal properties is provided through the Config method.SCIMWeb Config Settings
When this setting is disabled, both the AuthToken property and the AuthRequest event are bypassed entirely and all requests are accepted without authentication checks. This setting should be disabled only when the hosting application, web server, or reverse proxy has already authenticated the request.
A missing header does not prevent the operation. When supplied, the header must equal the current ETag or be *. A non-matching value returns 412 Precondition Failed before the update or delete event fires.
On a GET /Users/{id} or GET /Groups/{id} request, the component also compares an incoming If-None-Match header against the current resource's ETag. When the header is present and equals the current ETag or *, a 304 Not Modified response is returned with no body instead of the resource representation.
This feature is disabled by default and should be enabled if the connecting Identity Provider requires versioned resources.
This setting does not suppress errors for a missing PatchOp schema, an empty Operations array, or an invalid operation name.
When the LogLevel configuration setting is set to 3, each ignored attribute path is recorded through the Log event. Attribute values and filter values are not included in this log entry.
JSON XPath values are rooted at /json. For example, /json/displayName selects the displayName property, and /json/members/[1]/value selects the first member's value property. XPath indices are 1-based.
Requests with an empty or invalid JSON body clear the current JSON XPath state.
Base Config Settings
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (SCIMWeb Component)
SCIMWeb Errors
| 961 | Authentication failed. The request was rejected because the AuthRequest event did not accept the credentials. |
| 962 | Invalid request. The request body could not be parsed as valid SCIM JSON, a required field is missing, a PATCH operation or path is not supported, or an If-Match precondition failed. |
| 963 | Unsupported operation. The requested HTTP method and resource type combination is not enabled in the SupportedOperations property. |
| 964 | Filter parse error. The SCIM filter expression supplied in a GET /Users or GET /Groups request could not be parsed. |
| 965 | Endpoint not found. The request URI does not match a SCIM endpoint under the BaseURL path, or it names a resource type or schema that does not exist. |
| 966 | Method not allowed. The HTTP method is not supported by the requested SCIM endpoint. |
The class may also return one of the following error codes, which are inherited from other classes.