Skip to content

Commit 9aa05b4

Browse files
author
LaunchDarklyCI
committed
Version 5.0.1 automatically generated from ld-openapi@b34b97c.
1 parent 5502886 commit 9aa05b4

File tree

298 files changed

+670
-535
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

298 files changed

+670
-535
lines changed

‎README.md‎

Lines changed: 235 additions & 235 deletions
Large diffs are not rendered by default.

‎docs/UsersApi.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**delete_user**](UsersApi.md#delete_user) | **DELETE** /users/{projectKey}/{environmentKey}/{userKey} | Delete a user by ID.
88
[**get_search_users**](UsersApi.md#get_search_users) | **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+
[**get_user**](UsersApi.md#get_user) | **GET** /users/{projectKey}/{environmentKey}/{userKey} | Get a user by key.
910
[**get_users**](UsersApi.md#get_users) | **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.
1011

1112

@@ -131,6 +132,64 @@ Name | Type | Description | Notes
131132

132133

133134

135+
# **get_user**
136+
> UserRecord get_user(project_key, environment_key, user_key, )
137+
138+
Get a user by key.
139+
140+
### Example
141+
```ruby
142+
# load the gem
143+
require 'launchdarkly_api'
144+
# setup authorization
145+
LaunchDarklyApi.configure do |config|
146+
# Configure API key authorization: Token
147+
config.api_key['Authorization'] = 'YOUR API KEY'
148+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
149+
#config.api_key_prefix['Authorization'] = 'Bearer'
150+
end
151+
152+
api_instance = LaunchDarklyApi::UsersApi.new
153+
154+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
155+
156+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
157+
158+
user_key = 'user_key_example' # String | The user's key.
159+
160+
161+
begin
162+
#Get a user by key.
163+
result = api_instance.get_user(project_key, environment_key, user_key, )
164+
p result
165+
rescue LaunchDarklyApi::ApiError => e
166+
puts "Exception when calling UsersApi->get_user: #{e}"
167+
end
168+
```
169+
170+
### Parameters
171+
172+
Name | Type | Description | Notes
173+
------------- | ------------- | ------------- | -------------
174+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
175+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
176+
**user_key** | **String**| The user's key. |
177+
178+
### Return type
179+
180+
[**UserRecord**](UserRecord.md)
181+
182+
### Authorization
183+
184+
[Token](../README.md#Token)
185+
186+
### HTTP request headers
187+
188+
- **Content-Type**: application/json
189+
- **Accept**: application/json
190+
191+
192+
134193
# **get_users**
135194
> Users get_users(project_key, environment_key, , opts)
136195

‎launchdarkly_api.gemspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
#Build custom integrations with the LaunchDarkly REST API
77
8-
OpenAPI spec version: 5.0.0
8+
OpenAPI spec version: 5.0.1
99
Contact: support@launchdarkly.com
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
Swagger Codegen version: 2.4.8

‎lib/launchdarkly_api.rb‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Build custom integrations with the LaunchDarkly REST API
55
6-
OpenAPI spec version: 5.0.0
6+
OpenAPI spec version: 5.0.1
77
Contact: support@launchdarkly.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
99
Swagger Codegen version: 2.4.8
@@ -158,7 +158,6 @@
158158
require 'launchdarkly_api/api/relay_proxy_configurations_api'
159159
require 'launchdarkly_api/api/root_api'
160160
require 'launchdarkly_api/api/team_members_api'
161-
require 'launchdarkly_api/api/user_record_api'
162161
require 'launchdarkly_api/api/user_segments_api'
163162
require 'launchdarkly_api/api/user_settings_api'
164163
require 'launchdarkly_api/api/users_api'

‎lib/launchdarkly_api/api/access_tokens_api.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Build custom integrations with the LaunchDarkly REST API
55
6-
OpenAPI spec version: 5.0.0
6+
OpenAPI spec version: 5.0.1
77
Contact: support@launchdarkly.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
99
Swagger Codegen version: 2.4.8

‎lib/launchdarkly_api/api/audit_log_api.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Build custom integrations with the LaunchDarkly REST API
55
6-
OpenAPI spec version: 5.0.0
6+
OpenAPI spec version: 5.0.1
77
Contact: support@launchdarkly.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
99
Swagger Codegen version: 2.4.8

‎lib/launchdarkly_api/api/custom_roles_api.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Build custom integrations with the LaunchDarkly REST API
55
6-
OpenAPI spec version: 5.0.0
6+
OpenAPI spec version: 5.0.1
77
Contact: support@launchdarkly.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
99
Swagger Codegen version: 2.4.8

‎lib/launchdarkly_api/api/customer_metrics_api.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Build custom integrations with the LaunchDarkly REST API
55
6-
OpenAPI spec version: 5.0.0
6+
OpenAPI spec version: 5.0.1
77
Contact: support@launchdarkly.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
99
Swagger Codegen version: 2.4.8

‎lib/launchdarkly_api/api/data_export_destinations_api.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Build custom integrations with the LaunchDarkly REST API
55
6-
OpenAPI spec version: 5.0.0
6+
OpenAPI spec version: 5.0.1
77
Contact: support@launchdarkly.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
99
Swagger Codegen version: 2.4.8

‎lib/launchdarkly_api/api/environments_api.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
#Build custom integrations with the LaunchDarkly REST API
55
6-
OpenAPI spec version: 5.0.0
6+
OpenAPI spec version: 5.0.1
77
Contact: support@launchdarkly.com
88
Generated by: https://github.com/swagger-api/swagger-codegen.git
99
Swagger Codegen version: 2.4.8

0 commit comments

Comments
 (0)