Modify an account member

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

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}

Modify an account member

cURL

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/members/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "add",
    "path": "/role",
    "value": "writer"
  }
]
'

200

{
  "_links": {},
  "_id": "507f1f77bcf86cd799439011",
  "role": "reader",
  "email": "[e-mail]",
  "_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": {}
}

Authorizations

Authorization · string · header · required

Path Parameters

id · string<string> · required

The member ID

Body

application/json

op · string · required

The type of operation to perform

Example:

"replace"

path · string · required

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

Example:

"/exampleField"

value · any

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

Example:

"new example value"

Response

200

application/json

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"

email · string · required

The member's email address

Example:

"[e-mail]"

_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