Skip to content
/
Search for Certificate Te...

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

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

Get Specific Certificate Template

Request

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.

Enum204830724096
algorithmstring(AlgorithmEnum)required

SHA-256 - The SHA-2 hash using 256 bits. SHA-384 - The SHA-2 hash using 384 bits. SHA-512 - The SHA-2 hash using 512 bits.

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.

identityGroupIdstringrequired

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