Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fix link to the WSDL file

...

Section
Column

Overview

Excerpt

This web services API allows service providers to automatically create users and tenants. 

The interface is implemented using Web Services.

Table of Contents
minLevel2

Requirement

Make sure that the version 3 API is enabled.

API Calls

The Provisioning API provides the following Web Services calls:

Section
Column
width50%

Content by Label
showLabelsfalse
max45
showSpacefalse
sorttitle
excerpttrue
titleAuthentication
excerptTypesimple
cqllabel = "provapi-v3-auth" and space = currentSpace()
labelsprovapi-auth

Column
width50%

Content by Label
showLabelsfalse
max45
showSpacefalse
sorttitle
excerpttrue
titleUsers
excerptTypesimple
cqllabel = "provapi-v3-user" and space = currentSpace()
labelsprovapi-user

Section
Column
width50%

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
excerpttrue
titleGroups
excerptTypesimple
cqllabel = "provapi-v3-group" and space = currentSpace()
labelsprovapi-group

Column
width50%

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
excerpttrue
titleExtensions
excerptTypesimple
cqllabel = "provapi-v3-ext" and space = currentSpace()
labelsprovapi-ext

Section
Column
width50%

Content by Label
showLabelsfalse
showSpacefalse
sorttitle
excerpttrue
titleEnvironments
excerptTypesimple
cqllabel = "provapi-v3-env" and space = currentSpace()
labelsprovapi-env


Content by Label
showLabelsfalse
max45
showSpacefalse
sorttitle
excerpttrue
titleMiscellaneous
excerptTypesimple
cqllabel = "provapi-v3-misc" and space = currentSpace()
labelsprovapi-misc
Column
width50%

Content by Label
showLabelsfalse
max45
showSpacefalse
sorttitle
excerpttrue
titleStorage
excerptTypesimple
cqllabel = "provapi-v3-storage" and space = currentSpace()
labelsprovapi-misc

Section
Column
width50%


Data types

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

Section
Column
width50%

Content by Label
showLabelsfalse
max45
showSpacefalse
sorttitle
excerpttrue
titleMain entities
excerptTypesimple
cqllabel = "provapi-v3-data-main" and space = currentSpace()
labelsprovapi-data-main


Content by Label
showLabelsfalse
max45
showSpacefalse
sorttitle
excerpttrue
titleReponse types
excerptTypesimple
cqllabel = "provapi-v3-data-response" and space = currentSpace()
labelsprovapi-data-response
Column
width50%

Content by Label
showLabelsfalse
max45
showSpacefalse
sorttitle
excerpttrue
titleMiscellaneous
excerptTypesimple
cqllabel = "provapi-v3-data-misc" and space = currentSpace()
labelsprovapi-data-misc


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/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.