Return Notification Settings
Return the notification settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify if notifications should be sent to the users on specific triggers (e.g password changed).
- 200
 - 403
 - 404
 - default
 
default notification policy
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
policy object
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toisDefault booleanpasswordChange booleanIf set to true the users will get a notification whenever their password has been changed.
{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "resourceOwner": "69629023906488334"
    },
    "isDefault": true,
    "passwordChange": true
  }
}
- Schema
 - Example (from schema)
 
Schema
policy object
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toisDefault booleanpasswordChange booleanIf set to true the users will get a notification whenever their password has been changed.
{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "resourceOwner": "69629023906488334"
    },
    "isDefault": true,
    "passwordChange": true
  }
}
- Schema
 - Example (from schema)
 
Schema
policy object
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toisDefault booleanpasswordChange booleanIf set to true the users will get a notification whenever their password has been changed.
{
  "policy": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-12",
      "changeDate": "2023-05-12",
      "resourceOwner": "69629023906488334"
    },
    "isDefault": true,
    "passwordChange": true
  }
}
Returned when the user does not have permission to access the resource.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
Returned when the resource does not exist.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
An unexpected error response.
- application/json
 - application/grpc
 - application/grpc-web+proto
 
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
 - Example (from schema)
 
Schema
- code int32
 - message string
 details object[]
Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}