Cisco Unity Connection Provisioning Interface (CUPI) API -- Bulk User License

From DocWiki

Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


Bulk User License APIs

The administrator uses this API to fetch all the users along with the license detail of each user. This API works in both Multi Tenancy Mode and Non Multi Tenancy Mode of Cisco Unity Connection.

If the number of users is more than 20000, the Bulk User License API performs pagination and fetches the smaller number of users.

Note: In Cisco Unity Connection 10.0(1) and later, TenantId in API response is available in Tenant Partitioning.


Listing the Users with Their License Details

Perform a GET operation to list the users along with their license details:

Get https://<connection-server>/vmrest/userlicenses

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

<UserLicenses total="2"> 
 <UserLicense> 
   <Alias>user1@Tenant1.com</Alias> 
   <Messaging>Basic</Messaging> 
   <SpeechView>Speech View Pro</SpeechView> 
   <TenantId>Tenant1</TenantId> 
 </UserLicense> 
 <UserLicense> 
   <Alias>user2@Tenant1.com</Alias> 
   <Messaging>Basic</Messaging> 
   <SpeechView>Speech View Pro</SpeechView> 
   <TenantId>Tenant1</TenantId> 
 </UserLicense> 
</UserLicenses>
Response Code: 200

JSON Example

To list all the users along with their license details, use the following:

Request URI:
GET  https://<connection-server>/vmrest/userlicenses
Accept: application /json
Connection: keep-alive

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

{   
    "@total": "2",   
    "UserLicense":    
    [            
    {         
       "Alias": "user1@Tenant1.com",         
       "Messaging": "Basic",         
       "TenantId": "Tenant1"      
    },             
    {         
       "Alias": "user2@Tenant1.com",         
       "Messaging": "Basic",         
       "TenantId": "Tenant1"      
    }   
    ]
} 
Response Code: 200

Listing Users with License Details Using Pagination

To list the users along with their license details using pagination, pass the value in the properties "rowsPerPage" and "pageNumber". By default the value of "rowsPerPage" is 2001.

Perform a GET operation to list the users along with their license details using pagination:

Get https://<connection-server>/vmrest/userlicenses?rowsPerPage=1&pageNumber=1 

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

  
<UserLicenses total="1"> 
     <UserLicense>
         <Alias>user1@Tenant1.com</Alias>
         <Messaging>Basic</Messaging>
         <SpeechView>Speech View Standard</SpeechView>
         <TenantId>Tenant1</TenantId>
     </UserLicense>
</UserLicenses> 
Response Code: 200

JSON Example

To list all the users along with their license details using pagination, use the following:

Request URI:
GET  https://<connection-server>/vmrest/userlicenses?rowsPerPage=1&pageNumber=1
Accept: application /json
Connection: keep-alive

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

{   
     "@total": "1",   
     "UserLicense":    
     {      
            "Alias": "user1@Tenant1.com",      
            "Messaging": "Basic",      
            "SpeechView": "Speech View Standard",      
            "TenantId": "Tenant1"   
     }
} 
Response Code: 200

List the Number of Users Using Licenses

To List the number of users using licenses, pass the value 0 in the property "rowsPerPage" or "pageNumber".

Perform a GET operation to list the number of users using licenses:

Get https://<connection-server>/vmrest/userlicenses?pageNumber=0 

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

<UserLicenses total="2"/> 
Response Code: 200


JSON Response

To list all the number of users using licenses, use the following:

Request URI:
GET  https://<connection-server>/vmrest/userlicenses?pageNumber=0
Accept: application /json
Connection: keep-alive

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

{"@total": "2"} 
Response Code: 200

Listing Users Using Same Type of Licenses

To list the users that are using same type of licenses, pass the "query" parameter.

Perform a GET operation to list the number of users using licenses:

Get https://<connection-server>/vmrest/userlicenses?query=(Messaging is Basic) 

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

<UserLicenses total="2"> 
     <UserLicense>
        <Alias>user1@Tenant1.com</Alias>
        <Messaging>Basic</Messaging>
        <SpeechView>Speech View Standard</SpeechView>
        <TenantId>Tenant1</TenantId>
     </UserLicense>
     <UserLicense>
        <Alias>user2@Tenant1.com</Alias>
        <Messaging>Basic</Messaging>
        <SpeechView>Speech View Standard</SpeechView>
        <TenantId>Tenant1</TenantId>
     </UserLicense>
</UserLicenses> 
<pre>
<pre>
Response Code: 200

JSON Example

To list the number of users using same type of licenses, use the following:

Request URI:
GET  https://<connection-server>/vmrest/userlicenses?query=(Messaging is Basic)
Accept: application /json
Connection: keep-alive

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

{   
      "@total": "2",   
      "UserLicense":    
      [            
      {         
          "Alias": "user1@Tenant1.com",         
          "Messaging": "Basic",         
          "SpeechView": "Speech View Standard",         
          "TenantId": "Tenant1"      
      },            
      {         
          "Alias": "user2@Tenant1.com",         
          "Messaging": "Basic",         
          "SpeechView": "Speech View Standard",         
          "TenantId": "Tenant1"      
      }   
      ]
} 
Response Code: 200

Listing License Details of a Particular User

To list the license of a particular user, pass the "query" parameter.

Perform a GET operation to list the number of users using licenses:

Get https://<connection-server>/vmrest/userlicenses?query=(Alias is user1) 

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

<UserLicenses total="1">
      <UserLicense> 
          <Alias>user1</Alias> 
          <Messaging>Basic</Messaging> 
          <SpeechView>Speech View Standard</SpeechView> 
          <TenantId>Tenant1</TenantId> 
      </UserLicense> 
</UserLicenses> 
Response Code: 200

JSON Response

To list the license of a particular user, use the following:

Request URI:
GET  https://ucbu-aricent-vm259.cisco.com/vmrest/userlicenses?query=(Alias is user1)
Accept: application /json
Connection: keep-alive

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

{   
      "@total": "1",   
      "UserLicense":    
      {      
           "Alias": "user1",      
           "Messaging": "Basic",      
           "SpeechView": "Speech View Standard",      
           "TenantId": "Tenant1"   
}
} 
<pre>
Response Code: 200

Explanation of Data Fields

Parameter Operations Data Type Comments
Alias Read Only String(64) The Alias of the user.
Messaging Read Only String Licensing Tag either Basic, Enhanced, Enhanced+
SpeechView Read Only String It is a licensing Tag that specifies the transcription service Speech View Standard or Speech View Pro This field is not displayed when users do not use the transcription service.
TenantId Read Only String This field contains the Name of the tenant to which the user belongs. This field will be populated only if the connection is working in the Multi Tenancy Mode and user belongs to a Tenant.

Rating: 0.0/5 (0 votes cast)

Personal tools