Overview| Excerpt |
|---|
This web services API allows service providers to automatically create users and tenants. |
The interface is implemented using Web Services. RequirementMake sure that the version 3 API is enabled. API CallsThe Provisioning API provides the following Web Services calls: | Section |
|---|
| Column |
|---|
| | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 45 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Authentication |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-auth" and space = currentSpace ( ) |
|---|
| labels | provapi-auth |
|---|
|
|
| Column |
|---|
| | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 45 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Users |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-user" and space = currentSpace ( ) |
|---|
| labels | provapi-user |
|---|
|
|
|
| Section |
|---|
| Column |
|---|
| | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Groups |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-group" and space = currentSpace ( ) |
|---|
| labels | provapi-group |
|---|
|
|
| Column |
|---|
| | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Extensions |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-ext" and space = currentSpace ( ) |
|---|
| labels | provapi-ext |
|---|
|
|
|
| Section |
|---|
| Column |
|---|
| | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Environments |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-env" and space = currentSpace ( ) |
|---|
| labels | provapi-env |
|---|
|
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 45 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Miscellaneous |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-misc" and space = currentSpace ( ) |
|---|
| labels | provapi-misc |
|---|
|
|
| Column |
|---|
| | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 45 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Storage |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-storage" and space = currentSpace ( ) |
|---|
| labels | provapi-misc |
|---|
|
|
|
Data typesThe Provisioning Web Service uses three fundamental data types, that represent user provisioning related entities: | Section |
|---|
| Column |
|---|
| | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 45 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Main entities |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-data-main" and space = currentSpace ( ) |
|---|
| labels | provapi-data-main |
|---|
|
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 45 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Reponse types |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-data-response" and space = currentSpace ( ) |
|---|
| labels | provapi-data-response |
|---|
|
|
| Column |
|---|
| | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 45 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| excerpt | true |
|---|
| title | Miscellaneous |
|---|
| excerptType | simple |
|---|
| cql | label = "provapi-v3-data-misc" and space = currentSpace ( ) |
|---|
| labels | provapi-data-misc |
|---|
|
|
|
Tips for developersTo 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. |