Certificate Template (0.0.1)

Download OpenAPI description

Download PDF

Overview

License

RUCKUS Cloud Privacy Policy

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 notification by ID

Request

Retrieves a specific notification by ID.

Path

templateIdstringrequired

Certificate template id

notificationIdstringrequired

Notification id

No request payload

Responses

Notification

Body

idstringread-only

The unique if the notification.

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.

Response

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

Delete notification

Request

Deletes a notification from a certificate template.

Path

templateIdstringrequired

Certificate template id

notificationIdstringrequired

Notification id

No request payload

Responses

The delete request has been accepted and is in progress.

Body

requestIdstring

The unique request identifier for tracking the operation.

idstring

Response

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

Update template notification

Request

Updates a notification for a certificate template.

Path

templateIdstringrequired

Certificate template id

notificationIdstringrequired

Notification id

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

The update request has been accepted and is in progress.

Body

requestIdstring

The unique request identifier for tracking the operation.

idstring

Response

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