Skip to content
Certificate Template/
/
Delete 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

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

Delete certificate template

Request

Deletes a certificate template.

Path
templateIdstringrequired
No request payload

Responses

The delete request has been accepted and is in progress.

Body
requestIdstring

The unique request identifier for tracking the operation.

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

Update certificate template

Request

Updates a certificate template.

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)

The algorithm to use for certificates generated using this template.

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
requestIdstring

The unique request identifier for tracking the operation.

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