Skip to content
/
Update the 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

Delete the Certificate Template

Request

Path
templateIdstringrequired
No request payload

Responses

The delete request has been accepted and is in progress.

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

Update the Certificate Template

Request

Path
templateIdstringrequired

Certificate template id

Body
required
descriptionstring[ 0 .. 255 ] characters

The description identifier for this template.

namestring[ 2 .. 255 ] characters

The name for the certificate template.

defaultAccessboolean

Default RADIUS access response will either be accepted or rejected.

onboardobject(OnboardDto)

The configuration of the onboard CA.

chromebookobject(ChromebookDto)

The configuration of the Chromebook.

keyLengthinteger(int32)[ 2048 .. 4096 ]

The key length for certificates generated using this template.

algorithmstring(AlgorithmEnum)

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"
{
  "description": "string",
  "name": "string",
  "defaultAccess": true,
  "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"
  },
  "chromebook": {
    "apiKey": "string",
    "certRemovalType": "NONE",
    "enrollmentType": "USER",
    "notifyAppId": "string",
    "accountCredential": "string",
    "enabled": true
  },
  "keyLength": 2048,
  "algorithm": "SHA_1"
}

Responses

The update request has been accepted and is in progress.

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

Get Specific Simple Certificate Enrollment Protocol of Template

Request

Path
templateIdstringrequired

Certificate template id

scepKeyIdstringrequired

SCEP key id

No request payload

Responses

SCEP Key

Body
idstringread-only

The unique for this simple certificate enrollment protocol key.

descriptionstring[ 0 .. 255 ] characters

Description of the item for reference.

enabledboolean

Indicates whether this key should be used.

namestring[ 2 .. 255 ] charactersrequired

The reference name of the item.

allowedSubnetsstring

If populated, only the IPs or subnets specified will be allowed to utilize the simple certificate enrollment protocol server using this key.

blockedSubnetsstring

If populated, the IPs or subnets specified will be blocked from utilizing the simple certificate enrollment protocol server using this key.

challengePasswordstring[ 4 .. 255 ] characters

If checked, the client will need to provide this password during the exchange.

expirationDatestring(date-time)required

The expire date for the key.

overrideDaysinteger(int32)[ 0 .. 365 ]

If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.

scepKeystring

The shared secret used as the key within the URL.

cnValue1stringrequired

The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the first common name as the type of value specified.

Enum"IGNORE""MAC_ADDRESS""USERNAME""DEVICE_NAME""EMAIL""LOCATION"
cnValue2stringrequired

The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the second common name as the type of value specified.

Enum"IGNORE""MAC_ADDRESS""USERNAME""DEVICE_NAME""EMAIL""LOCATION"
cnValue3stringrequired

The certificate signing requests created as part of the simple certificate enrollment protocol interaction will contain one or more common name values. The system will treat the third common name as the type of value specified.

Enum"IGNORE""MAC_ADDRESS""USERNAME""DEVICE_NAME""EMAIL""LOCATION"
challengePasswordTypestringrequired

Optionally specify a challenge password which must be provided by the client during the simple certificate enrollment protocol key exchange.

Enum"NONE""STATIC""MICROSOFT_INTUNE"
intuneTenantIdstring

The azure tenant ID from the azure configuration portal.

azureApplicationIdstring

The azure application client ID from the azure configuration portal.

azureApplicationKeystring

The azure application key and client secret configured in the azure configuration portal.

enrollmentUrlstringread-only

The URL for device enrollment.

Response
{
  "id": "string",
  "description": "string",
  "enabled": true,
  "name": "string",
  "allowedSubnets": "string",
  "blockedSubnets": "string",
  "challengePassword": "string",
  "expirationDate": "2019-08-24T14:15:22Z",
  "overrideDays": 365,
  "scepKey": "string",
  "cnValue1": "IGNORE",
  "cnValue2": "IGNORE",
  "cnValue3": "IGNORE",
  "challengePasswordType": "NONE",
  "intuneTenantId": "string",
  "azureApplicationId": "string",
  "azureApplicationKey": "string",
  "enrollmentUrl": "string"
}