Skip to content
Certificate Template/
/
Create msi package

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 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
}

Create msi package

Request

Creates a microsoft software installer package for a certificate template.

Path
templateIdstringrequired
Body
required
descriptionstring[ 0 .. 255 ] characters

Description of the package.

enabledboolean

Indicates whether this package should be used.

namestring[ 2 .. 255 ] characters

The unique reference name of the package.

allowedSubnetsstring

If populated, only the IP addresses or subnets specified are allowed to use this package.

blockedSubnetsstring

If populated, the IP addresses or subnets specified are blocked from using this package. Blocked subnets override the allowed subnets.

expirationDatestring(date-time)required

The expire date for this package.

Example: "2024-01-01"
productIdstring

The product ID for the package.

productNamestring[ 2 .. 255 ] charactersrequired

The product name for the package.

profileTypestringrequired

The profile type for the package.

Enum"USER_TYPE""MACHINE_TYPE"
usernameVariableSourcestringrequired

Determines where the variable (usable in the certificate template) is derived from.

Enum"COMPUTER_NAME""CURRENT_USER"
{
  "description": "string",
  "enabled": true,
  "name": "string",
  "allowedSubnets": "string",
  "blockedSubnets": "string",
  "expirationDate": "2024-01-01",
  "productId": "string",
  "productName": "string",
  "profileType": "USER_TYPE",
  "usernameVariableSource": "COMPUTER_NAME"
}

Responses

MSI Package created

Body
requestIdstring

The unique request identifier for tracking the operation.

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

Search certificate templates

Request

Searches for certificate templates matching the search criteria.

Body
required
fieldsArray of strings

List of field names to include in the response.

pageinteger(int32)
pageSizeinteger(int32)

Number of items per page for pagination.

sortFieldstring

Field name to sort the results by.

sortOrderstring

Sort order direction (ASC or DESC).

Enum"ASC""DESC"
searchTargetFieldsArray of strings

List of field names to search within.

searchStringstring

Search string to filter results.

filtersobject(TemplateFilters)

Filters to apply when querying certificate templates.

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "caId": [ … ],
    "networkId": "string"
  }
}

Responses

Certificate Templates

Body
fieldsArray of strings

List of field names included in the response.

totalCountinteger(int64)

Total number of items matching the query.

totalPagesinteger(int32)

Total number of pages available.

pageinteger(int32)
dataArray of objects(CertificateTemplateDto)

Template in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}