Skip to content
Certificate Template/
/
Get certificate by ID

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

Generate certificate for identity

Request

Generates a certificate for a specific identity.

Path
templateIdstringrequired
identityIdstringrequired
Body
required
csrStringstring

The certificate signing request that should be signed by the CA.

userNamestring[ 2 .. 255 ] characters

The certificate template contains the variable. The value specified here will be used to replace the variable.

descriptionstring[ 0 .. 255 ] characters

Description of the item for reference.

variableValuesobject

The values in this map will be used to replace the variables in the generated certificate.

{
  "csrString": "string",
  "userName": "string",
  "description": "string",
  "variableValues": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Certificate generated

Body
requestIdstring

The unique request identifier for tracking the operation.

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

Search certificates by identity

Request

Searches for certificates associated with a specific identity.

Path
templateIdstringrequired

Certificate template id

identityIdstringrequired

Identity id

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(DeviceCertFilters)

Filters to apply when querying certificates.

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID"
  }
}

Responses

Certificates

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(DeviceCertificateDto)

Certificate in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Generate Certificate

Request

Generates a new certificate.

Path
templateIdstringrequired
Body
required
csrStringstring

The certificate signing request that should be signed by the CA.

userNamestring[ 2 .. 255 ] characters

The certificate template contains the variable. The value specified here will be used to replace the variable.

descriptionstring[ 0 .. 255 ] characters

Description of the item for reference.

variableValuesobject

The values in this map will be used to replace the variables in the generated certificate.

{
  "csrString": "string",
  "userName": "string",
  "description": "string",
  "variableValues": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Certificate generated

Body
requestIdstring

The unique request identifier for tracking the operation.

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

Get certificate by ID

Request

Retrieves a specific certificate by ID.

Path
certIdstringrequired

Certificate id

templateIdstringrequired

Certificate template id

No request payload

Responses

Certificate

Body
string(binary)
Response
No response example

Download certificate private key

Request

Downloads the private key of an issued certificate.

Path
certIdstringrequired

Certificate id

templateIdstringrequired

Certificate template id

Bodyapplication/jsonrequired
passwordstring

The password to use to encrypt the private key. If encryption is not required, please leave it blank.

includeChainboolean

Whether to include the certificate chain in the download.

application/json
{
  "password": "string",
  "includeChain": true
}

Responses

Downloaded private key of issued certificate.

Body
string(binary)

Update certificate

Request

Updates a device certificate with the provided changes.

Path
templateIdstringrequired

Certificate Template id

certIdstringrequired

Certificate id

Body
required
revocationReasonstring[ 0 .. 255 ] characters

The reason for revocation of certificate. If not revoked, this field should be null.

{
  "revocationReason": "string"
}

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

Search certificates in template

Request

Searches for certificates in a specific template matching the search criteria.

Path
templateIdstringrequired
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(DeviceCertFilters)

Filters to apply when querying certificates.

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID"
  }
}

Responses

Certificates

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(DeviceCertificateDto)

Certificate in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Search certificates

Request

Searches for certificates 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(DeviceCertFilters)

Filters to apply when querying certificates.

{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID"
  }
}

Responses

Certificates

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(DeviceCertificateDto)

Certificate in page.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "totalPages": 0,
  "page": 0,
  "data": [
    { … }
  ]
}

Download certificate chain

Request

Downloads the certificate chain in PEM format.

Path
certIdstringrequired

Certificate id

templateIdstringrequired

Certificate template id

No request payload

Responses

Downloaded certificate in chain.

Body
string(binary)

Certificate Authority

APIs for certificate authority management.

Operations

Certificate Template

APIs for certificate template management.

Operations