Group Role Names Configuration

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.

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

Attributes and validations