Skip to content
Certificate Template/
/
Search certificate templa...

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

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": [
    { … }
  ]
}

Get certificate template by ID

Request

Retrieves a specific certificate template by ID.

Path
templateIdstringrequired

Certificate template id

No request payload

Responses

Certificate Template

Body
idstringread-only

The unique identifier for this template.

descriptionstring[ 0 .. 255 ] characters

The description identifier for this template.

namestring[ 2 .. 255 ] charactersrequired

The name for the certificate template.

caTypestringrequired

Which CA signs the certificates from the template.

Value"ONBOARD"
defaultAccessboolean

Default RADIUS access response will either be accepted or rejected.

policySetIdstring

The policy set that is assigned to this template.

onboardobject(OnboardDto)

The configuration of the onboard CA.

chromebookobject(ChromebookDto)

The configuration of the Chromebook.

keyLengthinteger(int32)required

The key length for certificates generated using this template.

Enum"2048""3072""4096"
algorithmstring(AlgorithmEnum)required

The algorithm to use for certificates generated using this template.

Enum"SHA_1""SHA_256""SHA_384""SHA_512"
certificateCountinteger(int32)read-only

The count of certificate generated from this template.

certificateNamesArray of stringsread-only

The names of certificate generated from this template.

variablesArray of stringsread-only

The variables for replacing the variables in the generated certificate.

networkCountinteger(int32)read-only

The count of network assigned to this template.

identityGroupIdstringnon-emptyrequired

The identity group id associated with the template.

Response
{
  "id": "string",
  "description": "string",
  "name": "string",
  "caType": "ONBOARD",
  "defaultAccess": true,
  "policySetId": "string",
  "onboard": {
    "commonNamePattern": "string",
    "emailPattern": "string",
    "notAfterType": "SPECIFIED_DATE",
    "notAfterValue": 0,
    "notBeforeType": "SPECIFIED_DATE",
    "notBeforeValue": 0,
    "notAfterDate": "2019-08-24T14:15:22Z",
    "notBeforeDate": "2019-08-24T14:15:22Z",
    "organizationPattern": "string",
    "organizationUnitPattern": "string",
    "localityPattern": "string",
    "statePattern": "string",
    "countryPattern": "string",
    "certificateType": "CLIENT",
    "certificateAuthorityName": "string"
  },
  "chromebook": {
    "apiKey": "string",
    "certRemovalType": "NONE",
    "enrollmentType": "USER",
    "notifyAppId": "string",
    "accountCredential": "string",
    "enabled": true,
    "type": "string",
    "projectId": "string",
    "privateKeyId": "string",
    "privateKey": "string",
    "clientEmail": "string",
    "clientId": "string",
    "authUri": "string",
    "tokenUri": "string",
    "enrollmentUrl": "string"
  },
  "keyLength": "2048",
  "algorithm": "SHA_1",
  "certificateCount": 0,
  "certificateNames": [
    "string"
  ],
  "variables": [
    "string"
  ],
  "networkCount": 0,
  "identityGroupId": "string"
}