Skip to content
/
Create Microsoft Software...

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

Create Microsoft Software Installer Package for Template

Request

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.

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": "2019-08-24T14:15:22Z",
  "productId": "string",
  "productName": "string",
  "profileType": "USER_TYPE",
  "usernameVariableSource": "COMPUTER_NAME"
}

Responses

MSI Package created

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

Search for Certificate Templates Matching Search String in Paged Result

Request

Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
searchTargetFieldsArray of strings
searchStringstring
filtersobject(TemplateFilters)
{
  "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
totalCountinteger(int64)
totalPagesinteger(int32)
pageinteger(int32)
dataArray of objects(CertificateTemplateDto)

Template in page.

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