You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*AccountMembersApi* | [**get_member**](docs/AccountMembersApi.md#get_member) | **GET** /api/v2/members/{id} | Get account member
575
575
*AccountMembersApi* | [**get_members**](docs/AccountMembersApi.md#get_members) | **GET** /api/v2/members | List account members
576
576
*AccountMembersApi* | [**patch_member**](docs/AccountMembersApi.md#patch_member) | **PATCH** /api/v2/members/{id} | Modify an account member
577
+
*AccountMembersApi* | [**patch_members**](docs/AccountMembersApi.md#patch_members) | **PATCH** /api/v2/members | Modify account members
577
578
*AccountMembersApi* | [**post_member_teams**](docs/AccountMembersApi.md#post_member_teams) | **POST** /api/v2/members/{id}/teams | Add a member to teams
578
579
*AccountMembersApi* | [**post_members**](docs/AccountMembersApi.md#post_members) | **POST** /api/v2/members | Invite new members
579
-
*AccountMembersBetaApi* | [**patch_members**](docs/AccountMembersBetaApi.md#patch_members) | **PATCH** /api/v2/members | Modify account members
[**get_member**](AccountMembersApi.md#get_member) | **GET** /api/v2/members/{id} | Get account member
9
9
[**get_members**](AccountMembersApi.md#get_members) | **GET** /api/v2/members | List account members
10
10
[**patch_member**](AccountMembersApi.md#patch_member) | **PATCH** /api/v2/members/{id} | Modify an account member
11
+
[**patch_members**](AccountMembersApi.md#patch_members) | **PATCH** /api/v2/members | Modify account members
11
12
[**post_member_teams**](AccountMembersApi.md#post_member_teams) | **POST** /api/v2/members/{id}/teams | Add a member to teams
12
13
[**post_members**](AccountMembersApi.md#post_members) | **POST** /api/v2/members | Invite new members
13
14
@@ -427,6 +428,240 @@ Name | Type | Description | Notes
427
428
428
429
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
> ### Full use of this API resource is an Enterprise feature
437
+
>
438
+
> The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/).
439
+
440
+
Perform a partial update to multiple members. Updating members uses the semantic patch format.
441
+
442
+
To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch).
443
+
444
+
### Instructions
445
+
446
+
Semantic patch requests support the following `kind` instructions for updating members.
447
+
448
+
<details>
449
+
<summary>Click to expand instructions for <strong>updating members</strong></summary>
450
+
451
+
#### replaceMembersRoles
452
+
453
+
Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members.
454
+
455
+
##### Parameters
456
+
457
+
-`value`: The new role. Must be a valid [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/roles).
458
+
-`memberIDs`: List of member IDs.
459
+
460
+
Here's an example:
461
+
462
+
```json
463
+
{
464
+
"instructions": [{
465
+
"kind": "replaceMembersRoles",
466
+
"value": "reader",
467
+
"memberIDs": [
468
+
"1234a56b7c89d012345e678f",
469
+
"507f1f77bcf86cd799439011"
470
+
]
471
+
}]
472
+
}
473
+
```
474
+
475
+
#### replaceAllMembersRoles
476
+
477
+
Replaces the roles of all members. This also removes all custom roles assigned to the specified members.
478
+
479
+
Members that match any of the filters are **excluded** from the update.
480
+
481
+
##### Parameters
482
+
483
+
-`value`: The new role. Must be a valid [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/roles).
484
+
-`filterLastSeen`: (Optional) A JSON object with one of the following formats:
485
+
-`{"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.
486
+
-`{"noData": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps.
487
+
-`{"before": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds.
488
+
-`filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive.
489
+
-`filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`.
490
+
-`filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive.
491
+
-`ignoredMemberIDs`: (Optional) A list of member IDs.
492
+
493
+
Here's an example:
494
+
495
+
```json
496
+
{
497
+
"instructions": [{
498
+
"kind": "replaceAllMembersRoles",
499
+
"value": "reader",
500
+
"filterLastSeen": { "never": true }
501
+
}]
502
+
}
503
+
```
504
+
505
+
#### replaceMembersCustomRoles
506
+
507
+
Replaces the custom roles of the specified members.
508
+
509
+
##### Parameters
510
+
511
+
-`values`: List of new custom roles. Must be a valid custom role key or ID.
512
+
-`memberIDs`: List of member IDs.
513
+
514
+
Here's an example:
515
+
516
+
```json
517
+
{
518
+
"instructions": [{
519
+
"kind": "replaceMembersCustomRoles",
520
+
"values": [ "example-custom-role" ],
521
+
"memberIDs": [
522
+
"1234a56b7c89d012345e678f",
523
+
"507f1f77bcf86cd799439011"
524
+
]
525
+
}]
526
+
}
527
+
```
528
+
529
+
#### replaceAllMembersCustomRoles
530
+
531
+
Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update.
532
+
533
+
##### Parameters
534
+
535
+
-`values`: List of new roles. Must be a valid custom role key or ID.
536
+
-`filterLastSeen`: (Optional) A JSON object with one of the following formats:
537
+
-`{"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.
538
+
-`{"noData": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps.
539
+
-`{"before": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds.
540
+
-`filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive.
541
+
-`filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`.
542
+
-`filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive.
543
+
-`ignoredMemberIDs`: (Optional) A list of member IDs.
544
+
545
+
Here's an example:
546
+
547
+
```json
548
+
{
549
+
"instructions": [{
550
+
"kind": "replaceAllMembersCustomRoles",
551
+
"values": [ "example-custom-role" ],
552
+
"filterLastSeen": { "never": true }
553
+
}]
554
+
}
555
+
```
556
+
557
+
#### replaceMembersRoleAttributes
558
+
559
+
Replaces the role attributes of the specified members.
560
+
561
+
##### Parameters
562
+
563
+
-`value`: Map of role attribute keys to lists of values.
564
+
-`memberIDs`: List of member IDs.
565
+
566
+
Here's an example:
567
+
568
+
```json
569
+
{
570
+
"instructions": [{
571
+
"kind": "replaceMembersRoleAttributes",
572
+
"value": {
573
+
"myRoleProjectKey": ["mobile", "web"],
574
+
"myRoleEnvironmentKey": ["production"]
575
+
},
576
+
"memberIDs": [
577
+
"1234a56b7c89d012345e678f",
578
+
"507f1f77bcf86cd799439011"
579
+
]
580
+
}]
581
+
}
582
+
```
583
+
584
+
</details>
585
+
586
+
587
+
### Example
588
+
589
+
* Api Key Authentication (ApiKey):
590
+
591
+
```python
592
+
import launchdarkly_api
593
+
from launchdarkly_api.models.bulk_edit_members_rep import BulkEditMembersRep
594
+
from launchdarkly_api.models.members_patch_input import MembersPatchInput
595
+
from launchdarkly_api.rest import ApiException
596
+
from pprint import pprint
597
+
598
+
# Defining the host is optional and defaults to https://app.launchdarkly.com
599
+
# See configuration.py for a list of all supported configuration parameters.
600
+
configuration = launchdarkly_api.Configuration(
601
+
host="https://app.launchdarkly.com"
602
+
)
603
+
604
+
# The client must configure the authentication and authorization parameters
605
+
# in accordance with the API server security policy.
606
+
# Examples for each auth method are provided below, use the example that
members_patch_input = {"comment":"Optional comment about the update","instructions":[{"kind":"replaceMembersRoles","memberIDs":["1234a56b7c89d012345e678f","507f1f77bcf86cd799439011"],"value":"reader"}]} # MembersPatchInput |
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
664
+
430
665
# **post_member_teams**
431
666
> Member post_member_teams(id, member_teams_post_input)
0 commit comments