Account members

Get account member

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Get a single account member by member ID.

me is a reserved value for the id parameter that returns the caller’s member information.

Expanding the member response

LaunchDarkly supports the following fields for expanding the “Get member” response. By default, these fields are not included in the response.

To expand the response, append the expand query parameter and add a comma-separated list with any of the following fields:

customRoles includes details on each custom role assigned to the member, including the role key, name, and ID.
roleAttributes includes a list of the role attributes that you have assigned to the member.

For example, expand=customRoles,roleAttributes includes both the customRolesInfo and roleAttributes fields in the response.

GET

api

members

{id}

Get account member

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/members/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/members/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "_links": {},
  "_id": "507f1f77bcf86cd799439011",
  "role": "reader",
  "email": "ariel@acme.com",
  "_pendingInvite": false,
  "_verified": true,
  "customRoles": [
    "devOps",
    "backend-devs"
  ],
  "mfa": "<string>",
  "_lastSeen": "1608260796147",
  "creationDate": "1628001602644",
  "firstName": "Ariel",
  "lastName": "Flores",
  "_pendingEmail": "<string>",
  "excludedDashboards": [
    "<string>"
  ],
  "_lastSeenMetadata": {
    "tokenId": "5b52207f8ca8e631d31fdb2b"
  },
  "_integrationMetadata": {
    "externalId": "<string>",
    "externalStatus": {
      "display": "<string>",
      "value": "<string>"
    },
    "externalUrl": "<string>",
    "lastChecked": 123
  },
  "teams": [
    {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team",
      "_links": {}
    }
  ],
  "permissionGrants": [
    {
      "resource": "team/qa-team",
      "actionSet": "<string>",
      "actions": [
        "maintainTeam"
      ]
    }
  ],
  "oauthProviders": [
    "<string>"
  ],
  "version": 1,
  "roleAttributes": {}
}

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

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

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

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

Authorizations

Authorization

string

header

required

Path Parameters

string<string>

required

The member ID

Query Parameters

expand

string<string>

A comma-separated list of properties that can reveal additional information in the response.

Response

Member response

_links

object

required

The location and content type of related resources

Show child attributes

_id

string

required

The member's ID

Example:

"507f1f77bcf86cd799439011"

role

string

required

The member's base role. If the member has no additional roles, this role will be in effect.

Example:

"reader"

string

required

The member's email address

Example:

"ariel@acme.com"

_pendingInvite

boolean

required

Whether the member has a pending invitation

Example:

false

_verified

boolean

required

Whether the member's email address has been verified

Example:

true

customRoles

string[]

required

The set of additional roles, besides the base role, assigned to the member

Example:

["devOps", "backend-devs"]

mfa

string

required

Whether multi-factor authentication is enabled for this member

_lastSeen

integer<int64>

required

The member's last session date (as Unix milliseconds since epoch)

Example:

"1608260796147"

creationDate

integer<int64>

required

Timestamp of when the member was created

Example:

"1628001602644"

firstName

string

The member's first name

Example:

"Ariel"

lastName

string

The member's last name

Example:

"Flores"

_pendingEmail

string

The member's email address before it has been verified, for accounts where email verification is required

excludedDashboards

string[]

Default dashboards that the member has chosen to ignore

_lastSeenMetadata

object

Additional metadata associated with the member's last session, for example, whether a token was used

Show child attributes

_integrationMetadata

object

Details on the member account in an external source, if this member is provisioned externally

Show child attributes

teams

object[]

Details on the teams this member is assigned to

Show child attributes

permissionGrants

object[]

A list of permission grants. Permission grants allow a member to have access to a specific action, without having to create or update a custom role.

Show child attributes

oauthProviders

string[]

A list of OAuth providers

version

integer

Version of the current configuration

Example:

1

roleAttributes

object

The role attributes for the member

Show child attributes

⌘I

Get account member

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/members/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/members/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "_links": {},
  "_id": "507f1f77bcf86cd799439011",
  "role": "reader",
  "email": "ariel@acme.com",
  "_pendingInvite": false,
  "_verified": true,
  "customRoles": [
    "devOps",
    "backend-devs"
  ],
  "mfa": "<string>",
  "_lastSeen": "1608260796147",
  "creationDate": "1628001602644",
  "firstName": "Ariel",
  "lastName": "Flores",
  "_pendingEmail": "<string>",
  "excludedDashboards": [
    "<string>"
  ],
  "_lastSeenMetadata": {
    "tokenId": "5b52207f8ca8e631d31fdb2b"
  },
  "_integrationMetadata": {
    "externalId": "<string>",
    "externalStatus": {
      "display": "<string>",
      "value": "<string>"
    },
    "externalUrl": "<string>",
    "lastChecked": 123
  },
  "teams": [
    {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team",
      "_links": {}
    }
  ],
  "permissionGrants": [
    {
      "resource": "team/qa-team",
      "actionSet": "<string>",
      "actions": [
        "maintainTeam"
      ]
    }
  ],
  "oauthProviders": [
    "<string>"
  ],
  "version": 1,
  "roleAttributes": {}
}

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

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

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

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