Modify account members
Full use of this API resource is an Enterprise feature
The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, read about our pricing. To upgrade your plan, contact Sales.
Perform a partial update to multiple members. Updating members 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 members.
Click to expand instructions for updating members
replaceMembersRoles
Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members.
Parameters
value
: The new role. Must be a valid built-in role. To learn more about built-in roles, read LaunchDarkly’s built-in roles.memberIDs
: List of member IDs.
Here’s an example:
replaceAllMembersRoles
Replaces the roles of all members. This also removes all custom roles assigned to the specified members.
Members that match any of the filters are excluded from the update.
Parameters
value
: The new role. Must be a valid built-in role. To learn more about built-in roles, read LaunchDarkly’s built-in roles.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 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:
replaceMembersCustomRoles
Replaces the custom roles of the specified members.
Parameters
values
: List of new custom roles. Must be a valid custom role key or ID.memberIDs
: List of member IDs.
Here’s an example:
replaceAllMembersCustomRoles
Replaces the custom roles of all members. Members that match any of the filters are excluded from the update.
Parameters
values
: List of new roles. Must be a valid custom role key or ID.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 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:
replaceMembersRoleAttributes
Replaces the role attributes of the specified members.
Parameters
value
: Map of role attribute keys to lists of values.memberIDs
: List of member IDs.
Here’s an example:
Headers
Request
The instructions to perform when updating. This should be an array with objects that look like <code>{“kind”: “update_action”}</code>. Some instructions also require additional parameters as part of this object.
Optional comment describing the update
Response
Members response
A list of members IDs of the members who were successfully updated.
A list of member IDs and errors for the members whose updates failed.