Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Certificates

From DocWiki

Revision as of 17:59, 2 October 2012 by Deeptija (Talk | contribs)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


About SIP Certificates

This section contains information on how to list, modify, and delete SIP Certificates. The SIP certificate is used only by SIP trunk integrations with Cisco Unified CM 7.0 and later, and is required for authentication of the Cisco Unity Connection voice messaging ports.


Listing SIP Certificates

Example 1

The following is an example of the GET request that lists the SIP Certificates:

 https://<connection_server>/vmrest/sipcertificates 

The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<SipCertificates total="1">
<SipCertificate>
 <URI>
  /vmrest/sipcertificates/c55ef2c3-2475-4505-9566-bcea04a6bb6e
 </URI>
 <ObjectId>c55ef2c3-2475-4505-9566-bcea04a6bb6e</ObjectId>
 <Certificate>
 -----BEGIN CERTIFICATE----- MIICVzCCAcCgAwIBAgIQQmAlZbMuRhSQnNHI4sqpDjANBgkqhkiG9w0BAQUFADA6  MTgwNgYDVQQDEy9DaXNjb1VuaXR5LWJlMjc5NzZjLTZlNmUtNDE5Zi04NTNkLWIz NzY0ODgxZGZiMDAeFw0xMjA3MTgxMzE1MTdaFw0xOTA3MTAwOTAwNThaMDsxGzAZ BgNVBAoTEkNpc2NvIFN5c3RlbXMgSW5jLjEOMAwGA1UECxMFRUNTQlUxDDAKBgNV BAMTA2FhYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAwslps1QPmb/mtfSD mHQ8tdnAPcIWriAqF283p7eQcGKdj9ji+YpDGmMFbaKG5NyPBzVCA2EXgNSrh2tX 8PTTUDUOlfGeqrol0H3kT1viFPxNIVVfnn6fuq4A8thoH54+QGlnOWqfuR6+Y4EZ yT4yhygh5yhRIDW6PTHCyhUnMuUCAwEAAaNdMFswHQYDVR0OBBYEFJ2AaJ5nN36z W6BaE5jVTEmAj54/MAsGA1UdDwQEAwIDqDAdBgNVHSUEFjAUBggrBgEFBQcDAQYI KwYBBQUHAwIwDgYDVR0RBAcwBYYDYWFhMA0GCSqGSIb3DQEBBQUAA4GBAJffZqLV 7pmQ+1HEBUO3dVnNdDr7V6izeh3KgoUHW7cEzUuM5wjsRLV7Mh8H9YvGyQP2sMMc iDRpJp4oNpnXZtwd8WEQcToaXvDOR9TfMr5tX9NdkAQGvb8pvt3kPd5cv3s79/Zy DRhjKYIr7A0dKZEpNAFUhTTHbTeNQiOibaGF -----END  CERTIFICATE-----
 </Certificate>

 <PrivateKey>
USkzHb9O2SAH6sofOA1sM91H+Whkpxl+/Sit7MF4+IfPE7u1shotouuFFO9lT11ouADtbjYp2WsqzndpjPRUZ5I4na9nc4uBqLkrQQ6FZ9r2POBgX5EkoA4l5oYUNhJyNIbdqND54Kn1iO6uIKV/NIngQBSGWM0i2Yh+HezEjP2TY9orxD0v6MHtBTsmZvcbWScwpzIAVE6dP2/OeI2+21zG82m+xLmJnfuyiZc/RcmZ2MqOqQYL3IV9Gmo8l09ocQhst2TYBCEsvI6+hId5YujfO1iyL//1rr8GD7lQVBzicFPChR0rqUnGzlilrIpnEEbenUs2HpLw/F+lg1awgGRwe3S5moYClBEor1b5g8UIPXAi0QJNF0PPm4P+ImLCfERghinxz/DSiuE5IVkwfdPUPzPknZt+4SjcX0/VU0zIg42lZ5Xl7rJRonA8a2bnFQkg9Vm8D/TTqrzAy+tdawOGdlnuAN+Hoov1prRZnR5zjkpJaImK3zE0WZyqJsyEQdVaMZEK0irb/fePw5nujRxNJi0eF/AsyDkKEazz5YrjDBZ8QuYAFOr1k9IJI0J8ZkU8krRRQCztWdY63k89XqCRzkN0SxEwu39UDajCbFOq7dbDmkalvKfp6lcrRMZy0OtpB3XgzbBvdAb6H3YZquQdCrdtwSKb/VovNssqqgWXbeocqf0vv2SSbJC+tdJIbZlDOMt7x/glz6z0GabyGb6w8SjYGN0xSUZ+ioVlmhZ8qMOZ33fwW87ctXaRo68jBDcQJHHI2aeYDABMTe3MoMI0R5A4pWUkNWGCjWhyq52kXvY8mjIRhYCEkDxEsvd6l+XRm2A02PCPpX01eeXZ5neZ30jApWkdEzfcQfV57DtEtn8NXv3GCiL59qjiABuAA0aHtUmA36m6mfuh8QWqMRRoZHI5eXUUNjeTt3kyV4jINutEu8dVAujShai/e+wNEulE4clWjh6LaoHjjjfg3MR28f0/bbv2yTPRyy/z5zW4/7z8QwKDh20fnLsLt7VatD1HcKjV2sXB50DBkLz4izVrmkLebLaIUs5pYorAVGf7MpPgVkqcbaE+A4qxpllnl2eQuQGe6a9IioFaY0UVmN3SCBke6lCDqB5qhWkqTOlJGHwV6LBz2hTnjhd62CP8668clvL3YZsC6tdA7CxJPpQZ0b36iS6CclJge2mLVa+CQNnBK68HCP+9y0YddGewEiK+8+D+x6fZC7ng+SYn2iQYHYm9BP7nYdP0YWy/aMy/ga39oHRSyjWv8GfsQNcdFdgEUMCxVx+fUK0Ao8tQKiamJjm8xyCM27UK0RBvy98=
 </PrivateKey>
 <SubjectName>test</SubjectName>
 <DisplayName>test</DisplayName>
</SipCertificate>
</SipCertificates>
 Response code: 200 


Example 2

The following is an example of the GET request that lists a specified SIP Certificate:

 https://<connection_server>/vmrest/sipcertificate/<objectId> 

The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:

<SipCertificate>
 <URI>
  /vmrest/sipcertificates/c55ef2c3-2475-4505-9566-bcea04a6bb6e
 </URI>
 <ObjectId>c55ef2c3-2475-4505-9566-bcea04a6bb6e</ObjectId>
 <Certificate>
 -----BEGIN CERTIFICATE----- MIICVzCCAcCgAwIBAgIQQmAlZbMuRhSQnNHI4sqpDjANBgkqhkiG9w0BAQUFADA6 MTgwNgYDVQQDEy9DaXNjb1VuaXR5LWJlMjc5NzZjLTZlNmUtNDE5Zi04NTNkLWIz NzY0ODgxZGZiMDAeFw0xMjA3MTgxMzE1MTdaFw0xOTA3MTAwOTAwNThaMDsxGzAZ BgNVBAoTEkNpc2NvIFN5c3RlbXMgSW5jLjEOMAwGA1UECxMFRUNTQlUxDDAKBgNV BAMTA2FhYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAwslps1QPmb/mtfSD mHQ8tdnAPcIWriAqF283p7eQcGKdj9ji+YpDGmMFbaKG5NyPBzVCA2EXgNSrh2tX 8PTTUDUOlfGeqrol0H3kT1viFPxNIVVfnn6fuq4A8thoH54+QGlnOWqfuR6+Y4EZ yT4yhygh5yhRIDW6PTHCyhUnMuUCAwEAAaNdMFswHQYDVR0OBBYEFJ2AaJ5nN36z W6BaE5jVTEmAj54/MAsGA1UdDwQEAwIDqDAdBgNVHSUEFjAUBggrBgEFBQcDAQYI KwYBBQUHAwIwDgYDVR0RBAcwBYYDYWFhMA0GCSqGSIb3DQEBBQUAA4GBAJffZqLV 7pmQ+1HEBUO3dVnNdDr7V6izeh3KgoUHW7cEzUuM5wjsRLV7Mh8H9YvGyQP2sMMc iDRpJp4oNpnXZtwd8WEQcToaXvDOR9TfMr5tX9NdkAQGvb8pvt3kPd5cv3s79/Zy DRhjKYIr7A0dKZEpNAFUhTTHbTeNQiOibaGF -----END CERTIFICATE-----
 </Certificate>
 <PrivateKey>
USkzHb9O2SAH6sofOA1sM91H+Whkpxl+/Sit7MF4+IfPE7u1shotouuFFO9lT11ouADtbjYp2WsqzndpjPRUZ5I4na9nc4uBqLkrQQ6FZ9r2POBgX5EkoA4l5oYUNhJyNIbdqND54Kn1iO6uIKV/NIngQBSGWM0i2Yh+HezEjP2TY9orxD0v6MHtBTsmZvcbWScwpzIAVE6dP2/OeI2+21zG82m+xLmJnfuyiZc/RcmZ2MqOqQYL3IV9Gmo8l09ocQhst2TYBCEsvI6+hId5YujfO1iyL//1rr8GD7lQVBzicFPChR0rqUnGzlilrIpnEEbenUs2HpLw/F+lg1awgGRwe3S5moYClBEor1b5g8UIPXAi0QJNF0PPm4P+ImLCfERghinxz/DSiuE5IVkwfdPUPzPknZt+4SjcX0/VU0zIg42lZ5Xl7rJRonA8a2bnFQkg9Vm8D/TTqrzAy+tdawOGdlnuAN+Hoov1prRZnR5zjkpJaImK3zE0WZyqJsyEQdVaMZEK0irb/fePw5nujRxNJi0eF/AsyDkKEazz5YrjDBZ8QuYAFOr1k9IJI0J8ZkU8krRRQCztWdY63k89XqCRzkN0SxEwu39UDajCbFOq7dbDmkalvKfp6lcrRMZy0OtpB3XgzbBvdAb6H3YZquQdCrdtwSKb/VovNssqqgWXbeocqf0vv2SSbJC+tdJIbZlDOMt7x/glz6z0GabyGb6w8SjYGN0xSUZ+ioVlmhZ8qMOZ33fwW87ctXaRo68jBDcQJHHI2aeYDABMTe3MoMI0R5A4pWUkNWGCjWhyq52kXvY8mjIRhYCEkDxEsvd6l+XRm2A02PCPpX01eeXZ5neZ30jApWkdEzfcQfV57DtEtn8NXv3GCiL59qjiABuAA0aHtUmA36m6mfuh8QWqMRRoZHI5eXUUNjeTt3kyV4jINutEu8dVAujShai/e+wNEulE4clWjh6LaoHjjjfg3MR28f0/bbv2yTPRyy/z5zW4/7z8QwKDh20fnLsLt7VatD1HcKjV2sXB50DBkLz4izVrmkLebLaIUs5pYorAVGf7MpPgVkqcbaE+A4qxpllnl2eQuQGe6a9IioFaY0UVmN3SCBke6lCDqB5qhWkqTOlJGHwV6LBz2hTnjhd62CP8668clvL3YZsC6tdA7CxJPpQZ0b36iS6CclJge2mLVa+CQNnBK68HCP+9y0YddGewEiK+8+D+x6fZC7ng+SYn2iQYHYm9BP7nYdP0YWy/aMy/ga39oHRSyjWv8GfsQNcdFdgEUMCxVx+fUK0Ao8tQKiamJjm8xyCM27UK0RBvy98=
 </PrivateKey>
 <SubjectName>test</SubjectName>
 <DisplayName>test</DisplayName>
</SipCertificate>
 Response code: 200 


Modifying SIP Certificates

The following is an example of the PUT request that modifies the SIP Certificates:

 https://<connection_server>/vmrest/ sipcertificates/<objectid> 

The actual response will depend upon the information given by you.

<SipCertificate>
 <SubjectName>test2</SubjectName>
 <DisplayName>test2</DisplayName>
</SipCertificate>
 Response code: 204 


Deleting SIP Certificates

The following is an example of the DELETE request that deletes a specified SIP Certificates as represented by <sipcertificateid>:

 https://<connection_server>/vmrest/sipcertificates/<objectId> 

The output for this request returns the successful response code.

 Response Code: 204 

Rating: 0.0/5 (0 votes cast)

Personal tools