An organization is a tenant that buys and consumes a service from a Cloud Service Broker/Reseller. Normally an organization represents a company but can also represent a business unit or department.
API Details
| Organizations | |||
| Operation | Swagger Description | Method | API |
| Create an Organization | Creates new organization for the reseller | POST | /api/resellers/{resellerId}/Organizations |
| Retrieve an Organization | Returns organization details | GET | /api/resellers/{resellerId}/Organizations/{id} |
| Retrieve All Organizations | Returns all reseller organizations | GET | /api/resellers/{resellerId}/Organizations |
| Update an Organization | Updates reseller organization | PUT | /api/resellers/{resellerId}/Organizations/{id} |
| Delete an Organization | Deletes reseller organization | DELETE | /api/resellers/{resellerId}/Organizations/{id} |
API Examples
Create an Organization
| Create a Service | |
|---|---|
| End Point | /api/resellers/{resellerId}/Organizations |
| HTTP Method | POST |
| Request Body | { "name": "ABCD Company", "registrationNumber": "12345678", "vat": "56789", "homePage": "http://www.abcdcompany.com", "contact": { "name": "John Doe", "email": "johndoe@abcdcompany.com", "phone": "55555555", "cellPhone": "55555555" }, "customerNumber": "12345678", "notificationEmail": "johndoe@abcdcompany.com", "address": { "street": "55 Able Street", "postalCode": "12345", "city": "Tallinn", "countryCode": "EE" }, "approvalTriggeredOn": 0, "approvalProcessOnlyOnNewSubscriptions": true, "primaryDomain": "abcdcompany.com" } |
| Successful Example Response | 201 |
| Error Example Response | 400{ "Name": [ "The Name field is required." ], "RegistrationNumber": [ "The RegistrationNumber field is required." ] } |
API Field Definitions
| Field | Description |
| name* | The name of the organization. |
| registrationNumber* | The registration number of the organization. |
| vat | The VAT number of the organization. |
| homePage | The homepage of the organization. |
| contact* | name – First and last name of a contact person within the organization. email – The email address of the contact person. phone* – The phone number of the contact person. cellPhone – The cell phone number of the contact person. |
| customerNumber | The customer number field can be used to store a unique identifier of the organization that may correlate with customer identifiers in other systems. |
| notificationEmail* | The default notification email address. Important information may be sent to this address. The address should be a working email address. |
| address* | street – The street name of the organization. postalCode – The postal code of the organization. The postal code needs to be a valid postal code for the country. city – The city of the organization. countryCode – The country code as two-letter uppercase according to the ISO 3166 standard. |
| approvalTriggeredOn | A setting for the approval process only when customers create new subscriptions. For already existing subscriptions, the customer should be allowed to make changes without the approval process being triggered. |
| approvalProcessOnlyOnNewSubscriptions | A setting for the approval process only when customers create new subscriptions. For already existing subscriptions, the customer should be allowed to make changes without the approval process triggered. |
| primaryDomain* | A primary domain in the format “companyname.com” The primary domain needs to be a unique domain as it is used to separate organizations from each other. Generic domains like gmail.com, hotmail.com, aol.com, etc. are not allowed. |
| customProperties | Custom Properties The custom properties values can be set if they have been defined for an organization |