- 03 May 2023
- 2 Minutes To Read
- Print
- DarkLight
- PDF
Group Role Names Configuration
- Updated On 03 May 2023
- 2 Minutes To Read
- Print
- DarkLight
- PDF
Group role names are used to determine specific roles for members within a group. For more information, see Group Role Names.
With Configuration as Code (CasC), you may batch configure your group role names configuration via the API using YAML. For general information on CasC, see Configuration as Code Overview.
API Operations
CasC for group role names supports two operations.
Action | Endpoint | Description |
---|---|---|
GET | /configuration/grouprolenames.yaml | Get current group role names configuration. |
PUT | /configuration/grouprolenames.yaml | Write a new group role names configuration to Mambu. |
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.
With regards to authentication, {auth} is the base-64-encoded value of username:password
. For more information, see Authentication in our API reference.
GET configuration
curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/grouprolenames.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/grouprolenames.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Content-Type: application/yaml' \
-H 'Authorization: Basic {auth}' \
--data-binary @grouprolenames.yaml
{auth} is the base-64-encoded value of username:password
. For more information, see Authentication in our API reference.
“@grouprolenames.yaml” represents the absolute path of the file on your device.
Use “--data-raw” if you want to specify the YAML body inline.
Configuration example
In this configuration, id
and name
are the only supported fields.
---
groupRoleNames:
- id: "mng11"
name: "Manager"
- id: "grId2"
name: "Group Role Name 2"
- id: "grId133"
name: "Group Role Name 3"
- id: "grId4"
name: "Group Role Name 4"
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.
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.
Attributes and validations
Name | Type | Description | Required |
---|---|---|---|
id | String | Must not exceed 32 characters in length and must be unique in the configuration. | ✔ |
name | String | Must not exceed 256 characters in length. | ✔ |