Modify account members

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/members \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "Optional comment about the update",
  "instructions": [
    {
      "kind": "replaceMembersRoles",
      "memberIDs": [
        "1234a56b7c89d012345e678f",
        "507f1f77bcf86cd799439011"
      ],
      "value": "reader"
    }
  ]
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/members"

payload = {
    "comment": "Optional comment about the update",
    "instructions": [
        {
            "kind": "replaceMembersRoles",
            "memberIDs": ["1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011"],
            "value": "reader"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comment: 'Optional comment about the update',
    instructions: [
      {
        kind: 'replaceMembersRoles',
        memberIDs: ['1234a56b7c89d012345e678f', '507f1f77bcf86cd799439011'],
        value: 'reader'
      }
    ]
  })
};

fetch('https://app.launchdarkly.com/api/v2/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => 'Optional comment about the update',
    'instructions' => [
        [
                'kind' => 'replaceMembersRoles',
                'memberIDs' => [
                                '1234a56b7c89d012345e678f',
                                '507f1f77bcf86cd799439011'
                ],
                'value' => 'reader'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/members"

	payload := strings.NewReader("{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"replaceMembersRoles\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\",\n        \"507f1f77bcf86cd799439011\"\n      ],\n      \"value\": \"reader\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/members")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"replaceMembersRoles\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\",\n        \"507f1f77bcf86cd799439011\"\n      ],\n      \"value\": \"reader\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"replaceMembersRoles\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\",\n        \"507f1f77bcf86cd799439011\"\n      ],\n      \"value\": \"reader\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "members": [
    "1234a56b7c89d012345e678f"
  ],
  "errors": [
    {
      "507f1f77bcf86cd799439011": "you cannot modify your own role"
    }
  ]
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "optimistic_locking_error",
  "message": "Conflict. Optimistic lock error. Try again later."
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

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 base role. To learn more, read Roles.
memberIDs: List of member IDs.

Here’s an example:

{
  "instructions": [{
    "kind": "replaceMembersRoles",
    "value": "reader",
    "memberIDs": [
      "1234a56b7c89d012345e678f",
      "507f1f77bcf86cd799439011"
    ]
  }]
}

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 base role. To learn more, read 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.

Here’s an example:

{
  "instructions": [{
    "kind": "replaceAllMembersRoles",
    "value": "reader",
    "filterLastSeen": { "never": true }
  }]
}

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:

{
  "instructions": [{
    "kind": "replaceMembersCustomRoles",
    "values": [ "example-custom-role" ],
    "memberIDs": [
      "1234a56b7c89d012345e678f",
      "507f1f77bcf86cd799439011"
    ]
  }]
}

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.

Here’s an example:

{
  "instructions": [{
    "kind": "replaceAllMembersCustomRoles",
    "values": [ "example-custom-role" ],
    "filterLastSeen": { "never": true }
  }]
}

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:

{
  "instructions": [{
    "kind": "replaceMembersRoleAttributes",
    "value": {
      "myRoleProjectKey": ["mobile", "web"],
      "myRoleEnvironmentKey": ["production"]
    },
    "memberIDs": [
      "1234a56b7c89d012345e678f",
      "507f1f77bcf86cd799439011"
    ]
  }]
}

PATCH

api

members

Modify account members

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/members \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "Optional comment about the update",
  "instructions": [
    {
      "kind": "replaceMembersRoles",
      "memberIDs": [
        "1234a56b7c89d012345e678f",
        "507f1f77bcf86cd799439011"
      ],
      "value": "reader"
    }
  ]
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/members"

payload = {
    "comment": "Optional comment about the update",
    "instructions": [
        {
            "kind": "replaceMembersRoles",
            "memberIDs": ["1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011"],
            "value": "reader"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comment: 'Optional comment about the update',
    instructions: [
      {
        kind: 'replaceMembersRoles',
        memberIDs: ['1234a56b7c89d012345e678f', '507f1f77bcf86cd799439011'],
        value: 'reader'
      }
    ]
  })
};

fetch('https://app.launchdarkly.com/api/v2/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'comment' => 'Optional comment about the update',
    'instructions' => [
        [
                'kind' => 'replaceMembersRoles',
                'memberIDs' => [
                                '1234a56b7c89d012345e678f',
                                '507f1f77bcf86cd799439011'
                ],
                'value' => 'reader'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/members"

	payload := strings.NewReader("{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"replaceMembersRoles\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\",\n        \"507f1f77bcf86cd799439011\"\n      ],\n      \"value\": \"reader\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.launchdarkly.com/api/v2/members")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"replaceMembersRoles\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\",\n        \"507f1f77bcf86cd799439011\"\n      ],\n      \"value\": \"reader\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"comment\": \"Optional comment about the update\",\n  \"instructions\": [\n    {\n      \"kind\": \"replaceMembersRoles\",\n      \"memberIDs\": [\n        \"1234a56b7c89d012345e678f\",\n        \"507f1f77bcf86cd799439011\"\n      ],\n      \"value\": \"reader\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "members": [
    "1234a56b7c89d012345e678f"
  ],
  "errors": [
    {
      "507f1f77bcf86cd799439011": "you cannot modify your own role"
    }
  ]
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "optimistic_locking_error",
  "message": "Conflict. Optimistic lock error. Try again later."
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Body

application/json

instructions

object[]

required

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.

Show child attributes

Example:

"[ { \"kind\": \"replaceMembersRoles\", \"value\": \"reader\" } ]"

comment

string

Optional comment describing the update

Example:

"Optional comment about the update"

Response

Members response

members

string[]

A list of members IDs of the members who were successfully updated.

Example:

["1234a56b7c89d012345e678f"]

errors

object[]

A list of member IDs and errors for the members whose updates failed.

Show child attributes

Example:

[
  {
    "507f1f77bcf86cd799439011": "you cannot modify your own role"
  }
]