This feature is in beta
To use this feature, pass in a header including the
LD-API-Version
key with value set tobeta
. Use this header with each call. To learn more, read Beta resources.Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.
Teams is an Enterprise feature
Teams is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.
A team is a group of members in your LaunchDarkly account. A team can have maintainers who are able to add and remove team members. It also can have custom roles assigned to it that allows shared access to those roles for all team members. To learn more, read 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.
Semantic patch requests support the following kind
instructions for updating teams.
Add the members to teams.
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"
]
}]
}
Add all members to the team. Members that match any of the filters are excluded from the update.
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, Owner
counts as Admin
.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 }
}]
}
Teams response
Invalid request
Invalid access token
Forbidden
Status conflict
Rate limited
{- "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"
}
]
}