Class: SCIMMY.Messages.ErrorResponse
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.ErrorResponse(exopt)
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
exopt
|
SCIMMY.Types.Error
~CauseDetails
Error
|
|
the initiating exception to parse into a SCIM error message |
Properties:
| Name | Type | Description |
|---|---|---|
status
|
~ValidStatusCodes
|
stringified HTTP status code to be sent with the error |
scimTypeopt
|
~ValidScimTypes
|
the SCIM detail error keyword as per RFC7644§3.12 |
detailopt
|
String
|
a human-readable description of what caused the error to occur |
Type Definitions
CauseDetails
Details of the underlying cause of the error response
- Type:
- {Object}
Properties:
| Name | Type | Default | Description |
|---|---|---|---|
statusopt
|
~ValidStatusCodes
|
|
HTTP status code to be sent with the error |
scimTypeopt
|
~ValidScimTypes
|
|
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) ValidStatusCodes
HTTP response status codes specified by RFC7644§3.12
- Values:
[307,308,400,401,403,404,409,412,413,500,501]
(inner) ValidScimTypes
SCIM detail error keywords specified by RFC7644§3.12
- Values:
["uniqueness","tooMany","invalidFilter","mutability","invalidSyntax","invalidPath","noTarget","invalidValue","invalidVers","sensitive"]