Organization Details Configuration
- 03 May 2023
- 3 Minutes To Read
- Print
- DarkLight
- PDF
Organization Details Configuration
- Updated On 03 May 2023
- 3 Minutes To Read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
An organization is how we refer to your institution, including staff members and the different branches. For more information about your organization details, see Organization Contact Details and Time Zone.
With Configuration as Code (CasC), you may batch configure your organization configuration via the API using YAML. For general information on CasC, see Configuration as Code Overview.
API Operations
CasC for organization details supports three operations.
| Action | Endpoint | Description |
|---|---|---|
GET | /configuration/organization.yaml | Get current organization configuration. |
PUT | /configuration/organization.yaml | Write a new configuration for your organization to Mambu. |
GET | /configuration/organization/template.yaml | Get your organization configuration template in YAML. This is useful when configuring from scratch. For formatting information for the fields, see General Attributes below for an example. |
Please Note
If you PUT a configuration to Mambu, any current configuration settings not included in the new YAML configuration will be deleted. PATCH requests are not currently supported.
Requests
For general information on CasC requests such as authentication and required headers, see Configuration as Code Overview.
The following section shows sample requests using curl and basic authentication. For all examples, replace TENANT_NAME with your actual tenant name.
GET configuration
curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/organization.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'
{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.
GET configuration template
curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/organization/template.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'
{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.
PUT configuration
curl -X PUT 'https://TENANT_NAME.mambu.com/api/configuration/organization.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Content-Type: application/yaml' \
-H 'Authorization: Basic {auth}' \
--data-binary @organization.yaml
{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.
“@organization.yaml” represents the absolute path of the file on your device.
Use “--data-raw” if you want to specify the YAML body inline.
Configuration body example
institutionName: "Mambu"
address:
line1: "street address"
city: "big city"
region: "cloud country"
postcode: "90210"
country: "Countrystan"
phoneNumber: "+420456978"
emailAddress: "info@BofAlg.es"
localDateFormat: "dd-MM-yyyy"
localDateTimeFormat: "dd-MM-yyyy HH:mm:ss"
decimalSeparator: "POINT"
Attributes
| Name | Type | Description | Required |
|---|---|---|---|
address | Address | Response representation of an address. | ✘ |
decimalSeparator | String | Symbol used to mark the border between the integral and the fractional parts of a decimal numeral. Must be one of COMMA or POINT. | ✔ |
emailAddress | String | The email address of the organization. | ✘ |
institutionName | String | The name of the organization. | ✘ |
localDateFormat | String | The format used to represent the date using ISO 8601 characters, for example dd-MM-yyyy for 31-05-2020 or yy.MM.dd for 20.05.31 | ✔ |
localDateTimeFormat | String | The format used to represent the time and date using ISO 8601 characters, for example dd-MM-yyyy HH:mm:ss for 31-05-2020 12:49:49 or yy.MM.dd HH:mm:ss for 20.05.31 12:49:49 | ✔ |
phoneNumber | String | The phone number of the organization. | ✘ |
Replies
If you do not receive a 200 OK status code then fix any validation errors and make another PUT request until you receive a 200 OK status code.
Please Note
If you PUT a valid YAML configuration to the API and you do not receive a 200 OK status code within 60 seconds, you may receive a 504 Gateway Timeout status code. We expect all responses to be below 60 seconds.
If you encounter this issue, please contact us through Mambu Support so we can investigate it.
Please be Aware
Validation errors report certain issues such as invalid date formats or unsupported decimal separators, but some fields, such as email address and telephone number, are not validated.
Validations
Your input will be validated according to the same rules employed by the Mambu UI. During upload of a new configuration file, the following areas will be validated:
- Syntax is correct as per YAML standards. For example, indentation is valid, strings are enclosed in " quote " marks.
- Content is correct as defined by the template. All required fields are supplied and there are no extra, unsupported fields provided.
- References are all properly mapped and exist in the target system.
- Organization properties are accurate and correct.
Was this article helpful?
