github.com/launchdarkly/api-client-go@v5.3.0+incompatible/docs/TeamMembersApi.md (about)

     1  # \TeamMembersApi
     2  
     3  All URIs are relative to *https://app.launchdarkly.com/api/v2*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteMember**](TeamMembersApi.md#DeleteMember) | **Delete** /members/{memberId} | Delete a team member by ID.
     8  [**GetMe**](TeamMembersApi.md#GetMe) | **Get** /members/me | Get the current team member associated with the token
     9  [**GetMember**](TeamMembersApi.md#GetMember) | **Get** /members/{memberId} | Get a single team member by ID.
    10  [**GetMembers**](TeamMembersApi.md#GetMembers) | **Get** /members | Returns a list of all members in the account.
    11  [**PatchMember**](TeamMembersApi.md#PatchMember) | **Patch** /members/{memberId} | Modify a team member by ID.
    12  [**PostMembers**](TeamMembersApi.md#PostMembers) | **Post** /members | Invite new members.
    13  
    14  
    15  # **DeleteMember**
    16  > DeleteMember(ctx, memberId)
    17  Delete a team member by ID.
    18  
    19  ### Required Parameters
    20  
    21  Name | Type | Description  | Notes
    22  ------------- | ------------- | ------------- | -------------
    23   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    24    **memberId** | **string**| The member ID. | 
    25  
    26  ### Return type
    27  
    28   (empty response body)
    29  
    30  ### Authorization
    31  
    32  [Token](../README.md#Token)
    33  
    34  ### HTTP request headers
    35  
    36   - **Content-Type**: application/json
    37   - **Accept**: application/json
    38  
    39  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    40  
    41  # **GetMe**
    42  > Member GetMe(ctx, )
    43  Get the current team member associated with the token
    44  
    45  ### Required Parameters
    46  This endpoint does not need any parameter.
    47  
    48  ### Return type
    49  
    50  [**Member**](Member.md)
    51  
    52  ### Authorization
    53  
    54  [Token](../README.md#Token)
    55  
    56  ### HTTP request headers
    57  
    58   - **Content-Type**: application/json
    59   - **Accept**: application/json
    60  
    61  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    62  
    63  # **GetMember**
    64  > Member GetMember(ctx, memberId)
    65  Get a single team member by ID.
    66  
    67  ### Required Parameters
    68  
    69  Name | Type | Description  | Notes
    70  ------------- | ------------- | ------------- | -------------
    71   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    72    **memberId** | **string**| The member ID. | 
    73  
    74  ### Return type
    75  
    76  [**Member**](Member.md)
    77  
    78  ### Authorization
    79  
    80  [Token](../README.md#Token)
    81  
    82  ### HTTP request headers
    83  
    84   - **Content-Type**: application/json
    85   - **Accept**: application/json
    86  
    87  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    88  
    89  # **GetMembers**
    90  > Members GetMembers(ctx, optional)
    91  Returns a list of all members in the account.
    92  
    93  ### Required Parameters
    94  
    95  Name | Type | Description  | Notes
    96  ------------- | ------------- | ------------- | -------------
    97   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    98   **optional** | ***TeamMembersApiGetMembersOpts** | optional parameters | nil if no parameters
    99  
   100  ### Optional Parameters
   101  Optional parameters are passed through a pointer to a TeamMembersApiGetMembersOpts struct
   102  
   103  Name | Type | Description  | Notes
   104  ------------- | ------------- | ------------- | -------------
   105   **limit** | **optional.Float32**| The number of objects to return. Defaults to -1, which returns everything. | 
   106   **offset** | **optional.Float32**| Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items. | 
   107   **filter** | **optional.String**| A comma-separated list of filters. Each filter is of the form field:value. | 
   108   **sort** | **optional.String**| A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order. | 
   109  
   110  ### Return type
   111  
   112  [**Members**](Members.md)
   113  
   114  ### Authorization
   115  
   116  [Token](../README.md#Token)
   117  
   118  ### HTTP request headers
   119  
   120   - **Content-Type**: application/json
   121   - **Accept**: application/json
   122  
   123  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   124  
   125  # **PatchMember**
   126  > Member PatchMember(ctx, memberId, patchDelta)
   127  Modify a team member by ID.
   128  
   129  ### Required Parameters
   130  
   131  Name | Type | Description  | Notes
   132  ------------- | ------------- | ------------- | -------------
   133   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   134    **memberId** | **string**| The member ID. | 
   135    **patchDelta** | [**[]PatchOperation**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' | 
   136  
   137  ### Return type
   138  
   139  [**Member**](Member.md)
   140  
   141  ### Authorization
   142  
   143  [Token](../README.md#Token)
   144  
   145  ### HTTP request headers
   146  
   147   - **Content-Type**: application/json
   148   - **Accept**: application/json
   149  
   150  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   151  
   152  # **PostMembers**
   153  > Members PostMembers(ctx, membersBody)
   154  Invite new members.
   155  
   156  ### Required Parameters
   157  
   158  Name | Type | Description  | Notes
   159  ------------- | ------------- | ------------- | -------------
   160   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   161    **membersBody** | [**[]MembersBody**](membersBody.md)| New members to invite. | 
   162  
   163  ### Return type
   164  
   165  [**Members**](Members.md)
   166  
   167  ### Authorization
   168  
   169  [Token](../README.md#Token)
   170  
   171  ### HTTP request headers
   172  
   173   - **Content-Type**: application/json
   174   - **Accept**: application/json
   175  
   176  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   177