Package com.launchdarkly.api.api

Class AccountMembersApi

  • public class AccountMembersApi
extends java.lang.Object

    • Constructor Detail

      • AccountMembersApi

        public AccountMembersApi()

      • AccountMembersApi

        public AccountMembersApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)

      • deleteMemberCall

        public okhttp3.Call deleteMemberCall​(@Nonnull
                                     java.lang.String id,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for deleteMember
        Parameters:
        id - The member ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteMember

        public void deleteMember​(@Nonnull
                         java.lang.String id)
                  throws ApiException
        Delete account member Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteMemberWithHttpInfo

        public ApiResponse<java.lang.Void> deleteMemberWithHttpInfo​(@Nonnull
                                                            java.lang.String id)
                                                     throws ApiException
        Delete account member Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteMemberAsync

        public okhttp3.Call deleteMemberAsync​(@Nonnull
                                      java.lang.String id,
                                      ApiCallback<java.lang.Void> _callback)
                               throws ApiException
        Delete account member (asynchronously) Delete a single account member by ID. Requests to delete account members will not work if SCIM is enabled for the account.
        Parameters:
        id - The member ID (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getMemberCall

        public okhttp3.Call getMemberCall​(@Nonnull
                                  java.lang.String id,
                                  @Nullable
                                  java.lang.String expand,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for getMember
        Parameters:
        id - The member ID (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getMember

        public Member getMember​(@Nonnull
                        java.lang.String id,
                        @Nullable
                        java.lang.String expand)
                 throws ApiException
        Get account member 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 one field for expanding the \"Get member\" response. By default, this field is **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: * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response.
        Parameters:
        id - The member ID (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        Member
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMemberWithHttpInfo

        public ApiResponse<Member> getMemberWithHttpInfo​(@Nonnull
                                                 java.lang.String id,
                                                 @Nullable
                                                 java.lang.String expand)
                                          throws ApiException
        Get account member 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 one field for expanding the \"Get member\" response. By default, this field is **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: * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response.
        Parameters:
        id - The member ID (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        ApiResponse<Member>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMemberAsync

        public okhttp3.Call getMemberAsync​(@Nonnull
                                   java.lang.String id,
                                   @Nullable
                                   java.lang.String expand,
                                   ApiCallback<Member> _callback)
                            throws ApiException
        Get account member (asynchronously) 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 one field for expanding the \"Get member\" response. By default, this field is **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: * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response.
        Parameters:
        id - The member ID (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getMembersCall

        public okhttp3.Call getMembersCall​(@Nullable
                                   java.lang.Long limit,
                                   @Nullable
                                   java.lang.Long offset,
                                   @Nullable
                                   java.lang.String filter,
                                   @Nullable
                                   java.lang.String expand,
                                   @Nullable
                                   java.lang.String sort,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for getMembers
        Parameters:
        limit - The number of members to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
        filter - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getMembers

        public Members getMembers​(@Nullable
                          java.lang.Long limit,
                          @Nullable
                          java.lang.Long offset,
                          @Nullable
                          java.lang.String filter,
                          @Nullable
                          java.lang.String expand,
                          @Nullable
                          java.lang.String sort)
                   throws ApiException
        List account members 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`. - `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list. - `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list. - `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. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://launchdarkly.com/docs/api#versioning). - 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. ### Expanding the members response LaunchDarkly supports two fields for expanding the \"List members\" 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 a list of the roles that you have assigned to the member. * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response.
        Parameters:
        limit - The number of members to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
        filter - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        Returns:
        Members
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMembersWithHttpInfo

        public ApiResponse<Members> getMembersWithHttpInfo​(@Nullable
                                                   java.lang.Long limit,
                                                   @Nullable
                                                   java.lang.Long offset,
                                                   @Nullable
                                                   java.lang.String filter,
                                                   @Nullable
                                                   java.lang.String expand,
                                                   @Nullable
                                                   java.lang.String sort)
                                            throws ApiException
        List account members 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`. - `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list. - `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list. - `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. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://launchdarkly.com/docs/api#versioning). - 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. ### Expanding the members response LaunchDarkly supports two fields for expanding the \"List members\" 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 a list of the roles that you have assigned to the member. * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response.
        Parameters:
        limit - The number of members to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
        filter - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        Returns:
        ApiResponse<Members>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMembersAsync

        public okhttp3.Call getMembersAsync​(@Nullable
                                    java.lang.Long limit,
                                    @Nullable
                                    java.lang.Long offset,
                                    @Nullable
                                    java.lang.String filter,
                                    @Nullable
                                    java.lang.String expand,
                                    @Nullable
                                    java.lang.String sort,
                                    ApiCallback<Members> _callback)
                             throws ApiException
        List account members (asynchronously) 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`. - `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list. - `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list. - `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. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://launchdarkly.com/docs/api#versioning). - 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. ### Expanding the members response LaunchDarkly supports two fields for expanding the \"List members\" 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 a list of the roles that you have assigned to the member. * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=roleAttributes` includes `roleAttributes` field in the response.
        Parameters:
        limit - The number of members to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
        filter - A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • patchMemberCall

        public okhttp3.Call patchMemberCall​(@Nonnull
                                    java.lang.String id,
                                    @Nonnull
                                    java.util.List<PatchOperation> patchOperation,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for patchMember
        Parameters:
        id - The member ID (required)
        patchOperation - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchMember

        public Member patchMember​(@Nonnull
                          java.lang.String id,
                          @Nonnull
                          java.util.List<PatchOperation> patchOperation)
                   throws ApiException
        Modify an account member Update a single account member. Updating a member uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#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.
        Parameters:
        id - The member ID (required)
        patchOperation - (required)
        Returns:
        Member
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchMemberWithHttpInfo

        public ApiResponse<Member> patchMemberWithHttpInfo​(@Nonnull
                                                   java.lang.String id,
                                                   @Nonnull
                                                   java.util.List<PatchOperation> patchOperation)
                                            throws ApiException
        Modify an account member Update a single account member. Updating a member uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#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.
        Parameters:
        id - The member ID (required)
        patchOperation - (required)
        Returns:
        ApiResponse<Member>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchMemberAsync

        public okhttp3.Call patchMemberAsync​(@Nonnull
                                     java.lang.String id,
                                     @Nonnull
                                     java.util.List<PatchOperation> patchOperation,
                                     ApiCallback<Member> _callback)
                              throws ApiException
        Modify an account member (asynchronously) Update a single account member. Updating a member uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#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.
        Parameters:
        id - The member ID (required)
        patchOperation - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • patchMembersCall

        public okhttp3.Call patchMembersCall​(@Nonnull
                                     MembersPatchInput membersPatchInput,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for patchMembers
        Parameters:
        membersPatchInput - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchMembers

        public BulkEditMembersRep patchMembers​(@Nonnull
                                       MembersPatchInput membersPatchInput)
                                throws ApiException
        Modify account members > ### Full use of this API resource is an Enterprise feature > > 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/). Perform a partial update to multiple members. Updating members uses the semantic patch format. 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). ### Instructions Semantic patch requests support the following `kind` instructions for updating members. <details> <summary>Click to expand instructions for <strong>updating members</strong></summary> #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `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). - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoles\", \"value\": \"reader\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `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). - `filterLastSeen`: (Optional) A JSON object with 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. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersRoles\", \"value\": \"reader\", \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with 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. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` </details>
        Parameters:
        membersPatchInput - (required)
        Returns:
        BulkEditMembersRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchMembersWithHttpInfo

        public ApiResponse<BulkEditMembersRep> patchMembersWithHttpInfo​(@Nonnull
                                                                MembersPatchInput membersPatchInput)
                                                         throws ApiException
        Modify account members > ### Full use of this API resource is an Enterprise feature > > 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/). Perform a partial update to multiple members. Updating members uses the semantic patch format. 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). ### Instructions Semantic patch requests support the following `kind` instructions for updating members. <details> <summary>Click to expand instructions for <strong>updating members</strong></summary> #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `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). - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoles\", \"value\": \"reader\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `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). - `filterLastSeen`: (Optional) A JSON object with 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. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersRoles\", \"value\": \"reader\", \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with 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. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` </details>
        Parameters:
        membersPatchInput - (required)
        Returns:
        ApiResponse<BulkEditMembersRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchMembersAsync

        public okhttp3.Call patchMembersAsync​(@Nonnull
                                      MembersPatchInput membersPatchInput,
                                      ApiCallback<BulkEditMembersRep> _callback)
                               throws ApiException
        Modify account members (asynchronously) > ### Full use of this API resource is an Enterprise feature > > 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/). Perform a partial update to multiple members. Updating members uses the semantic patch format. 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). ### Instructions Semantic patch requests support the following `kind` instructions for updating members. <details> <summary>Click to expand instructions for <strong>updating members</strong></summary> #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `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). - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoles\", \"value\": \"reader\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `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). - `filterLastSeen`: (Optional) A JSON object with 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. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersRoles\", \"value\": \"reader\", \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with 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. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` </details>
        Parameters:
        membersPatchInput - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • postMemberTeamsCall

        public okhttp3.Call postMemberTeamsCall​(@Nonnull
                                        java.lang.String id,
                                        @Nonnull
                                        MemberTeamsPostInput memberTeamsPostInput,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for postMemberTeams
        Parameters:
        id - The member ID (required)
        memberTeamsPostInput - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postMemberTeams

        public Member postMemberTeams​(@Nonnull
                              java.lang.String id,
                              @Nonnull
                              MemberTeamsPostInput memberTeamsPostInput)
                       throws ApiException
        Add a member to teams Add one member to one or more teams.
        Parameters:
        id - The member ID (required)
        memberTeamsPostInput - (required)
        Returns:
        Member
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postMemberTeamsWithHttpInfo

        public ApiResponse<Member> postMemberTeamsWithHttpInfo​(@Nonnull
                                                       java.lang.String id,
                                                       @Nonnull
                                                       MemberTeamsPostInput memberTeamsPostInput)
                                                throws ApiException
        Add a member to teams Add one member to one or more teams.
        Parameters:
        id - The member ID (required)
        memberTeamsPostInput - (required)
        Returns:
        ApiResponse<Member>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postMemberTeamsAsync

        public okhttp3.Call postMemberTeamsAsync​(@Nonnull
                                         java.lang.String id,
                                         @Nonnull
                                         MemberTeamsPostInput memberTeamsPostInput,
                                         ApiCallback<Member> _callback)
                                  throws ApiException
        Add a member to teams (asynchronously) Add one member to one or more teams.
        Parameters:
        id - The member ID (required)
        memberTeamsPostInput - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • postMembersCall

        public okhttp3.Call postMembersCall​(@Nonnull
                                    java.util.List<NewMemberForm> newMemberForm,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for postMembers
        Parameters:
        newMemberForm - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postMembers

        public Members postMembers​(@Nonnull
                           java.util.List<NewMemberForm> newMemberForm)
                    throws ApiException
        Invite new members 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. Valid base role names that you can provide for the `role` field include `reader`, `writer`, `admin`, `owner/admin`, and `no_access`. To learn more about base roles, read [Organization roles](https://launchdarkly.com/docs/home/account/roles/organization-roles). If you are using the `customRoles` field instead, you can provide the key for any role that you have created, or for any preset [organization role](https://launchdarkly.com/docs/home/account/roles/organization-roles) or [project role](https://launchdarkly.com/docs/home/account/roles/project-roles) provided by LaunchDarkly. Some preset roles additionally require that you specify `roleAttributes`. To learn more, read [Using role scope](https://launchdarkly.com/docs/home/account/roles/role-scope). 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).
        Parameters:
        newMemberForm - (required)
        Returns:
        Members
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postMembersWithHttpInfo

        public ApiResponse<Members> postMembersWithHttpInfo​(@Nonnull
                                                    java.util.List<NewMemberForm> newMemberForm)
                                             throws ApiException
        Invite new members 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. Valid base role names that you can provide for the `role` field include `reader`, `writer`, `admin`, `owner/admin`, and `no_access`. To learn more about base roles, read [Organization roles](https://launchdarkly.com/docs/home/account/roles/organization-roles). If you are using the `customRoles` field instead, you can provide the key for any role that you have created, or for any preset [organization role](https://launchdarkly.com/docs/home/account/roles/organization-roles) or [project role](https://launchdarkly.com/docs/home/account/roles/project-roles) provided by LaunchDarkly. Some preset roles additionally require that you specify `roleAttributes`. To learn more, read [Using role scope](https://launchdarkly.com/docs/home/account/roles/role-scope). 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).
        Parameters:
        newMemberForm - (required)
        Returns:
        ApiResponse<Members>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postMembersAsync

        public okhttp3.Call postMembersAsync​(@Nonnull
                                     java.util.List<NewMemberForm> newMemberForm,
                                     ApiCallback<Members> _callback)
                              throws ApiException
        Invite new members (asynchronously) 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. Valid base role names that you can provide for the `role` field include `reader`, `writer`, `admin`, `owner/admin`, and `no_access`. To learn more about base roles, read [Organization roles](https://launchdarkly.com/docs/home/account/roles/organization-roles). If you are using the `customRoles` field instead, you can provide the key for any role that you have created, or for any preset [organization role](https://launchdarkly.com/docs/home/account/roles/organization-roles) or [project role](https://launchdarkly.com/docs/home/account/roles/project-roles) provided by LaunchDarkly. Some preset roles additionally require that you specify `roleAttributes`. To learn more, read [Using role scope](https://launchdarkly.com/docs/home/account/roles/role-scope). 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).
        Parameters:
        newMemberForm - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object