Skip to content
Certificate Template/
/
Create notification for t...

Certificate Template (0.0.1)

Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for North American region.
https://api.ruckus.cloud

Server and Client Certificate

APIs for server and client certificate management.

Operations

Device Certificate

APIs for device certificate management.

Operations

Certificate Authority

APIs for certificate authority management.

Operations

Certificate Template

APIs for certificate template management.

Operations

Get template notifications

Request

Retrieves all notifications for a certificate template.

Path
templateIdstringrequired

Certificate template id

Query
pageableobject(Pageable)required

Parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
No request payload

Responses

Notifications

Body
totalPagesinteger(int32)

Total number of pages available.

totalElementsinteger(int64)

Total number of items across all pages.

sizeinteger(int32)
contentArray of any

List of items contained in the current page.

numberinteger(int32)

Current page index starting from 0.

sortobject(SortObject)

Sorting details applied to the query.

pageableobject(PageableObject)

Pagination information associated with this page.

numberOfElementsinteger(int32)

Number of items present in the current page.

firstboolean

Whether this is the first page.

lastboolean

Whether this is the last page.

emptyboolean

Whether the page is empty.

Response
{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    null
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "unsorted": true,
    "sorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}

Create notification for template

Request

Creates a notification for a certificate template.

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
requestIdstring

The unique request identifier for tracking the operation.

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

Get template msi packages

Request

Retrieves all MSI packages for a certificate template.

Path
templateIdstringrequired

Certificate template id

Query
pageableobject(Pageable)required

Parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
No request payload

Responses

MSI Packages

Body
totalPagesinteger(int32)

Total number of pages available.

totalElementsinteger(int64)

Total number of items across all pages.

sizeinteger(int32)
contentArray of any

List of items contained in the current page.

numberinteger(int32)

Current page index starting from 0.

sortobject(SortObject)

Sorting details applied to the query.

pageableobject(PageableObject)

Pagination information associated with this page.

numberOfElementsinteger(int32)

Number of items present in the current page.

firstboolean

Whether this is the first page.

lastboolean

Whether this is the last page.

emptyboolean

Whether the page is empty.

Response
{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    null
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "unsorted": true,
    "sorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}