Skip to content
Authrim

Create an operational notification.

POST
/api/admin/field-mapping/operational-notifications
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/operational-notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "category": "provisioning", "eventType": "mapping.validation.failed", "severity": "warning", "subjectType": "field_mapping_version", "subjectId": "field_mapping_version_123", "payload": { "errorCount": 2 } }'

Enqueues a tenant-scoped operational notification for identity-mapping operations, including severity, category, subject, payload, and optional deduplication key.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

Idempotency key for state-changing operations that support replay protection.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
category
required
string
eventType
required
string
severity
required
string
subjectType
required
string
subjectId
required
string
payload
required
object
key
additional properties
deduplicationKey
string
key
additional properties
Example 
{
  "category": "provisioning",
  "eventType": "mapping.validation.failed",
  "severity": "warning",
  "subjectType": "field_mapping_version",
  "subjectId": "field_mapping_version_123",
  "payload": {
    "errorCount": 2
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Operational notification create response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required
string
notificationEventId
required
string
state
required
string
severity
required
string
category
required
string
idempotent
boolean
key
additional properties
key
additional properties
Example generated
{
  "result": {
    "id": "example",
    "tenantId": "example",
    "notificationEventId": "example",
    "state": "example",
    "severity": "example",
    "category": "example",
    "idempotent": true
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}