Update teams
Perform a partial update to multiple teams. Updating teams uses the semantic patch format.
To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.
Instructions
Semantic patch requests support the following kind instructions for updating teams.
addMembersToTeams
Add the members to teams.
Parameters
memberIDs: List of member IDs to add.teamKeys: List of teams to update.
Here's an example:
{ "instructions": [{ "kind": "addMembersToTeams", "memberIDs": [ "1234a56b7c89d012345e678f" ], "teamKeys": [ "example-team-1", "example-team-2" ] }]}addAllMembersToTeams
Add all members to the team. Members that match any of the filters are excluded from the update.
Parameters
teamKeys: List of teams to update.filterLastSeen: (Optional) A JSON object with one of the following formats:{"never": true}- Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM.{"noData": true}- Members that have not been active since LaunchDarkly began recording last seen timestamps.{"before": 1608672063611}- Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds.
filterQuery: (Optional) A string that matches against the members' emails and names. It is not case sensitive.filterRoles: (Optional) A|separated list of roles and custom roles. For the purposes of this filtering,Ownercounts asAdmin.filterTeamKey: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive.ignoredMemberIDs: (Optional) A list of member IDs.
Here's an example:
{ "instructions": [{ "kind": "addAllMembersToTeams", "teamKeys": [ "example-team-1", "example-team-2" ], "filterLastSeen": { "never": true } }]}Authorization
ApiKey read, writeIn: header
Scope: read, write
Request Body
application/json
Optional comment describing the update
The instructions to perform when updating. This should be an array with objects that look like {"kind": "update_action"}. Some instructions also require additional parameters as part of this object.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v2/teams" \ -H "Content-Type: application/json" \ -d '{ "comment": "Optional comment about the update", "instructions": [ { "kind": "addMembersToTeams", "memberIDs": [ "1234a56b7c89d012345e678f" ], "teamKeys": [ "example-team-1", "example-team-2" ] } ] }'{ "memberIDs": [ "1234a56b7c89d012345e678f" ], "teamKeys": [ "example-team-1" ], "errors": [ { "example-team-2": "example failure message" } ]}Get team custom roles GET
Fetch the custom roles that have been assigned to the team. To learn more, read [Managing team permissions](https://launchdarkly.com/docs/home/account/team-permissions).
Get workflow templates GET
Get workflow templates belonging to an account, or can optionally return templates_endpoints.workflowTemplateSummariesListingOutputRep when summary query param is true