Account members

Return a list of account members.

By default, this returns the first 20 members. Page through this list with the limit parameter and by following the first, prev, next, and last links in the returned _links field. These links are not present if the pages they refer to don't exist. For example, the first and prev links will be missing from the response on the first page.

Filtering members

LaunchDarkly supports the following fields for filters:

• query is a string that matches against the members' emails and names. It is not case sensitive.
• role is a | separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, Owner counts as Admin.
• team is a string that matches against the key of the teams the members belong to. It is not case sensitive.
• noteam is a boolean that filters the list of members who are not on a team if true and members on a team if false.
• lastSeen is a JSON object in 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.
• accessCheck is a string that represents a specific action on a specific resource and is in the format <ActionSpecifier>:<ResourceSpecifier>. It filters the list to members who have the ability to perform that action on that resource.
  • For example, the filter accessCheck:createApprovalRequest:proj/default:env/test:flag/alternate-page matches members with the ability to create an approval request for the alternate-page flag in the test environment of the default project.
  • Wildcard and tag filters are not supported when filtering for access.

For example, the filter query:abc,role:admin|customrole matches members with the string abc in their email or name, ignoring case, who also are either an Owner or Admin or have the custom role customrole.

Sorting members

LaunchDarkly supports two fields for sorting: displayName and lastSeen:

• displayName sorts by first + last name, using the member's email if no name is set.
• lastSeen sorts by the _lastSeen property. LaunchDarkly considers members that have never been seen or have no data the oldest.

Full use of this API resource is an Enterprise feature

The ability to bulk invite members is available to customers on an Enterprise plan. If you are on a Pro plan, you can invite members individually. To learn more, read about our pricing. To upgrade your plan, contact Sales.

Invite one or more new members to join an account. Each member is sent an invitation. Members with "admin" or "owner" roles may create new members, as well as anyone with a "createMember" permission for "member/*". If a member cannot be invited, the entire request is rejected and no members are invited from that request.

Each member must have an email field and either a role or a customRoles field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the "message" field of the response.

Requests to create account members will not work if SCIM is enabled for the account.

No more than 50 members may be created per request.

A request may also fail because of conflicts with existing members. These conflicts are reported using the additional code and invalid_emails response fields with the following possible values for code:

• email_already_exists_in_account: A member with this email address already exists in this account.
• email_taken_in_different_account: A member with this email address exists in another account.
• duplicate_emails: This request contains two or more members with the same email address.

A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).

Get a single account member by member ID.

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

Update a single account member. The request should be a valid JSON Patch document describing the changes to be made to the member.

To update fields in the account member object that are arrays, set the path to the name of the field and then append /<array index>. Using /0 appends to the beginning of the array. For example, to add a new custom role to a member, use the following request body:

  [
    {
      "op": "add",
      "path": "/customRoles/0",
      "value": "some-role-id"
    }
  ]

When SAML SSO or SCIM is enabled for the account, account members are managed in the Identity Provider (IdP). Requests to update account members will succeed, but the IdP will override the update shortly afterwards.

Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.

Add one member to one or more teams.