v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Account members

Modify an account member

Update a single account member. Updating a member uses a JSON patch representation of the desired changes. To learn more, read Updates.

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>. Use /0 to add to the beginning of the array. Use /- to add to the end 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"
    }
  ]

You can update only an account member's role or custom role using a JSON patch. Members can update their own names and email addresses though the LaunchDarkly UI.

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.

patch/api/v2/members/{id}

Path parameters

idstring string required

The member ID

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Member response

_linksobject required

The location and content type of related resources

_idstring required

The member's ID

firstNamestring

The member's first name

lastNamestring

The member's last name

rolestring required

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

emailstring required

The member's email address

_pendingInviteboolean required

Whether the member has a pending invitation

_verifiedboolean required

Whether the member's email address has been verified

_pendingEmailstring

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

customRolesstring[] required

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

mfastring required

Whether multi-factor authentication is enabled for this member

excludedDashboardsstring[]

Default dashboards that the member has chosen to ignore

_lastSeeninteger required

creationDateinteger required

oauthProvidersOAuthProviderKind[]

A list of OAuth providers

versioninteger

Version of the current configuration

roleAttributesRoleAttributeMap

Example response

{
  "_id": "507f1f77bcf86cd799439011",
  "firstName": "Ariel",
  "lastName": "Flores",
  "role": "reader",
  "email": "ariel@acme.com",
  "_verified": true,
  "customRoles": [
    "devOps",
    "backend-devs"
  ],
  "_lastSeenMetadata": {
    "tokenId": "5b52207f8ca8e631d31fdb2b"
  },
  "teams": [
    {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team"
    }
  ],
  "permissionGrants": [
    {
      "actions": [
        "maintainTeam"
      ],
      "resource": "team/qa-team"
    }
  ],
  "version": 1
}