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
**not_resources** | **[str]** | Targeted resources are the resources NOT in this list. The \"resources\" and \"notActions\" fields must be empty to use this field. | [optional]
9
+
**not_resources** | **[str]** | Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field. | [optional]
10
10
**actions** | **[str]** | Actions to perform on a resource | [optional]
11
-
**not_actions** | **[str]** | Targeted actions are the actions NOT in this list. The \"actions\" and \"notResources\" fields must be empty to use this field. | [optional]
11
+
**not_actions** | **[str]** | Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field. | [optional]
12
12
**role_name** | **str** | | [optional]
13
13
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
**not_resources** | **[str]** | Targeted resources are the resources NOT in this list. The \"resources\" and \"notActions\" fields must be empty to use this field. | [optional]
9
+
**not_resources** | **[str]** | Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field. | [optional]
10
10
**actions** | **[str]** | Actions to perform on a resource | [optional]
11
-
**not_actions** | **[str]** | Targeted actions are the actions NOT in this list. The \"actions\" and \"notResources\" fields must be empty to use this field. | [optional]
11
+
**not_actions** | **[str]** | Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field. | [optional]
12
12
**role_name** | **str** | | [optional]
13
13
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
Copy file name to clipboardExpand all lines: docs/AccountMembersApi.md
+10-9
Original file line number
Diff line number
Diff line change
@@ -103,7 +103,7 @@ void (empty response body)
103
103
104
104
Get account member
105
105
106
-
Get a single account member by member ID. `me` is a reserved value for the `id` parameter and returns the caller's member information.
106
+
Get a single account member by member ID. `me` is a reserved value for the `id` parameter that returns the caller's member information.
107
107
108
108
### Example
109
109
@@ -176,7 +176,7 @@ Name | Type | Description | Notes
176
176
177
177
| Status code | Description | Response headers |
178
178
|-------------|-------------|------------------|
179
-
**200** | Member response JSON | - |
179
+
**200** | Member response | - |
180
180
**401** | Invalid access token | - |
181
181
**403** | Forbidden | - |
182
182
**404** | Invalid resource identifier | - |
@@ -189,7 +189,7 @@ Name | Type | Description | Notes
189
189
190
190
List account members
191
191
192
-
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 three fields for filters: `query`, `role`, and `lastSeen`: - `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. - `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. 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 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.
192
+
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.
193
193
194
194
### Example
195
195
@@ -269,7 +269,7 @@ Name | Type | Description | Notes
269
269
270
270
| Status code | Description | Response headers |
271
271
|-------------|-------------|------------------|
272
-
**200** | Member collection response JSON | - |
272
+
**200** | Members collection response | - |
273
273
**401** | Invalid access token | - |
274
274
**403** | Forbidden | - |
275
275
**404** | Invalid resource identifier | - |
@@ -282,7 +282,7 @@ Name | Type | Description | Notes
282
282
283
283
Modify an account member
284
284
285
-
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\" } ] ``` Requests to update account members will not work if SCIM is enabled for the account.
285
+
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.
286
286
287
287
### Example
288
288
@@ -366,7 +366,7 @@ Name | Type | Description | Notes
366
366
367
367
| Status code | Description | Response headers |
368
368
|-------------|-------------|------------------|
369
-
**200** | Member response JSON | - |
369
+
**200** | Member response | - |
370
370
**400** | Invalid request | - |
371
371
**401** | Invalid access token | - |
372
372
**403** | Forbidden | - |
@@ -460,7 +460,7 @@ Name | Type | Description | Notes
460
460
461
461
| Status code | Description | Response headers |
462
462
|-------------|-------------|------------------|
463
-
**201** | Member response JSON | - |
463
+
**201** | Member response | - |
464
464
**400** | Invalid request | - |
465
465
**401** | Invalid access token | - |
466
466
**403** | Forbidden | - |
@@ -474,7 +474,7 @@ Name | Type | Description | Notes
474
474
475
475
Invite new members
476
476
477
-
> ### Full use of this API resource is only available to customers on an Enterprise plan > > The ability to bulk invite members is an Enterprise feature. On a starter or Pro plan? You can invite members individually. 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_email**s: 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).
477
+
> ### 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](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/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_email**s: 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).
478
478
479
479
### Example
480
480
@@ -521,6 +521,7 @@ with launchdarkly_api.ApiClient(configuration) as api_client:
521
521
last_name="Smith",
522
522
role="reader",
523
523
custom_roles=["customRole1","customRole2"],
524
+
team_keys=["team-1","team-2"],
524
525
),
525
526
]) # NewMemberFormListPost |
526
527
@@ -558,7 +559,7 @@ Name | Type | Description | Notes
0 commit comments