Class: SCIMMY.Messages.Error
SCIM Error Message
Description
Summary:
- Formats exceptions to conform to the HTTP Status and Error Response Handling section of the SCIM protocol, ensuring HTTP status codes and scimType error detail keyword pairs are valid.
- When used to parse service provider responses, throws a new instance of
SCIMMY.Types.Errorwith details sourced from the message.
Usage
Instantiate a new SCIM Error Message with relevant details
new SCIMMY.Messages.Error(exopt)
Parameters:
| Name | Type | Default | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
exopt
|
Object | {} |
the initiating exception to parse into a SCIM error message Properties
|
Properties:
| Name | Type | Description |
|---|---|---|
status
|
String |
stringified HTTP status code to be sent with the error |
scimTypeopt
|
String |
the SCIM detail error keyword as per RFC7644§3.12 |
detailopt
|
String |
a human-readable description of what caused the error to occur |
Constants
(inner) ValidStatusTypes: Number[]
HTTP response status codes specified by RFC7644§3.12
- Values:
[307,308,400,401,403,404,409,412,413,500,501]- Type:
- {Number[]}
(inner) ValidScimTypes: String[]
SCIM detail error keywords specified by RFC7644§3.12
- Values:
["uniqueness","tooMany","invalidFilter","mutability","invalidSyntax","invalidPath","noTarget","invalidValue","invalidVers","sensitive"]- Type:
- {String[]}