Skip to content
/
Get Certificate Authoriti...

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

Create New Certificate Authority

Request

Body
required
publicKeystring(binary)required

The public key of the certificate authority must be uploaded.

privateKeystring(binary)

The private key is only necessary if you plan to issue certificate using this certificate authority.

passwordstring

If upload private key is password-protected, specify the password. If not, leave the password blank.

{
  "publicKey": "string",
  "privateKey": "string",
  "password": "string"
}

Responses

Certificate Authority created

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

Get Specific Certificate Authority

Request

Path
caIdstringrequired

CA id

No request payload

Responses

Certificate Authority

Body
Response
No response example

Download the Private KEY of Certificate Authority

Request

Path
caIdstringrequired

Certificate id

Bodyapplication/jsonrequired
passwordstring

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

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

Responses

Downloaded private key of CA

Bodyapplication/x-pkcs12

Delete the Certificate Authority

Request

Path
caIdstringrequired

Certificate Authority id

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 Authority

Request

Path
caIdstringrequired

Certificate Authority id

Body
required
namestring[ 2 .. 255 ] characters

The name of this authority.

descriptionstring[ 0 .. 255 ] characters

The description of this authority.

{
  "name": "string",
  "description": "string"
}

Responses

The update request has been accepted and is in progress.

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

Create New Certificate Template Belonging to a Specific Certificate Authority

Request

Path
caIdstringrequired

Onboard Certificate Authority id

Body
required
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"
identityGroupIdstringrequired

The identity group id associated with the template.

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

Responses

Certificate Template created

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

Search for Templates Belonging to a Specific Certificate Authority That Match Search String in Paged Result

Request

Path
caIdstringrequired

Certificate Authority id

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

Create New Sub Certificate Authority

Request

Path
caIdstringrequired

Root Certificate Authority id

Body
required
namestring[ 2 .. 255 ] charactersrequired

The name of this authority.

commonNamestring[ 0 .. 64 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...required

The common name of this authority.

descriptionstring[ 0 .. 255 ] characters

The description of this authority.

organizationstring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The organization for the certificate authority.

organizationUnitstring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The division of your organization responsible for the certificate authority.

emailstring[ 0 .. 255 ] characters

The email address for the party responsible for the certificate authority.

startDatestring(date-time)required

The expires date of the certificate authority.

expireDatestring(date-time)required

The expires date of the certificate authority.

keyLengthinteger(int32)[ 2048 .. 4096 ]required

The key length for the certificate authority.

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"
titlestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The title for the certificate authority.

localitystring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The city where your organization is located.

statestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The state or region where your organization is located.

countrystring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The country where your organization is located.

{
  "name": "string",
  "commonName": "string",
  "description": "string",
  "organization": "string",
  "organizationUnit": "string",
  "email": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "expireDate": "2019-08-24T14:15:22Z",
  "keyLength": 2048,
  "algorithm": "SHA_1",
  "title": "string",
  "locality": "string",
  "state": "string",
  "country": "string"
}

Responses

Certificate Authority created

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

Search for Sub Certificate Authorities Matching Search String in Paged Result

Request

Path
caIdstringrequired

Certificate Authority id

Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
searchTargetFieldsArray of strings
searchStringstring
filtersobject(CaFilters)
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID"
  }
}

Responses

Certificate Authorities

Body
fieldsArray of strings
totalCountinteger(int64)
totalPagesinteger(int32)
pageinteger(int32)
dataArray of objects(CaDto)

Certificate authorities in page.

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

Upload the Certificate Authority Private KEY

Request

Path
caIdstringrequired

Certificate Authority id

Bodymultipart/form-data
privateKeystring(binary)required

Upload the private key of the certificate authority in PEM format.

passwordstring

If upload private key is password-protected, specify the password. If not, leave the password blank.

multipart/form-data
{
  "privateKey": "string",
  "password": "string"
}

Responses

The upload request has been accepted and is in progress.

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

Delete the Certificate Authority Private KEY

Request

Path
caIdstringrequired

Certificate Authority id

No request payload

Responses

The delete request has been accepted and is in progress.

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

Search for Certificate Authorities 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(CaFilters)
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "status": "INVALID"
  }
}

Responses

Certificate Authorities

Body
fieldsArray of strings
totalCountinteger(int64)
totalPagesinteger(int32)
pageinteger(int32)
dataArray of objects(CaDto)

Certificate authorities in page.

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

Get Certificate Authorities Associated with RADIUS

Request

Path
radiusProfileIdstringrequired

Radius id

Query
pageableobject(Pageable)required

parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
No request payload

Responses

Certificate Authority

Body
idstringread-only

The unique identifier for this authority.

namestring[ 2 .. 255 ] charactersrequired

The name of this authority.

commonNamestring[ 0 .. 64 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...required

The common name of this authority.

descriptionstring[ 0 .. 255 ] characters

The description of this authority.

organizationstring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The organization for the certificate authority.

organizationUnitstring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The division of your organization responsible for the certificate authority.

emailstring[ 0 .. 255 ] characters

The email address for the party responsible for the certificate authority.

startDatestring(date-time)required

The expires date of the certificate authority.

expireDatestring(date-time)required

The expires date of the certificate authority.

keyLengthinteger(int32)[ 2048 .. 4096 ]required

The key length for the certificate authority.

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"
titlestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The title for the certificate authority.

localitystring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The city where your organization is located.

statestring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The state or region where your organization is located.

countrystring[ 0 .. 255 ] characters^[.\p{Alnum}\p{Space}~&;:\\\/\'\?\,\$\{\}\.\(...

The country where your organization is located.

publicKeyBase64stringread-only

Base64 string of the public key.

privateKeyBase64stringread-only

Base64 string of the private key.

publicKeyShaThumbprintstringread-only

Thumbprint of public key.

serialNumberstringread-only

The serial number of public key of this authority.

usagesArray of stringsread-only

The extended key usage of this CA.

Items Enum"SERVER_AUTH""CLIENT_AUTH"
templateCountinteger(int32)read-only

The count of template assign this CA.

templateNamesArray of stringsread-only

The names of template assign this CA.

ocspNamestringread-only

The name hash of online certificate status protocol.

ocspHashstringread-only

The hash of online certificate status protocol.

keyUsagesArray of stringsread-only

The key usage for the CA.

Items Enum"DIGITAL_SIGNATURE""KEY_ENCIPHERMENT"
chainstringread-only

The chain of the certificate.

detailsstringread-only

The details of the certificate.

statusArray of stringsread-only

The status of the certificate of the CA.

Items Enum"INVALID""VALID""REVOKED""EXPIRED"
Response
{
  "id": "string",
  "name": "string",
  "commonName": "string",
  "description": "string",
  "organization": "string",
  "organizationUnit": "string",
  "email": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "expireDate": "2019-08-24T14:15:22Z",
  "keyLength": 2048,
  "algorithm": "SHA_1",
  "title": "string",
  "locality": "string",
  "state": "string",
  "country": "string",
  "publicKeyBase64": "string",
  "privateKeyBase64": "string",
  "publicKeyShaThumbprint": "string",
  "serialNumber": "string",
  "usages": [
    "SERVER_AUTH"
  ],
  "templateCount": 0,
  "templateNames": [
    "string"
  ],
  "ocspName": "string",
  "ocspHash": "string",
  "keyUsages": [
    "DIGITAL_SIGNATURE"
  ],
  "chain": "string",
  "details": "string",
  "status": [
    "INVALID"
  ]
}

Download the Certificate Chain of Certificate Authority

Request

Path
caIdstringrequired

Certificate id

No request payload

Responses

Downloaded chain

Bodyapplication/x-pkcs7-certificates

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