Provisioning API version 2
- Kiss, Mate
Owned by Kiss, Mate
May 25, 2022
1 min read
Loading data...
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 2 API is enabled.
API Calls
The Provisioning API provides the following Web Services calls:
Authentication
-
ReleaseToken (v2) — Releases a token
-
RequestToken (v2) — Requests an authentication token
Users
-
CreateUser (v2) — Creates a user.
-
DeleteUser (v2) — Deletes a User.
-
GetUserByLoginNameAndEnvironment (v2) — Returns a user.
-
ListUsers (v2) — Lists users.
-
UpdateUser (v2) — Updates a user.
Groups
-
CreateGroup (v2) — Creates a new Group.
-
DeleteGroup (v2) — Deletes a Group.
-
GetGroupByNameAndEnvironment (v2) — Reads a Group.
-
ListGroups (v2) — Lists groups.
-
UpdateGroup (v2) — Updates a group.
Extensions
-
ApplyExtensionConfiguration (v2) — Applies the extension configuration.
-
CreateExtension (v2) — Creates an extension.
-
GetExtension (v2) — Reads an extension.
-
ListExtensions (v2) — Returns an extension list.
-
UpdateExtension (v2) — Updates an extension.
Environments
-
CreateEnvironment (v2) — Create a new Environment.
-
GetEnvironmentByEid (v2) — Reads a tenant based on its ID.
-
GetEnvironmentByShortName (v2) — Reads a tenant based on its short name.
-
ListEnvironments (v2) — Returns an environment list.
-
UpdateEnvironment (v2) — Updates an environment.
Storage
-
CreateStorageFolder (v2) — Creates a new Storage Folder.
-
CreateStoragePolicy (v2) — Creates a new Storage Policy.
-
GetStorageFolderById (v2) — Returns a Storage Folder information by id.
-
GetStoragePolicyById (v2) — Returns a Storage Policy information by id.
-
GetStoragePolicyByName (v2) — Returns a Storage Policy information by name.
-
ListStorageFolders (v2) — Lists Storage Folders.
-
ListStorageFoldersByEid (v2) — Lists Storage Folders by eid.
-
ListStoragePolicies (v2) — Lists Storage Policies.
-
ListStoragePoliciesByEid (v2) — Lists Storage Policies by eid.
-
UpdateStorageFolder (v2) — Updates a Storage Folder.
-
UpdateStoragePolicy (v2) — Updates a Storage Policy.
Miscellaneous
-
GetStatistics (v2) — Reads user and tenant statistics.
-
GetVersion (v2) — Returns the API version.
Data types
The Provisioning Web Service uses three fundamental data types, that represent user provisioning related entities:
Main entities
-
ApplyExtensionConfigurationResponseServer (v2) — Represents the extension configuration.
-
CallStatistic (v2) — Represents a call statistic.
-
Environment (v2) — Represents a tenant.
-
Extension (v2) — Represents a phone extension.
-
Group (v2) — Represents a group.
-
GroupMembership (v2) — Represents a user.
-
Location (v2) — Represents the location.
-
Status (v2) — Return status of API calls.
-
StorageFolder (v2) — Represents a storage folder.
-
StoragePolicy (v2) — Represents a storage policy.
-
User (v2) — Represents a user.
Miscellaneous
-
CallSourceType (v2) — Possible call source types.
-
CallStatisticsFilter (v2) — Used to filter call statistic.
-
CallStatisticsType (v2) — Possible call statistic types.
-
EnvironmentFilter (v2) — Used to filter tenants.
-
ExtensionFilter (v2) — Used to filter extensions.
-
GroupFilter (v2) — Used to filter groups.
-
GroupMembershipFilter (v2) — Used to filter group memberships.
-
RecordingModeType (v2) — Possible recording mode types.
-
StatusCode (v2) — Return code for API calls.
-
StorageFolderFilter (v2) — Used to filter storage folders.
-
StoragePolicyFilter (v2) — Used to filter storage policies.
-
UserFilter (v2) — Used to filter users.
Reponse types
-
ApplyExtensionConfigurationResponse (v2) — Returned extension configuration information.
-
CreateOrUpdateGroupResponse (v2) — Returned group create/update information.
-
CreateOrUpdateStorageFolderResponse (v2) — Returned storage folder create/update information.
-
CreateOrUpdateStoragePolicyResponse (v2) — Returned storage policy create/update information.
-
CreateOrUpdateUserResponse (v2) — Returned user create/update information.
-
GetEnvironmentResponse (v2) — Returned tenant information.
-
GetEnvironmentsResponse (v2) — Returned tenant information for all tenants.
-
GetExtensionResponse (v2) — Returned extension information.
-
GetExtensionsResponse (v2) — Returned extension information for all extensions.
-
GetGroupMembershipResponse (v2) — Returned group membership information.
-
GetGroupMembershipsResponse (v2) — Returned group membership information for all group memberships.
-
GetGroupResponse (v2) — Returned group information.
-
GetGroupsResponse (v2) — Returned group information.
-
GetStorageFolderResponse (v2) — Returned storage folder information.
-
GetStorageFoldersResponse (v2) — Returned storage folder information for all storage folders.
-
GetStoragePoliciesResponse (v2) — Returned storage policies information for all storage policies.
-
GetStoragePolicyResponse (v2) — Returned storage policy information.
-
GetUserResponse (v2) — Returned user information.
-
GetUsersResponse (v2) — Returned user information for all users.
-
GetVersionResponse (v2) — Returned Provision API version information.
-
StatisticsResponse (v2) — Response of call statistic requests.
-
TokenResponse (v2) — Response of token requests.
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:7002/provisioning?wsdl