github.com/launchdarkly/api-client-go@v5.3.0+incompatible/docs/UsersApi.md (about) 1 # \UsersApi 2 3 All URIs are relative to *https://app.launchdarkly.com/api/v2* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**DeleteUser**](UsersApi.md#DeleteUser) | **Delete** /users/{projectKey}/{environmentKey}/{userKey} | Delete a user by ID. 8 [**GetSearchUsers**](UsersApi.md#GetSearchUsers) | **Get** /user-search/{projectKey}/{environmentKey} | Search users in LaunchDarkly based on their last active date, or a search query. It should not be used to enumerate all users in LaunchDarkly-- use the List users API resource. 9 [**GetUser**](UsersApi.md#GetUser) | **Get** /users/{projectKey}/{environmentKey}/{userKey} | Get a user by key. 10 [**GetUsers**](UsersApi.md#GetUsers) | **Get** /users/{projectKey}/{environmentKey} | List all users in the environment. Includes the total count of users. In each page, there will be up to 'limit' users returned (default 20). This is useful for exporting all users in the system for further analysis. Paginated collections will include a next link containing a URL with the next set of elements in the collection. 11 12 13 # **DeleteUser** 14 > DeleteUser(ctx, projectKey, environmentKey, userKey) 15 Delete a user by ID. 16 17 ### Required Parameters 18 19 Name | Type | Description | Notes 20 ------------- | ------------- | ------------- | ------------- 21 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 22 **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 23 **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 24 **userKey** | **string**| The user's key. | 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 # **GetSearchUsers** 42 > Users GetSearchUsers(ctx, projectKey, environmentKey, optional) 43 Search users in LaunchDarkly based on their last active date, or a search query. It should not be used to enumerate all users in LaunchDarkly-- use the List users API resource. 44 45 ### Required Parameters 46 47 Name | Type | Description | Notes 48 ------------- | ------------- | ------------- | ------------- 49 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 50 **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 51 **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 52 **optional** | ***UsersApiGetSearchUsersOpts** | optional parameters | nil if no parameters 53 54 ### Optional Parameters 55 Optional parameters are passed through a pointer to a UsersApiGetSearchUsersOpts struct 56 57 Name | Type | Description | Notes 58 ------------- | ------------- | ------------- | ------------- 59 60 61 **q** | **optional.String**| Search query. | 62 **limit** | **optional.Int32**| Pagination limit. | 63 **offset** | **optional.Int32**| Specifies the first item to return in the collection. | 64 **after** | **optional.Int64**| A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. | 65 66 ### Return type 67 68 [**Users**](Users.md) 69 70 ### Authorization 71 72 [Token](../README.md#Token) 73 74 ### HTTP request headers 75 76 - **Content-Type**: application/json 77 - **Accept**: application/json 78 79 [[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) 80 81 # **GetUser** 82 > UserRecord GetUser(ctx, projectKey, environmentKey, userKey) 83 Get a user by key. 84 85 ### Required Parameters 86 87 Name | Type | Description | Notes 88 ------------- | ------------- | ------------- | ------------- 89 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 90 **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 91 **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 92 **userKey** | **string**| The user's key. | 93 94 ### Return type 95 96 [**UserRecord**](UserRecord.md) 97 98 ### Authorization 99 100 [Token](../README.md#Token) 101 102 ### HTTP request headers 103 104 - **Content-Type**: application/json 105 - **Accept**: application/json 106 107 [[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) 108 109 # **GetUsers** 110 > Users GetUsers(ctx, projectKey, environmentKey, optional) 111 List all users in the environment. Includes the total count of users. In each page, there will be up to 'limit' users returned (default 20). This is useful for exporting all users in the system for further analysis. Paginated collections will include a next link containing a URL with the next set of elements in the collection. 112 113 ### Required Parameters 114 115 Name | Type | Description | Notes 116 ------------- | ------------- | ------------- | ------------- 117 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 118 **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 119 **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 120 **optional** | ***UsersApiGetUsersOpts** | optional parameters | nil if no parameters 121 122 ### Optional Parameters 123 Optional parameters are passed through a pointer to a UsersApiGetUsersOpts struct 124 125 Name | Type | Description | Notes 126 ------------- | ------------- | ------------- | ------------- 127 128 129 **limit** | **optional.Int32**| Pagination limit. | 130 **h** | **optional.String**| This parameter is required when following \"next\" links. | 131 **scrollId** | **optional.String**| This parameter is required when following \"next\" links. | 132 133 ### Return type 134 135 [**Users**](Users.md) 136 137 ### Authorization 138 139 [Token](../README.md#Token) 140 141 ### HTTP request headers 142 143 - **Content-Type**: application/json 144 - **Accept**: application/json 145 146 [[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) 147