Models

Subjects

object

A SubjectEntry defines who is addressed.

nginx:subjectId1SubjectEntry

Single (Authorization) Subject entry holding its type.

Show child attributes

typestringrequired

The type is offered only for documentation purposes. You are not restricted to any specific types, but we recommend to use it to specify the kind of the subject as shown in our examples.

expirystring<date-time>

The optional expiry timestamp (formatted in ISO-8601) indicates how long this subject should be considered active before it is automatically deleted from the Policy.

announcementSubjectAnnouncement

Settings for announcements to be made about the subject.

Show child attributes

beforeExpirystring

The duration before expiry when an announcement should be made. Must be a positive integer followed by one of h (hour), m (minute) or s (second).

whenDeletedboolean

Whether an announcement should be made when this subject is deleted.

requestedAcksobject

Settings to enable at-least-once delivery for policy announcements.

Show child attributes

labelsArray<string>

Acknowledgement labels to request when an announcement is published.

timeoutstring

How long to wait for requested announcements before retrying publication of an announcement.

Example

{
  "labels": [
    "my-connection-id:my-issued-acknowledgement"
  ],
  "timeout": "5s"
}

randomizationIntervalstring5m

Interval in which the announcement can be sent earlier than the configured beforeExpiry. The actual point in time when the announcement will be sent is beforeExpire plus a randomly chosen time within the randomizationInterval. E.g assuming beforeExpiry is set to 5m and randomizationInterval is set to 1m, the announcements will be sent between 5 and 6 minutes before the subject expires. If omitted, the default value will be applied. If set to minimum, no randomization will be applied.

Example

{
  "beforeExpiry": "5m",
  "whenDeleted": true,
  "randomizationInterval": "5m"
}

Example

{
  "type": "This is some description for this subject, adjust as needed.",
  "expiry": "2020-12-07T11:36:40Z",
  "announcement": {
    "beforeExpiry": "5m",
    "whenDeleted": true
  }
}

nginx:subjectIdNSubjectEntry

Single (Authorization) Subject entry holding its type.

Show child attributes

typestringrequired

The type is offered only for documentation purposes. You are not restricted to any specific types, but we recommend to use it to specify the kind of the subject as shown in our examples.

expirystring<date-time>

The optional expiry timestamp (formatted in ISO-8601) indicates how long this subject should be considered active before it is automatically deleted from the Policy.

announcementSubjectAnnouncement

Settings for announcements to be made about the subject.

Show child attributes

beforeExpirystring

The duration before expiry when an announcement should be made. Must be a positive integer followed by one of h (hour), m (minute) or s (second).

whenDeletedboolean

Whether an announcement should be made when this subject is deleted.

requestedAcksobject

Settings to enable at-least-once delivery for policy announcements.

Show child attributes

labelsArray<string>

Acknowledgement labels to request when an announcement is published.

timeoutstring

How long to wait for requested announcements before retrying publication of an announcement.

Example

{
  "labels": [
    "my-connection-id:my-issued-acknowledgement"
  ],
  "timeout": "5s"
}

randomizationIntervalstring5m

Example

{
  "beforeExpiry": "5m",
  "whenDeleted": true,
  "randomizationInterval": "5m"
}

Example

{
  "type": "This is some description for this subject, adjust as needed.",
  "expiry": "2020-12-07T11:36:40Z",
  "announcement": {
    "beforeExpiry": "5m",
    "whenDeleted": true
  }
}

Example

{
  "nginx:subjectId1": {
    "type": "This is some description for this subject, adjust as needed.",
    "expiry": "2020-12-07T11:36:40Z",
    "announcement": {
      "beforeExpiry": "5m",
      "whenDeleted": true
    }
  },
  "nginx:subjectIdN": {
    "type": "This is some description for this subject, adjust as needed.",
    "expiry": "2020-12-07T11:36:40Z",
    "announcement": {
      "beforeExpiry": "5m",
      "whenDeleted": true
    }
  }
}

Docs by Sourcey