Perform a partial update to a team. Updating a team uses the semantic patch format.
Click to expand instructions for updating teams
addCustomRoles
Adds custom roles to the team. Team members will have these custom roles granted to them.
Parameters
values
: List of custom role keys.
Here’s an example:
addMembers
Adds members to the team.
Parameters
values
: List of member IDs to add.
Here’s an example:
addPermissionGrants
Adds permission grants to members for the team. For example, a permission grant could allow a member to act as a team maintainer. A permission grant may have either an actionSet
or a list of actions
but not both at the same time. The members do not have to be team members to have a permission grant for the team.
Parameters
actionSet
: Name of the action set.
actions
: List of actions.
memberIDs
: List of member IDs.
Here’s an example:
addRoleAttribute
Adds a role attribute to a team. Team members will have these role attribute values scoped for all custom roles granted to them.
Parameters
key
: The role attribute key to add.
values
: List of role attribute values for that key.
Here’s an example:
removeCustomRoles
Removes custom roles from the team. The app will no longer grant these custom roles to the team members.
Parameters
values
: List of custom role keys.
Here’s an example:
removeMembers
Removes members from the team.
Parameters
values
: List of member IDs to remove.
Here’s an example:
removePermissionGrants
Removes permission grants from members for the team. A permission grant may have either an actionSet
or a list of actions
but not both at the same time. The actionSet
and actions
must match an existing permission grant.
Parameters
actionSet
: Name of the action set.
actions
: List of actions.
memberIDs
: List of member IDs.
Here’s an example:
removeRoleAttribute
Removes a role attribute from the team.
Parameters
key
: The role attribute key to remove.
Here’s an example:
replaceMembers
Replaces the existing members of the team with the new members.
Parameters
values
: List of member IDs of the new members.
Here’s an example:
replaceRoleAttributes
Replaces the existing role attributes for the team with new role attributes.
Parameters
value
: A map of role attribute keys to lists of role attribute values
Here’s an example:
updateDescription
Updates the description of the team.
Parameters
value
: The new description.
Here’s an example:
updateName
Updates the name of the team.
Parameters
Here’s an example:
updateRoleAttribute
Updates a role attribute on the team. Any existing values for the given key will be replaced with the new values. Team members will have these role attribute values scoped for all custom roles granted to them.
Parameters
key
: The role attribute key to update.
values
: List of role attribute values for that key.
Here’s an example:
LaunchDarkly supports four fields for expanding the “Update team” response. By default, these fields are not included in the response.