Skip to content
Overview/
/Certificate Template/
Changed
Last updated

Certificate Template

GET /certificateAuthorities/{caId}/chains

Download CA certificate chain

Return Type:
  • Changed response : 200 OK

Downloaded chain

  • New content type : application/x-pem-file

  • Changed content type : application/x-pkcs7-certificates

POST /certificateAuthorities/{caId}/privateKeys

Upload CA private key

Return Type:
  • Changed response : 202 Accepted

The upload request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

DELETE /certificateAuthorities/{caId}/privateKeys

Delete CA private key

Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /certificateTemplates/{templateId}/certificates/{certId}/chains

Download certificate chain

Return Type:
  • Changed response : 200 OK

Downloaded certificate in chain.

  • New content type : application/x-pem-file

  • Changed content type : application/x-pkcs7-certificates

PUT /certificateTemplates/{templateId}/policySets/{policySetId}

Update template policy set

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

DELETE /certificateTemplates/{templateId}/policySets/{policySetId}

Remove template policy set

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

POST /certificates

Upload certificate

Return Type:
  • Changed response : 202 Accepted

The upload request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /certificates/{certId}/chains

Download certificate chain

Return Type:
  • Changed response : 200 OK

Downloaded certificate in chain.

  • New content type : application/x-pem-file

  • Changed content type : application/x-pkcs7-certificates

POST /certificateTemplates/{templateId}/certificates
Request:
  • Changed content type : application/json
  • Changed property variableValues (object)

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

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property variableValues (object)

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

Return Type:
  • Changed response : 202 Accepted

Certificate generated

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid certificate data

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

      • Property code (object)

        Error code identifying the type of error.

      • Property message (object)

        Message describing the error.

      • Property reason (object)

        Explanation of the cause of the error.

      • Property suggestion (object)

        Optional guidance for resolving or preventing the error.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

GET /certificateTemplates/{templateId}/certificates/{certId}

Get certificate by ID

Parameters:
  • Deleted: password in query

The password to use to encrypt the private key. To leave private key unencrypted, leave blank

  • Deleted: includeChain in query
Return Type:
  • Changed response : 404 Not Found

Certificate not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

Certificate

  • New content type : application/x-pem-file

  • Changed content type : application/x-x509-ca-cert

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

POST /certificateTemplates/{templateId}/certificates/{certId}

Download certificate private key

Request:
  • Changed content type : application/json
  • Changed property includeChain (object)

    Whether to include the certificate chain in the download.

Return Type:
  • Changed response : 200 OK

Downloaded private key of issued certificate.

  • New content type : application/pkcs1

  • Changed content type : application/x-pkcs12

PATCH /certificateTemplates/{templateId}/certificates/{certId}

Update certificate

Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

POST /certificateTemplates/{templateId}/identities/{identityId}/certificates

Generate certificate for identity

Request:
  • Changed content type : application/json
  • Changed property variableValues (object)

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

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property variableValues (object)

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

Return Type:
  • Changed response : 202 Accepted

Certificate generated

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid certificate data

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

DELETE /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Delete msi package

Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Get msi package by ID

Return Type:
  • Changed response : 404 Not Found

MSI Package not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

MSI Package

  • Changed content type : application/json

    • Changed property expirationDate (object)

      The expire date for this package.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property expirationDate (object)

      The expire date for this package.

PATCH /certificateTemplates/{templateId}/msiPackages/{msiPackageId}

Update msi package

Request:
  • Changed content type : application/json
  • Changed property expirationDate (object)

    The expire date for this package.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property expirationDate (object)

    The expire date for this package.

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

DELETE /certificateTemplates/{templateId}/notifications/{notificationId}

Delete notification

Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /certificateTemplates/{templateId}/notifications/{notificationId}

Get notification by ID

Return Type:
  • Changed response : 404 Not Found

Notification not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

Notification

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

PATCH /certificateTemplates/{templateId}/notifications/{notificationId}

Update template notification

Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

DELETE /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Delete scep key

Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Get scep key by ID

Return Type:
  • Changed response : 404 Not Found

SCEP Key not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

SCEP Key

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

PATCH /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Update scep key

Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

POST /certificateAuthorities

Create certificate authority

Request:
  • Changed content type : application/json
  • Changed property algorithm (object)

    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.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property algorithm (object)

    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.

Return Type:
  • Changed response : 202 Accepted

Certificate Authority created

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid Certificate Authority content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

POST /certificateAuthorities/query

Search certificate authorities

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying certificate authorities.

    • Changed property status (object)

      Certificate authority status filter.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying certificate authorities.

    • Changed property status (object)

      Certificate authority status filter.

Return Type:
  • Changed response : 200 OK

Certificate Authorities

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

DELETE /certificateAuthorities/{caId}

Delete certificate authority

Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

POST /certificateAuthorities/{caId}

Download CA private key

Request:
  • Changed content type : application/json
  • Changed property includeChain (object)

    Whether to include the certificate chain in the download.

Return Type:
  • Changed response : 200 OK

Downloaded private key of CA

  • New content type : application/pkcs1

  • Changed content type : application/x-pkcs12

PATCH /certificateAuthorities/{caId}

Update certificate authority

Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /certificateAuthorities/{caId}

Get certificate authority by ID

Return Type:
  • Changed response : 404 Not Found

Certificate Authority not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

Certificate Authority

  • New content type : application/x-pem-file

  • Changed content type : application/x-x509-ca-cert

  • Changed content type : application/json

    • Changed property algorithm (object)

      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.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property algorithm (object)

      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.

POST /certificateAuthorities/{caId}/certificates

Create certificate

Request:
  • Changed content type : application/json
  • Changed property algorithm (object)

    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.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property algorithm (object)

    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.

Return Type:
  • Changed response : 202 Accepted

Certificate created

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid Certificate content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

POST /certificateAuthorities/{caId}/certificates/query

Search certificates by CA

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying server certificates.

    • Changed property extendedKeyUsages (object)

      List of extended key usage filters.

    • Changed property keyUsages (object)

      List of key usage filters.

    • Changed property status (object)

      Certificate status filter.

Return Type:
  • Changed response : 200 OK

Server or Client Certificate

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

POST /certificateAuthorities/{caId}/subCas

Create sub certificate authority

Request:
  • Changed content type : application/json
  • Changed property algorithm (object)

    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.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property algorithm (object)

    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.

Return Type:
  • Changed response : 202 Accepted

Certificate Authority created

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid Certificate Authority content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

POST /certificateAuthorities/{caId}/subCas/query

Search sub certificate authorities

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying certificate authorities.

    • Changed property status (object)

      Certificate authority status filter.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying certificate authorities.

    • Changed property status (object)

      Certificate authority status filter.

Return Type:
  • Changed response : 200 OK

Certificate Authorities

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

POST /certificateAuthorities/{caId}/templates

Create template for CA

Request:
  • Changed content type : application/json

  • Changed property identityGroupId (object)

    The identity group id associated with the template.

  • Changed property algorithm (object)

    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.

  • Changed property chromebook (object)

    Chromebook configuration data transfer object.

    • Changed property apiKey (object)

      The API key for verified access operations.

    • Changed property enabled (object)

      Enabling this will allow managed chrome book to enroll automatically and install a client certificate using this certificate.

  • Changed property onboard (object)

    Onboard certificate authority configuration.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property identityGroupId (object)

    The identity group id associated with the template.

  • Changed property algorithm (object)

    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.

  • Changed property chromebook (object)

    Chromebook configuration data transfer object.

    • Changed property apiKey (object)

      The API key for verified access operations.

    • Changed property enabled (object)

      Enabling this will allow managed chrome book to enroll automatically and install a client certificate using this certificate.

  • Changed property onboard (object)

    Onboard certificate authority configuration.

Return Type:
  • Changed response : 202 Accepted

Certificate Template created

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid Certificate Template content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

POST /certificateAuthorities/{caId}/templates/query

Search templates for CA

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying certificate templates.

    • Changed property caId (object)

      List of certificate authority IDs to filter by.

    • Changed property networkId (object)

      Network ID to filter by.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying certificate templates.

    • Changed property caId (object)

      List of certificate authority IDs to filter by.

    • Changed property networkId (object)

      Network ID to filter by.

Return Type:
  • Changed response : 200 OK

Certificate Templates

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

POST /certificateTemplates/certificates/query

Search certificates

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying device certificates.

    • Changed property status (object)

      Certificate status filter.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying device certificates.

    • Changed property status (object)

      Certificate status filter.

Return Type:
  • Changed response : 200 OK

Certificates

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

POST /certificateTemplates/query

Search certificate templates

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying certificate templates.

    • Changed property caId (object)

      List of certificate authority IDs to filter by.

    • Changed property networkId (object)

      Network ID to filter by.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying certificate templates.

    • Changed property caId (object)

      List of certificate authority IDs to filter by.

    • Changed property networkId (object)

      Network ID to filter by.

Return Type:
  • Changed response : 200 OK

Certificate Templates

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

DELETE /certificateTemplates/{templateId}

Delete certificate template

Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /certificateTemplates/{templateId}

Get certificate template by ID

Return Type:
  • Changed response : 404 Not Found

Certificate Template not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

Certificate Template

  • Changed content type : application/json

    • Changed property identityGroupId (object)

      The identity group id associated with the template.

    • Changed property algorithm (object)

      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.

    • Changed property chromebook (object)

      Chromebook configuration data transfer object.

      • Changed property apiKey (object)

        The API key for verified access operations.

      • Changed property enabled (object)

        Enabling this will allow managed chrome book to enroll automatically and install a client certificate using this certificate.

    • Changed property onboard (object)

      Onboard certificate authority configuration.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property identityGroupId (object)

      The identity group id associated with the template.

    • Changed property algorithm (object)

      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.

    • Changed property chromebook (object)

      Chromebook configuration data transfer object.

      • Changed property apiKey (object)

        The API key for verified access operations.

      • Changed property enabled (object)

        Enabling this will allow managed chrome book to enroll automatically and install a client certificate using this certificate.

    • Changed property onboard (object)

      Onboard certificate authority configuration.

PATCH /certificateTemplates/{templateId}

Update certificate template

Request:
  • Changed content type : application/json

  • Changed property algorithm (object)

    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.

  • Changed property chromebook (object)

    Chromebook configuration data transfer object.

    • Changed property apiKey (object)

      The API key for verified access operations.

    • Changed property enabled (object)

      Enabling this will allow managed chrome book to enroll automatically and install a client certificate using this certificate.

  • Changed property onboard (object)

    Onboard certificate authority configuration.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property algorithm (object)

    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.

  • Changed property chromebook (object)

    Chromebook configuration data transfer object.

    • Changed property apiKey (object)

      The API key for verified access operations.

    • Changed property enabled (object)

      Enabling this will allow managed chrome book to enroll automatically and install a client certificate using this certificate.

  • Changed property onboard (object)

    Onboard certificate authority configuration.

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

POST /certificateTemplates/{templateId}/certificates/query

Search certificates in template

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying device certificates.

    • Changed property status (object)

      Certificate status filter.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying device certificates.

    • Changed property status (object)

      Certificate status filter.

Return Type:
  • Changed response : 200 OK

Certificates

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

POST /certificateTemplates/{templateId}/identities/{identityId}/certificates/query

Search certificates by identity

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying device certificates.

    • Changed property status (object)

      Certificate status filter.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying device certificates.

    • Changed property status (object)

      Certificate status filter.

Return Type:
  • Changed response : 200 OK

Certificates

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

POST /certificateTemplates/{templateId}/msiPackages

Create msi package

Request:
  • Changed content type : application/json
  • Changed property expirationDate (object)

    The expire date for this package.

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property expirationDate (object)

    The expire date for this package.

Return Type:
  • Changed response : 202 Accepted

MSI Package created

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid MSI Package content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

GET /certificateTemplates/{templateId}/msiPackages

Get template msi packages

Parameters:
  • Added: pageable in query

Parameters for paging

  • Deleted: page in query

Zero-based page index (0..N)

  • Deleted: size in query

The size of the page to be returned

  • Deleted: sort in query

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Return Type:
  • Changed response : 200 OK

MSI Packages

  • Changed content type : application/json

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

POST /certificateTemplates/{templateId}/notifications

Create notification for template

Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 202 Accepted

Notification created

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid Notification content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

GET /certificateTemplates/{templateId}/notifications

Get template notifications

Parameters:
  • Added: pageable in query

Parameters for paging

  • Deleted: page in query

Zero-based page index (0..N)

  • Deleted: size in query

The size of the page to be returned

  • Deleted: sort in query

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Return Type:
  • Changed response : 200 OK

Notifications

  • Changed content type : application/json

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

POST /certificateTemplates/{templateId}/scepKeys

Create scep key

Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 202 Accepted

SCEP Key created

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 400 Bad Request

Invalid SCEP Key content

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

GET /certificateTemplates/{templateId}/scepKeys

Get template scep keys

Parameters:
  • Added: pageable in query

Parameters for paging

  • Deleted: page in query

Zero-based page index (0..N)

  • Deleted: size in query

The size of the page to be returned

  • Deleted: sort in query

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Return Type:
  • Changed response : 200 OK

SCEP Keys

  • Changed content type : application/json

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property content (object)

      List of items contained in the current page.

    • Changed property empty (object)

      Whether the page is empty.

    • Changed property first (object)

      Whether this is the first page.

    • Changed property last (object)

      Whether this is the last page.

    • Changed property number (object)

      Current page index starting from 0.

    • Changed property numberOfElements (object)

      Number of items present in the current page.

    • Changed property totalElements (object)

      Total number of items across all pages.

    • Changed property totalPages (object)

      Total number of pages available.

    • Changed property pageable (object)

      Pagination information for a page request, including page size, page number, and sorting metadata.

      • Changed property pageNumber (object)

        Requested page index starting from 0.

      • Changed property pageSize (object)

        Number of items to include in each page.

      • Changed property paged (object)

        Whether paging is enabled.

      • Changed property unpaged (object)

        Whether paging is disabled.

    • Changed property sort (object)

      Sorting details applied to the query.

      • Changed property empty (object)

        Whether no sorting is applied.

      • Changed property sorted (object)

        Whether sorting is applied.

      • Changed property unsorted (object)

        Whether sorting is not applied.

POST /certificates/query

Search certificates

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying server certificates.

    • Changed property extendedKeyUsages (object)

      List of extended key usage filters.

    • Changed property keyUsages (object)

      List of key usage filters.

    • Changed property status (object)

      Certificate status filter.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    List of field names to include in the response.

  • Changed property pageSize (object)

    Number of items per page for pagination.

  • Changed property searchString (object)

    Search string to filter results.

  • Changed property searchTargetFields (object)

    List of field names to search within.

  • Changed property sortField (object)

    Field name to sort the results by.

  • Changed property sortOrder (object)

    Sort order direction (ASC or DESC).

  • Changed property filters (object)

    Filters for querying server certificates.

    • Changed property extendedKeyUsages (object)

      List of extended key usage filters.

    • Changed property keyUsages (object)

      List of key usage filters.

    • Changed property status (object)

      Certificate status filter.

Return Type:
  • Changed response : 200 OK

Certificate

  • Changed content type : application/json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property fields (object)

      List of field names included in the response.

    • Changed property totalCount (object)

      Total number of items matching the query.

    • Changed property totalPages (object)

      Total number of pages available.

DELETE /certificates/{certId}

Delete certificate

Return Type:
  • Changed response : 202 Accepted

The delete request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Certificate not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 409 Conflict

Certificate cannot be deleted because it is currently in use

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

POST /certificates/{certId}

Download certificate private key

Request:
  • Changed content type : application/json
  • Changed property includeChain (object)

    Whether to include the certificate chain in the download.

Return Type:
  • Changed response : 200 OK

Downloaded private key of CA

  • New content type : application/pkcs1

  • Changed content type : application/x-pkcs12

PATCH /certificates/{certId}

Update certificate

Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 202 Accepted

The update request has been accepted and is in progress.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /certificates/{certId}

Get certificate by ID

Return Type:
  • Changed response : 404 Not Found

Certificate not found

  • Changed content type : application/json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed content type : application/vnd.ruckus.v1+json

    • Added property debugMessage (object)

      Optional diagnostic detail used for troubleshooting.

    • Added property error (object)

      Detailed error information for troubleshooting.

    • Added property errors (object)

      List of error detail objects.

    • Added property requestId (object)

      Identifier for tracking the failed request.

    • Added property timestamp (object)

      Time when the error occurred.

  • Changed response : 200 OK

Certificate

  • Changed content type : application/x-pem-file

  • Changed content type : application/json

    • Changed property algorithm (object)

      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.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property algorithm (object)

      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.

GET /radiusProfiles/{radiusProfileId}/certificateAuthorities

Get CAs by RADIUS

Return Type:
  • Changed response : 200 OK

Certificate Authority

  • Changed content type : application/json

    • Changed property algorithm (object)

      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.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property algorithm (object)

      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.

GET /radiusProfiles/{radiusProfileId}/certificates

Get certificates by RADIUS

Return Type:
  • Changed response : 200 OK

Certificate

  • Changed content type : application/json

    • Changed property algorithm (object)

      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.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property algorithm (object)

      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.

Previous page
Next page