LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Account members

Modify an account member

PATCH
/api/v2/members/{id}

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.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

id*string

The member ID

Formatstring

Request Body

application/json

[index: integer]?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v2/members/string" \  -H "Content-Type: application/json" \  -d '[    {      "op": "add",      "path": "/role",      "value": "writer"    }  ]'
{  "_links": {    "property1": {      "href": "string",      "type": "string"    },    "property2": {      "href": "string",      "type": "string"    }  },  "_id": "507f1f77bcf86cd799439011",  "firstName": "Ariel",  "lastName": "Flores",  "role": "reader",  "email": "ariel@acme.com",  "_pendingInvite": false,  "_verified": true,  "_pendingEmail": "string",  "customRoles": [    "devOps",    "backend-devs"  ],  "mfa": "string",  "excludedDashboards": [    "string"  ],  "_lastSeen": "1608260796147",  "_lastSeenMetadata": {    "tokenId": "5b52207f8ca8e631d31fdb2b"  },  "_integrationMetadata": {    "externalId": "string",    "externalStatus": {      "display": "string",      "value": "string"    },    "externalUrl": "string",    "lastChecked": 0  },  "teams": [    {      "customRoleKeys": [        "access-to-test-projects"      ],      "key": "team-key-123abc",      "_links": {        "property1": {          "href": "string",          "type": "string"        },        "property2": {          "href": "string",          "type": "string"        }      },      "name": "QA Team"    }  ],  "permissionGrants": [    {      "actionSet": "string",      "actions": [        "maintainTeam"      ],      "resource": "team/qa-team"    }  ],  "creationDate": "1628001602644",  "oauthProviders": [    "string"  ],  "hasPassword": true,  "version": 1,  "roleAttributes": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "mfaEnforced": true,  "mfaGracePeriodExpiresAt": 0}

Get account member GET

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.

Delete account member DELETE

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