Get Notification Settings
GET/policies/notification
Return the notification settings configured on the organization. It overwrites the default settings configured on the instance for this organization. The settings specify if notifications should be sent to the users on specific triggers (e.g password changed).
Request​
Header Parameters
The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
If set to true the users will get a notification whenever their password has been changed.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.510Z",
"changeDate": "2024-11-15T21:46:16.510Z",
"resourceOwner": "69629023906488334"
},
"isDefault": true,
"passwordChange": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
If set to true the users will get a notification whenever their password has been changed.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.510Z",
"changeDate": "2024-11-15T21:46:16.510Z",
"resourceOwner": "69629023906488334"
},
"isDefault": true,
"passwordChange": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
If set to true the users will get a notification whenever their password has been changed.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.510Z",
"changeDate": "2024-11-15T21:46:16.510Z",
"resourceOwner": "69629023906488334"
},
"isDefault": true,
"passwordChange": true
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}