Certificate Template (0.0.1)

Download OpenAPI description

Download PDF

Overview

License

RUCKUS Cloud Privacy Policy

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 msi package by ID

Request

Retrieves a specific MSI package by ID.

Path

templateIdstringrequired

Certificate template id

msiPackageIdstringrequired

MSI package id

No request payload

Responses

MSI Package

Body

idstringread-only

The unique identifier for this configuration.

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"

passphrasestringread-only

The passphrase for the 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"

Response

{
  "id": "string",
  "description": "string",
  "enabled": true,
  "name": "string",
  "allowedSubnets": "string",
  "blockedSubnets": "string",
  "expirationDate": "2024-01-01",
  "passphrase": "string",
  "productId": "string",
  "productName": "string",
  "profileType": "USER_TYPE",
  "usernameVariableSource": "COMPUTER_NAME"
}

Delete msi package

Request

Deletes an MSI package from a certificate template.

Path

templateIdstringrequired

Certificate template id

msiPackageIdstringrequired

MSI package id

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 msi package

Request

Updates an MSI package for a certificate template.

Path

templateIdstringrequired

Certificate template id

msiPackageIdstringrequired

MSI Package id

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

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