Package com.launchdarkly.api.api

Class TeamsApi

  • public class TeamsApi
extends java.lang.Object

    • Constructor Detail

      • TeamsApi

        public TeamsApi()

      • TeamsApi

        public TeamsApi​(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)

      • deleteTeamCall

        public okhttp3.Call deleteTeamCall​(java.lang.String teamKey,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for deleteTeam
        Parameters:
        teamKey - The team key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteTeam

        public void deleteTeam​(java.lang.String teamKey)
                throws ApiException
        Delete team Delete a team by key. To learn more, read [Deleting a team](https://docs.launchdarkly.com/home/teams/managing#deleting-a-team).
        Parameters:
        teamKey - The team key (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteTeamWithHttpInfo

        public ApiResponse<java.lang.Void> deleteTeamWithHttpInfo​(java.lang.String teamKey)
                                                   throws ApiException
        Delete team Delete a team by key. To learn more, read [Deleting a team](https://docs.launchdarkly.com/home/teams/managing#deleting-a-team).
        Parameters:
        teamKey - The team key (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteTeamAsync

        public okhttp3.Call deleteTeamAsync​(java.lang.String teamKey,
                                    ApiCallback<java.lang.Void> _callback)
                             throws ApiException
        Delete team (asynchronously) Delete a team by key. To learn more, read [Deleting a team](https://docs.launchdarkly.com/home/teams/managing#deleting-a-team).
        Parameters:
        teamKey - The team key (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

      • getTeamCall

        public okhttp3.Call getTeamCall​(java.lang.String teamKey,
                                java.lang.String expand,
                                ApiCallback _callback)
                         throws ApiException
        Build call for getTeam
        Parameters:
        teamKey - The team key. (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

      • getTeam

        public Team getTeam​(java.lang.String teamKey,
                    java.lang.String expand)
             throws ApiException
        Get team Fetch a team by key. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Get team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamKey - The team key. (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        Team
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTeamWithHttpInfo

        public ApiResponse<Team> getTeamWithHttpInfo​(java.lang.String teamKey,
                                             java.lang.String expand)
                                      throws ApiException
        Get team Fetch a team by key. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Get team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamKey - The team key. (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        ApiResponse<Team>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTeamAsync

        public okhttp3.Call getTeamAsync​(java.lang.String teamKey,
                                 java.lang.String expand,
                                 ApiCallback<Team> _callback)
                          throws ApiException
        Get team (asynchronously) Fetch a team by key. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Get team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamKey - The team key. (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

      • getTeamMaintainersCall

        public okhttp3.Call getTeamMaintainersCall​(java.lang.String teamKey,
                                           java.lang.Long limit,
                                           java.lang.Long offset,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for getTeamMaintainers
        Parameters:
        teamKey - The team key (required)
        limit - The number of maintainers 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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getTeamMaintainers

        public TeamMaintainers getTeamMaintainers​(java.lang.String teamKey,
                                          java.lang.Long limit,
                                          java.lang.Long offset)
                                   throws ApiException
        Get team maintainers Fetch the maintainers that have been assigned to the team. To learn more, read [Managing team maintainers](https://docs.launchdarkly.com/home/teams/managing#managing-team-maintainers).
        Parameters:
        teamKey - The team key (required)
        limit - The number of maintainers 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)
        Returns:
        TeamMaintainers
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTeamMaintainersWithHttpInfo

        public ApiResponse<TeamMaintainers> getTeamMaintainersWithHttpInfo​(java.lang.String teamKey,
                                                                   java.lang.Long limit,
                                                                   java.lang.Long offset)
                                                            throws ApiException
        Get team maintainers Fetch the maintainers that have been assigned to the team. To learn more, read [Managing team maintainers](https://docs.launchdarkly.com/home/teams/managing#managing-team-maintainers).
        Parameters:
        teamKey - The team key (required)
        limit - The number of maintainers 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)
        Returns:
        ApiResponse<TeamMaintainers>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTeamMaintainersAsync

        public okhttp3.Call getTeamMaintainersAsync​(java.lang.String teamKey,
                                            java.lang.Long limit,
                                            java.lang.Long offset,
                                            ApiCallback<TeamMaintainers> _callback)
                                     throws ApiException
        Get team maintainers (asynchronously) Fetch the maintainers that have been assigned to the team. To learn more, read [Managing team maintainers](https://docs.launchdarkly.com/home/teams/managing#managing-team-maintainers).
        Parameters:
        teamKey - The team key (required)
        limit - The number of maintainers 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)
        _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

      • getTeamRolesCall

        public okhttp3.Call getTeamRolesCall​(java.lang.String teamKey,
                                     java.lang.Long limit,
                                     java.lang.Long offset,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for getTeamRoles
        Parameters:
        teamKey - The team key (required)
        limit - The number of roles 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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getTeamRoles

        public TeamCustomRoles getTeamRoles​(java.lang.String teamKey,
                                    java.lang.Long limit,
                                    java.lang.Long offset)
                             throws ApiException
        Get team custom roles Fetch the custom roles that have been assigned to the team. To learn more, read [Managing team permissions](https://docs.launchdarkly.com/home/teams/managing#managing-team-permissions).
        Parameters:
        teamKey - The team key (required)
        limit - The number of roles 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)
        Returns:
        TeamCustomRoles
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTeamRolesWithHttpInfo

        public ApiResponse<TeamCustomRoles> getTeamRolesWithHttpInfo​(java.lang.String teamKey,
                                                             java.lang.Long limit,
                                                             java.lang.Long offset)
                                                      throws ApiException
        Get team custom roles Fetch the custom roles that have been assigned to the team. To learn more, read [Managing team permissions](https://docs.launchdarkly.com/home/teams/managing#managing-team-permissions).
        Parameters:
        teamKey - The team key (required)
        limit - The number of roles 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)
        Returns:
        ApiResponse<TeamCustomRoles>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTeamRolesAsync

        public okhttp3.Call getTeamRolesAsync​(java.lang.String teamKey,
                                      java.lang.Long limit,
                                      java.lang.Long offset,
                                      ApiCallback<TeamCustomRoles> _callback)
                               throws ApiException
        Get team custom roles (asynchronously) Fetch the custom roles that have been assigned to the team. To learn more, read [Managing team permissions](https://docs.launchdarkly.com/home/teams/managing#managing-team-permissions).
        Parameters:
        teamKey - The team key (required)
        limit - The number of roles 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)
        _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

      • getTeamsCall

        public okhttp3.Call getTeamsCall​(java.lang.Long limit,
                                 java.lang.Long offset,
                                 java.lang.String filter,
                                 java.lang.String expand,
                                 ApiCallback _callback)
                          throws ApiException
        Build call for getTeams
        Parameters:
        limit - The number of teams to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is constructed as `field:value`. (optional)
        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

      • getTeams

        public Teams getTeams​(java.lang.Long limit,
                      java.lang.Long offset,
                      java.lang.String filter,
                      java.lang.String expand)
               throws ApiException
        List teams Return a list of teams. By default, this returns the first 20 teams. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, 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, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering teams LaunchDarkly supports the `query` field for filtering. `query` is a string that matches against the teams' names and keys. For example, the filter `query:abc` matches teams with the string `abc` in their name or key. The filter is not case-sensitive. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"List teams\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        limit - The number of teams to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is constructed as `field:value`. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        Teams
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTeamsWithHttpInfo

        public ApiResponse<Teams> getTeamsWithHttpInfo​(java.lang.Long limit,
                                               java.lang.Long offset,
                                               java.lang.String filter,
                                               java.lang.String expand)
                                        throws ApiException
        List teams Return a list of teams. By default, this returns the first 20 teams. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, 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, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering teams LaunchDarkly supports the `query` field for filtering. `query` is a string that matches against the teams' names and keys. For example, the filter `query:abc` matches teams with the string `abc` in their name or key. The filter is not case-sensitive. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"List teams\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        limit - The number of teams to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is constructed as `field:value`. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        ApiResponse<Teams>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTeamsAsync

        public okhttp3.Call getTeamsAsync​(java.lang.Long limit,
                                  java.lang.Long offset,
                                  java.lang.String filter,
                                  java.lang.String expand,
                                  ApiCallback<Teams> _callback)
                           throws ApiException
        List teams (asynchronously) Return a list of teams. By default, this returns the first 20 teams. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, 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, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering teams LaunchDarkly supports the `query` field for filtering. `query` is a string that matches against the teams' names and keys. For example, the filter `query:abc` matches teams with the string `abc` in their name or key. The filter is not case-sensitive. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"List teams\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        limit - The number of teams to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is constructed as `field:value`. (optional)
        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

      • patchTeamCall

        public okhttp3.Call patchTeamCall​(java.lang.String teamKey,
                                  TeamPatchInput teamPatchInput,
                                  java.lang.String expand,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for patchTeam
        Parameters:
        teamKey - The team key (required)
        teamPatchInput - (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchTeam

        public Team patchTeam​(java.lang.String teamKey,
                      TeamPatchInput teamPatchInput,
                      java.lang.String expand)
               throws ApiException
        Update team Perform a partial update to a team. Updating a team 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](/reference#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams. #### addCustomRoles Adds custom roles to the team. Team members will have these custom roles granted to them. ##### Parameters - `values`: List of custom role keys. #### removeCustomRoles Removes custom roles from the team. The app will no longer grant these custom roles to the team members. ##### Parameters - `values`: List of custom role keys. #### addMembers Adds members to the team. ##### Parameters - `values`: List of member IDs. #### removeMembers Removes members from the team. ##### Parameters - `values`: List of member IDs. #### addPermissionGrants Adds permission grants to members for the team. For example, a permission grant could allow a member to act as a team maintainer. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The members do not have to be team members to have a permission grant for the team. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. #### removePermissionGrants Removes permission grants from members for the team. The `actionSet` and `actions` must match an existing permission grant. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. #### updateDescription Updates the description of the team. ##### Parameters - `value`: The new description. #### updateName Updates the name of the team. ##### Parameters - `value`: The new name. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Update team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamKey - The team key (required)
        teamPatchInput - (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        Returns:
        Team
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchTeamWithHttpInfo

        public ApiResponse<Team> patchTeamWithHttpInfo​(java.lang.String teamKey,
                                               TeamPatchInput teamPatchInput,
                                               java.lang.String expand)
                                        throws ApiException
        Update team Perform a partial update to a team. Updating a team 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](/reference#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams. #### addCustomRoles Adds custom roles to the team. Team members will have these custom roles granted to them. ##### Parameters - `values`: List of custom role keys. #### removeCustomRoles Removes custom roles from the team. The app will no longer grant these custom roles to the team members. ##### Parameters - `values`: List of custom role keys. #### addMembers Adds members to the team. ##### Parameters - `values`: List of member IDs. #### removeMembers Removes members from the team. ##### Parameters - `values`: List of member IDs. #### addPermissionGrants Adds permission grants to members for the team. For example, a permission grant could allow a member to act as a team maintainer. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The members do not have to be team members to have a permission grant for the team. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. #### removePermissionGrants Removes permission grants from members for the team. The `actionSet` and `actions` must match an existing permission grant. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. #### updateDescription Updates the description of the team. ##### Parameters - `value`: The new description. #### updateName Updates the name of the team. ##### Parameters - `value`: The new name. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Update team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamKey - The team key (required)
        teamPatchInput - (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        Returns:
        ApiResponse<Team>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchTeamAsync

        public okhttp3.Call patchTeamAsync​(java.lang.String teamKey,
                                   TeamPatchInput teamPatchInput,
                                   java.lang.String expand,
                                   ApiCallback<Team> _callback)
                            throws ApiException
        Update team (asynchronously) Perform a partial update to a team. Updating a team 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](/reference#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating teams. #### addCustomRoles Adds custom roles to the team. Team members will have these custom roles granted to them. ##### Parameters - `values`: List of custom role keys. #### removeCustomRoles Removes custom roles from the team. The app will no longer grant these custom roles to the team members. ##### Parameters - `values`: List of custom role keys. #### addMembers Adds members to the team. ##### Parameters - `values`: List of member IDs. #### removeMembers Removes members from the team. ##### Parameters - `values`: List of member IDs. #### addPermissionGrants Adds permission grants to members for the team. For example, a permission grant could allow a member to act as a team maintainer. A permission grant may have either an `actionSet` or a list of `actions` but not both at the same time. The members do not have to be team members to have a permission grant for the team. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. #### removePermissionGrants Removes permission grants from members for the team. The `actionSet` and `actions` must match an existing permission grant. ##### Parameters - `actionSet`: Name of the action set. - `actions`: List of actions. - `memberIDs`: List of member IDs. #### updateDescription Updates the description of the team. ##### Parameters - `value`: The new description. #### updateName Updates the name of the team. ##### Parameters - `value`: The new name. ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Update team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamKey - The team key (required)
        teamPatchInput - (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (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

      • postTeamCall

        public okhttp3.Call postTeamCall​(TeamPostInput teamPostInput,
                                 java.lang.String expand,
                                 ApiCallback _callback)
                          throws ApiException
        Build call for postTeam
        Parameters:
        teamPostInput - (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postTeam

        public Team postTeam​(TeamPostInput teamPostInput,
                     java.lang.String expand)
              throws ApiException
        Create team Create a team. To learn more, read [Creating a team](https://docs.launchdarkly.com/home/teams/creating). ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Create team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamPostInput - (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        Returns:
        Team
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postTeamWithHttpInfo

        public ApiResponse<Team> postTeamWithHttpInfo​(TeamPostInput teamPostInput,
                                              java.lang.String expand)
                                       throws ApiException
        Create team Create a team. To learn more, read [Creating a team](https://docs.launchdarkly.com/home/teams/creating). ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Create team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamPostInput - (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (optional)
        Returns:
        ApiResponse<Team>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postTeamAsync

        public okhttp3.Call postTeamAsync​(TeamPostInput teamPostInput,
                                  java.lang.String expand,
                                  ApiCallback<Team> _callback)
                           throws ApiException
        Create team (asynchronously) Create a team. To learn more, read [Creating a team](https://docs.launchdarkly.com/home/teams/creating). ### Expanding the teams response LaunchDarkly supports four fields for expanding the \"Create team\" 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: * `members` includes the total count of members that belong to the team. * `roles` includes a paginated list of the custom roles that you have assigned to the team. * `projects` includes a paginated list of the projects that the team has any write access to. * `maintainers` includes a paginated list of the maintainers that you have assigned to the team. For example, `expand=members,roles` includes the `members` and `roles` fields in the response.
        Parameters:
        teamPostInput - (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. (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

      • postTeamMembersCall

        public okhttp3.Call postTeamMembersCall​(java.lang.String teamKey,
                                        java.io.File _file,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for postTeamMembers
        Parameters:
        teamKey - The team key (required)
        _file - CSV file containing email addresses (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postTeamMembers

        public TeamImportsRep postTeamMembers​(java.lang.String teamKey,
                                      java.io.File _file)
                               throws ApiException
        Add multiple members to team Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column. Headers are optional. To learn more, read [Managing team members](https://docs.launchdarkly.com/home/teams/managing#managing-team-members). **Members are only added on a `201` response.** A `207` indicates the CSV file contains a combination of valid and invalid entries. A `207` results in no members being added to the team. On a `207` response, if an entry contains bad user input, the `message` field contains the row number as well as the reason for the error. The `message` field is omitted if the entry is valid. Example `207` response: ```json { \"items\": [ { \"status\": \"success\", \"value\": \"[email protected]\" }, { \"message\": \"Line 2: empty row\", \"status\": \"error\", \"value\": \"\" }, { \"message\": \"Line 3: email already exists in the specified team\", \"status\": \"error\", \"value\": \"[email protected]\" }, { \"message\": \"Line 4: invalid email formatting\", \"status\": \"error\", \"value\": \"invalid email format\" } ] } ``` Message | Resolution --- | --- Empty row | This line is blank. Add an email address and try again. Duplicate entry | This email address appears in the file twice. Remove the email from the file and try again. Email already exists in the specified team | This member is already on your team. Remove the email from the file and try again. Invalid formatting | This email address is not formatted correctly. Fix the formatting and try again. Email does not belong to a LaunchDarkly member | The email address doesn't belong to a LaunchDarkly account member. Invite them to LaunchDarkly, then re-add them to the team. On a `400` response, the `message` field may contain errors specific to this endpoint. Example `400` response: ```json { \"code\": \"invalid_request\", \"message\": \"Unable to process file\" } ``` Message | Resolution --- | --- Unable to process file | LaunchDarkly could not process the file for an unspecified reason. Review your file for errors and try again. File exceeds 25mb | Break up your file into multiple files of less than 25mbs each. All emails have invalid formatting | None of the email addresses in the file are in the correct format. Fix the formatting and try again. All emails belong to existing team members | All listed members are already on this team. Populate the file with member emails that do not belong to the team and try again. File is empty | The CSV file does not contain any email addresses. Populate the file and try again. No emails belong to members of your LaunchDarkly organization | None of the email addresses belong to members of your LaunchDarkly account. Invite these members to LaunchDarkly, then re-add them to the team.
        Parameters:
        teamKey - The team key (required)
        _file - CSV file containing email addresses (optional)
        Returns:
        TeamImportsRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postTeamMembersWithHttpInfo

        public ApiResponse<TeamImportsRep> postTeamMembersWithHttpInfo​(java.lang.String teamKey,
                                                               java.io.File _file)
                                                        throws ApiException
        Add multiple members to team Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column. Headers are optional. To learn more, read [Managing team members](https://docs.launchdarkly.com/home/teams/managing#managing-team-members). **Members are only added on a `201` response.** A `207` indicates the CSV file contains a combination of valid and invalid entries. A `207` results in no members being added to the team. On a `207` response, if an entry contains bad user input, the `message` field contains the row number as well as the reason for the error. The `message` field is omitted if the entry is valid. Example `207` response: ```json { \"items\": [ { \"status\": \"success\", \"value\": \"[email protected]\" }, { \"message\": \"Line 2: empty row\", \"status\": \"error\", \"value\": \"\" }, { \"message\": \"Line 3: email already exists in the specified team\", \"status\": \"error\", \"value\": \"[email protected]\" }, { \"message\": \"Line 4: invalid email formatting\", \"status\": \"error\", \"value\": \"invalid email format\" } ] } ``` Message | Resolution --- | --- Empty row | This line is blank. Add an email address and try again. Duplicate entry | This email address appears in the file twice. Remove the email from the file and try again. Email already exists in the specified team | This member is already on your team. Remove the email from the file and try again. Invalid formatting | This email address is not formatted correctly. Fix the formatting and try again. Email does not belong to a LaunchDarkly member | The email address doesn't belong to a LaunchDarkly account member. Invite them to LaunchDarkly, then re-add them to the team. On a `400` response, the `message` field may contain errors specific to this endpoint. Example `400` response: ```json { \"code\": \"invalid_request\", \"message\": \"Unable to process file\" } ``` Message | Resolution --- | --- Unable to process file | LaunchDarkly could not process the file for an unspecified reason. Review your file for errors and try again. File exceeds 25mb | Break up your file into multiple files of less than 25mbs each. All emails have invalid formatting | None of the email addresses in the file are in the correct format. Fix the formatting and try again. All emails belong to existing team members | All listed members are already on this team. Populate the file with member emails that do not belong to the team and try again. File is empty | The CSV file does not contain any email addresses. Populate the file and try again. No emails belong to members of your LaunchDarkly organization | None of the email addresses belong to members of your LaunchDarkly account. Invite these members to LaunchDarkly, then re-add them to the team.
        Parameters:
        teamKey - The team key (required)
        _file - CSV file containing email addresses (optional)
        Returns:
        ApiResponse<TeamImportsRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postTeamMembersAsync

        public okhttp3.Call postTeamMembersAsync​(java.lang.String teamKey,
                                         java.io.File _file,
                                         ApiCallback<TeamImportsRep> _callback)
                                  throws ApiException
        Add multiple members to team (asynchronously) Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column. Headers are optional. To learn more, read [Managing team members](https://docs.launchdarkly.com/home/teams/managing#managing-team-members). **Members are only added on a `201` response.** A `207` indicates the CSV file contains a combination of valid and invalid entries. A `207` results in no members being added to the team. On a `207` response, if an entry contains bad user input, the `message` field contains the row number as well as the reason for the error. The `message` field is omitted if the entry is valid. Example `207` response: ```json { \"items\": [ { \"status\": \"success\", \"value\": \"[email protected]\" }, { \"message\": \"Line 2: empty row\", \"status\": \"error\", \"value\": \"\" }, { \"message\": \"Line 3: email already exists in the specified team\", \"status\": \"error\", \"value\": \"[email protected]\" }, { \"message\": \"Line 4: invalid email formatting\", \"status\": \"error\", \"value\": \"invalid email format\" } ] } ``` Message | Resolution --- | --- Empty row | This line is blank. Add an email address and try again. Duplicate entry | This email address appears in the file twice. Remove the email from the file and try again. Email already exists in the specified team | This member is already on your team. Remove the email from the file and try again. Invalid formatting | This email address is not formatted correctly. Fix the formatting and try again. Email does not belong to a LaunchDarkly member | The email address doesn't belong to a LaunchDarkly account member. Invite them to LaunchDarkly, then re-add them to the team. On a `400` response, the `message` field may contain errors specific to this endpoint. Example `400` response: ```json { \"code\": \"invalid_request\", \"message\": \"Unable to process file\" } ``` Message | Resolution --- | --- Unable to process file | LaunchDarkly could not process the file for an unspecified reason. Review your file for errors and try again. File exceeds 25mb | Break up your file into multiple files of less than 25mbs each. All emails have invalid formatting | None of the email addresses in the file are in the correct format. Fix the formatting and try again. All emails belong to existing team members | All listed members are already on this team. Populate the file with member emails that do not belong to the team and try again. File is empty | The CSV file does not contain any email addresses. Populate the file and try again. No emails belong to members of your LaunchDarkly organization | None of the email addresses belong to members of your LaunchDarkly account. Invite these members to LaunchDarkly, then re-add them to the team.
        Parameters:
        teamKey - The team key (required)
        _file - CSV file containing email addresses (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