Versions Compared

Old Version 9

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/sbacsr?action=generatecsr

This resource defines the generatecsr action on the SBA CSR Resource . It returns the CSR as the response.

Tip

Ensure that the SBA is successfully activated with the Lync server prior to generating the CSR using the activatewithlync action . This action can be re-used any time to renew the certificate. Failure to follow the correct order of steps may result in undesirable behavior.

If the CSR is to be auto-submitted to the CA, then the response will not contain any CSR. If the CSR is not to be auto-submitted, then the CSR content will be returned in the response and is to be manually submitted to the CA.

An HTTP Status 200 return for this action only means that the request was successfully received by the system. Status of the action must be retrieved using the SBA Action Status Resource .

URL:

https://192.168.0.111/rest/sbacsr?action=generatecsr

HTTP Method

POST

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[sbacsr - REST API Methods|Resource - sbacsr]

Page Tree
root@parent



Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
CAYesNostringnone255 - Max LengthSpecifies the CA Host name to which the generated CSR is to be submitted. This is needed only if the CSR is to be auto-submitted to the CA. It is not applicable for CCE CSR.
CALoginYesNostringnone255 - Max LengthSpecifies the user name to authenticate with the CA. It is in the format of username@domain. This is needed only if the CSR is to be auto-submitted to the CA. It is not applicable for CCE CSR.
CAPasswordYesNostringnone255 - Max LengthSpecifies the user password to use upon authenticating with the CA. This is needed only if the CSR is to be auto-submitted to the CA. This is not applicable for CCE CSR.
DomainNoNostringnone255 - Max LengthSpecifies the common name to be used in the certificate. It is the value displayed in the Common Name field in the UI in the SBC CSR/Certificate tab. This will be automatically set as the localhost string for the SBA CSR. For the CCE CSR, this needs to be the Edge Server Public FQDN.
EmailNoNostringnone255 - Max LengthSpecifies the SBA Computer name to be used in the certificate. It relates to the Friendly Name field as displayed in the UI in the SBC CSR/Certificate tab. This is not applicable for the CCE CSR.
OrganizationNoNostringnone255 - Max LengthSpecifies the organization name under which your business is legally registered.
OUNoNostringnone255 - Max LengthSpecifies the division within the organization.
CityNoNostringnone255 - Max LengthSpecifies the name of the city where your organization is legally registered.
StateNoNostringnone255 - Max LengthSpecifies the name of the state where your organization is legally registered.
CountryYesNostringnone8 - Max LengthSpecifies the ISO format country code for the country where your organization is legally registered.
CsrTemplateYesNostringnone255 - Max LengthSpecifies the template name for the CSR, e.g, WebServer, User. This is not applicable for CCE CSR.
KeySizeNoNoint2048Specifies the key size to use when generating the CSR public private key pair. Possible values are 2048 and 4096. Units is bits.
SubjectAlternativeNameNoNostringnone10000 - Max LengthSpecifies the Subject Alternative Name to be used in the certificate.