Provisioning API version 3

AVAILABLE IN 9.6.7 AND LATER

Overview

This web services API allows service providers to automatically create users and tenants. The interface is implemented using Web Services.

Requirement

Make sure that the version 3 API is enabled.

API Calls

The Provisioning API provides the following Web Services calls:

Authentication

Users

Groups

Extensions

Environments


Miscellaneous

Storage


Data types

The Provisioning Web Service uses three fundamental data types, that represent user provisioning related entities:

Main entities


Reponse types

  • Page:
    ApplyExtensionConfigurationResponse (v3) Returned extension configuration information.
  • Page:
    CreateOrUpdateGroupResponse (v3) Returned group create/update information.
  • Page:
    CreateOrUpdateStorageFolderResponse (v3) Returned storage folder create/update information.
  • Page:
    CreateOrUpdateStoragePolicyResponse (v3) Returned storage policy create/update information.
  • Page:
    CreateOrUpdateUserResponse (v3) Returned user create/update information.
  • Page:
    GetAnnouncementsResponse (v3) Returned list of announcement files for one announcement type.
  • Page:
    GetEnvironmentResponse (v3) Returned tenant information.
  • Page:
    GetEnvironmentsResponse (v3) Returned tenant information for all tenants.
  • Page:
    GetExtensionResponse (v3) Returned extension information.
  • Page:
    GetExtensionRulesResponse (v3) Returned a list of recording rules.
  • Page:
    GetExtensionsResponse (v3) Returned extension information for all extensions.
  • Page:
    GetForwardTypeResponse (v3) Returned list of forwarding types
  • Page:
    GetGroupMembershipResponse (v3) Returned group membership information.
  • Page:
    GetGroupMembershipsResponse (v3) Returned group membership information for all group memberships.
  • Page:
    GetGroupResponse (v3) Returned group information.
  • Page:
    GetGroupsResponse (v3) Returned group information.
  • Page:
    GetImportSourcesResponse (v3) Returned list of import sources
  • Page:
    GetSitesResponse (v3) Returned list of sites.
  • Page:
    GetSourcePlatformResponse (v3) Returned list of recorded platforms
  • Page:
    GetStorageFolderResponse (v3) Returned storage folder information.
  • Page:
    GetStorageFoldersResponse (v3) Returned storage folder information for all storage folders.
  • Page:
    GetStoragePoliciesResponse (v3) Returned storage policies information for all storage policies.
  • Page:
    GetStoragePolicyResponse (v3) Returned storage policy information.
  • Page:
    GetUserResponse (v3) Returned user information.
  • Page:
    GetUsersResponse (v3) Returned user information for all users.
  • Page:
    GetVersionResponse (v3) Returned Provision API version information.
  • Page:
    GetWorkflowsResponse (v3) Returned a list of approval workflows.
  • Page:
    StatisticsResponse (v3) — Response of call statistic requests.
  • Page:
    TokenResponse (v3) — Response of token requests.

Miscellaneous


Tips for developers

To make things faster during development we recommend using SoapUI which offers functional testing for SOAP and REST APIs.

Once you downloaded and installed it, simply create a new SOAP Project from the File menu and enter the http://MediaRepositoryIpAddress:7003/provisioning?wsdl for HTTP connection or https://MediaRepositoryIpAddress:443/verba/ws-provisioning-3?wsdl for HTTPS connection.


In the case of SOAP XML-based communication don't forget to remove the unused optional tags from the request XML.