Account members (beta)

This feature is in beta

To use this feature, pass in a header including the LD-API-Version key with value set to beta. 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.

Modify account members

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.

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.

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 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.

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.

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 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.
Request
Request Body schema: application/json
comment
string

Optional comment describing the update

required
Array of objects (Instructions)
Responses
200

Members response

400

Invalid request

401

Invalid access token

403

Forbidden

409

Status conflict

429

Rate limited

patch/api/v2/members
Request samples
application/json
{
  • "comment": "Optional comment about the update",
  • "instructions": [
    ]
}
Response samples
application/json
{
  • "members": [
    ],
  • "errors": [
    ]
}