Skip to content
/
Create Notification for T...

Certificate Template API (0.0.1)

Download OpenAPI description
Download PDF
Languages
Servers
Asia Server URL

https://api.asia.ruckus.cloud/

Europe Server URL

https://api.eu.ruckus.cloud/

North America Server URL

https://api.ruckus.cloud/

Certificate Authority

APIs for Certificate Authority Management.

Operations

Server and Client Certificate

APIs for Server and Client Certificate Management.

Operations

Device Certificate

APIs for Device Certificate Management.

Operations

Certificate Template

APIs for Certificate Template Management.

Operations

Get Notifications of Template

Request

Path
templateIdstringrequired

Certificate template id

Query
pageinteger>= 0

Zero-based page index (0..N)

Default 0
sizeinteger>= 1

The size of the page to be returned

Default 20
sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

No request payload

Responses

Notifications

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
sizeinteger(int32)
contentArray of objects
numberinteger(int32)
sortobject(SortObject)
pageableobject(PageableObject)
firstboolean
lastboolean
numberOfElementsinteger(int32)
emptyboolean
Response
{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    {}
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true
  },
  "first": true,
  "last": true,
  "numberOfElements": 0,
  "empty": true
}

Create Notification for Template

Request

Path
templateIdstringrequired
Body
required
dateValuestring

The number of hours/days/months/etc to be offset from the event date when calculating when to send the notification.

emailSubjectstring[ 0 .. 255 ] characters

The subject of the email to be sent for this notification.

emailstring[ 0 .. 255 ] characters^[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=?`{...

Indicates whether this package should be used.

emailTemplatestring[ 0 .. 255 ] characters

The message of the email to be sent for this notification.

notificationEventstring

The event upon which to base the sending of the notification.

Enum"ON_ISSUANCE""ON_REVOCATION""ON_EXPIRATION""ON_REVOKED_USE"
notificationMethodstring

The method(s) to use to notify the user.

Enum"EMAIL_ELSE_SMS""SMS_ELSE_EMAIL""EMAIL_AND_SMS""EMAIL_ONLY""SMS_ONLY""EMAIL_ADMINISTRATOR"
notificationMethodDatastring

The data of to use to notify the user.

smsSubjectstring[ 0 .. 255 ] characters

The subject of the SMS to be sent for this notification.

smsTemplatestring[ 0 .. 255 ] characters

The message of the email to be sent for this notification.

staticDerivedDateTypestring

The basis for calculating the date to send the notification.

{
  "dateValue": "string",
  "emailSubject": "string",
  "email": "string",
  "emailTemplate": "string",
  "notificationEvent": "ON_ISSUANCE",
  "notificationMethod": "EMAIL_ELSE_SMS",
  "notificationMethodData": "string",
  "smsSubject": "string",
  "smsTemplate": "string",
  "staticDerivedDateType": "string"
}

Responses

Notification created

Body
Response
{
  "requestId": "b3d3a0a0-0b1a-4b1a-9b0a-0b1a0b1a0b1a"
}

Get Microsoft Software Installer Packages of Template

Request

Path
templateIdstringrequired

Certificate template id

Query
pageinteger>= 0

Zero-based page index (0..N)

Default 0
sizeinteger>= 1

The size of the page to be returned

Default 20
sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

No request payload

Responses

MSI Packages

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
sizeinteger(int32)
contentArray of objects
numberinteger(int32)
sortobject(SortObject)
pageableobject(PageableObject)
firstboolean
lastboolean
numberOfElementsinteger(int32)
emptyboolean
Response
{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    {}
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true
  },
  "first": true,
  "last": true,
  "numberOfElements": 0,
  "empty": true
}