launchdarkly_api 5.0.0 → 5.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +235 -235
- data/docs/UsersApi.md +59 -0
- data/launchdarkly_api.gemspec +1 -1
- data/lib/launchdarkly_api.rb +1 -2
- data/lib/launchdarkly_api/api/access_tokens_api.rb +1 -1
- data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
- data/lib/launchdarkly_api/api/custom_roles_api.rb +1 -1
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +1 -1
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +1 -1
- data/lib/launchdarkly_api/api/environments_api.rb +1 -1
- data/lib/launchdarkly_api/api/feature_flags_api.rb +1 -1
- data/lib/launchdarkly_api/api/integrations_api.rb +1 -1
- data/lib/launchdarkly_api/api/projects_api.rb +1 -1
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +1 -1
- data/lib/launchdarkly_api/api/root_api.rb +1 -1
- data/lib/launchdarkly_api/api/team_members_api.rb +1 -1
- data/lib/launchdarkly_api/api/user_segments_api.rb +1 -1
- data/lib/launchdarkly_api/api/user_settings_api.rb +1 -1
- data/lib/launchdarkly_api/api/users_api.rb +65 -1
- data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
- data/lib/launchdarkly_api/api_client.rb +1 -1
- data/lib/launchdarkly_api/api_error.rb +1 -1
- data/lib/launchdarkly_api/configuration.rb +1 -1
- data/lib/launchdarkly_api/models/approval_request.rb +1 -1
- data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +1 -1
- data/lib/launchdarkly_api/models/approval_request_config_body.rb +1 -1
- data/lib/launchdarkly_api/models/approval_request_review.rb +1 -1
- data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +1 -1
- data/lib/launchdarkly_api/models/approval_request_review_status.rb +1 -1
- data/lib/launchdarkly_api/models/approval_requests.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entries.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +1 -1
- data/lib/launchdarkly_api/models/clause.rb +1 -1
- data/lib/launchdarkly_api/models/client_side_availability.rb +1 -1
- data/lib/launchdarkly_api/models/copy_actions.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property_values.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role_body.rb +1 -1
- data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
- data/lib/launchdarkly_api/models/defaults.rb +1 -1
- data/lib/launchdarkly_api/models/destination.rb +1 -1
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +1 -1
- data/lib/launchdarkly_api/models/destination_body.rb +1 -1
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +1 -1
- data/lib/launchdarkly_api/models/destination_m_particle.rb +1 -1
- data/lib/launchdarkly_api/models/destination_segment.rb +1 -1
- data/lib/launchdarkly_api/models/destinations.rb +1 -1
- data/lib/launchdarkly_api/models/environment.rb +1 -1
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +1 -1
- data/lib/launchdarkly_api/models/environment_post.rb +1 -1
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/events.rb +1 -1
- data/lib/launchdarkly_api/models/fallthrough.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_config.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flags.rb +1 -1
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +1 -1
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +1 -1
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +1 -1
- data/lib/launchdarkly_api/models/flag_list_item.rb +1 -1
- data/lib/launchdarkly_api/models/hierarchical_links.rb +1 -1
- data/lib/launchdarkly_api/models/id.rb +1 -1
- data/lib/launchdarkly_api/models/integration.rb +1 -1
- data/lib/launchdarkly_api/models/integration__links.rb +1 -1
- data/lib/launchdarkly_api/models/integration_subscription.rb +1 -1
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +1 -1
- data/lib/launchdarkly_api/models/integrations.rb +1 -1
- data/lib/launchdarkly_api/models/link.rb +1 -1
- data/lib/launchdarkly_api/models/links.rb +1 -1
- data/lib/launchdarkly_api/models/ma_uby_category.rb +1 -1
- data/lib/launchdarkly_api/models/mau.rb +1 -1
- data/lib/launchdarkly_api/models/mau_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/member.rb +1 -1
- data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/members.rb +1 -1
- data/lib/launchdarkly_api/models/members_body.rb +1 -1
- data/lib/launchdarkly_api/models/patch_comment.rb +1 -1
- data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/policy.rb +1 -1
- data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
- data/lib/launchdarkly_api/models/project.rb +1 -1
- data/lib/launchdarkly_api/models/project_body.rb +1 -1
- data/lib/launchdarkly_api/models/projects.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +1 -1
- data/lib/launchdarkly_api/models/role.rb +1 -1
- data/lib/launchdarkly_api/models/rollout.rb +1 -1
- data/lib/launchdarkly_api/models/rule.rb +1 -1
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/site.rb +1 -1
- data/lib/launchdarkly_api/models/statement.rb +1 -1
- data/lib/launchdarkly_api/models/stream.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_series.rb +1 -1
- data/lib/launchdarkly_api/models/streams.rb +1 -1
- data/lib/launchdarkly_api/models/subscription_body.rb +1 -1
- data/lib/launchdarkly_api/models/target.rb +1 -1
- data/lib/launchdarkly_api/models/token.rb +1 -1
- data/lib/launchdarkly_api/models/token_body.rb +1 -1
- data/lib/launchdarkly_api/models/tokens.rb +1 -1
- data/lib/launchdarkly_api/models/unbounded_segment_target_changes.rb +1 -1
- data/lib/launchdarkly_api/models/unbounded_segment_targets_body.rb +1 -1
- data/lib/launchdarkly_api/models/usage.rb +1 -1
- data/lib/launchdarkly_api/models/usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/user.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_setting.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_settings.rb +1 -1
- data/lib/launchdarkly_api/models/user_record.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
- data/lib/launchdarkly_api/models/user_segments.rb +1 -1
- data/lib/launchdarkly_api/models/user_settings_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/users.rb +1 -1
- data/lib/launchdarkly_api/models/variation.rb +1 -1
- data/lib/launchdarkly_api/models/webhook.rb +1 -1
- data/lib/launchdarkly_api/models/webhook_body.rb +1 -1
- data/lib/launchdarkly_api/models/webhooks.rb +1 -1
- data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
- data/lib/launchdarkly_api/version.rb +2 -2
- data/openapi.yml +3 -3
- data/spec/api/access_tokens_api_spec.rb +1 -1
- data/spec/api/audit_log_api_spec.rb +1 -1
- data/spec/api/custom_roles_api_spec.rb +1 -1
- data/spec/api/customer_metrics_api_spec.rb +1 -1
- data/spec/api/data_export_destinations_api_spec.rb +1 -1
- data/spec/api/environments_api_spec.rb +1 -1
- data/spec/api/feature_flags_api_spec.rb +1 -1
- data/spec/api/integrations_api_spec.rb +1 -1
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/relay_proxy_configurations_api_spec.rb +1 -1
- data/spec/api/root_api_spec.rb +1 -1
- data/spec/api/team_members_api_spec.rb +1 -1
- data/spec/api/user_segments_api_spec.rb +1 -1
- data/spec/api/user_settings_api_spec.rb +1 -1
- data/spec/api/users_api_spec.rb +14 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/approval_request_apply_config_body_spec.rb +1 -1
- data/spec/models/approval_request_config_body_spec.rb +1 -1
- data/spec/models/approval_request_review_config_body_spec.rb +1 -1
- data/spec/models/approval_request_review_spec.rb +1 -1
- data/spec/models/approval_request_review_status_spec.rb +1 -1
- data/spec/models/approval_request_spec.rb +1 -1
- data/spec/models/approval_requests_spec.rb +1 -1
- data/spec/models/audit_log_entries_spec.rb +1 -1
- data/spec/models/audit_log_entry_spec.rb +1 -1
- data/spec/models/audit_log_entry_target_spec.rb +1 -1
- data/spec/models/clause_spec.rb +1 -1
- data/spec/models/client_side_availability_spec.rb +1 -1
- data/spec/models/copy_actions_spec.rb +1 -1
- data/spec/models/custom_property_spec.rb +1 -1
- data/spec/models/custom_property_values_spec.rb +1 -1
- data/spec/models/custom_role_body_spec.rb +1 -1
- data/spec/models/custom_role_spec.rb +1 -1
- data/spec/models/custom_roles_spec.rb +1 -1
- data/spec/models/defaults_spec.rb +1 -1
- data/spec/models/destination_amazon_kinesis_spec.rb +1 -1
- data/spec/models/destination_body_spec.rb +1 -1
- data/spec/models/destination_google_pub_sub_spec.rb +1 -1
- data/spec/models/destination_m_particle_spec.rb +1 -1
- data/spec/models/destination_segment_spec.rb +1 -1
- data/spec/models/destination_spec.rb +1 -1
- data/spec/models/destinations_spec.rb +1 -1
- data/spec/models/environment_approval_settings_spec.rb +1 -1
- data/spec/models/environment_post_spec.rb +1 -1
- data/spec/models/environment_spec.rb +1 -1
- data/spec/models/evaluation_usage_error_spec.rb +1 -1
- data/spec/models/events_spec.rb +1 -1
- data/spec/models/fallthrough_spec.rb +1 -1
- data/spec/models/feature_flag_body_spec.rb +1 -1
- data/spec/models/feature_flag_config_spec.rb +1 -1
- data/spec/models/feature_flag_copy_body_spec.rb +1 -1
- data/spec/models/feature_flag_copy_object_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_change_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_spec.rb +1 -1
- data/spec/models/feature_flag_spec.rb +1 -1
- data/spec/models/feature_flag_status_across_environments_spec.rb +1 -1
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +1 -1
- data/spec/models/feature_flag_status_spec.rb +1 -1
- data/spec/models/feature_flag_statuses_spec.rb +1 -1
- data/spec/models/feature_flags_spec.rb +1 -1
- data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +1 -1
- data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +1 -1
- data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +1 -1
- data/spec/models/flag_list_item_spec.rb +1 -1
- data/spec/models/hierarchical_links_spec.rb +1 -1
- data/spec/models/id_spec.rb +1 -1
- data/spec/models/integration__links_spec.rb +1 -1
- data/spec/models/integration_spec.rb +1 -1
- data/spec/models/integration_subscription__status_spec.rb +1 -1
- data/spec/models/integration_subscription_spec.rb +1 -1
- data/spec/models/integrations_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/links_spec.rb +1 -1
- data/spec/models/ma_uby_category_spec.rb +1 -1
- data/spec/models/mau_metadata_spec.rb +1 -1
- data/spec/models/mau_spec.rb +1 -1
- data/spec/models/member__last_seen_metadata_spec.rb +1 -1
- data/spec/models/member_spec.rb +1 -1
- data/spec/models/members_body_spec.rb +1 -1
- data/spec/models/members_spec.rb +1 -1
- data/spec/models/patch_comment_spec.rb +1 -1
- data/spec/models/patch_operation_spec.rb +1 -1
- data/spec/models/policy_spec.rb +1 -1
- data/spec/models/prerequisite_spec.rb +1 -1
- data/spec/models/project_body_spec.rb +1 -1
- data/spec/models/project_spec.rb +1 -1
- data/spec/models/projects_spec.rb +1 -1
- data/spec/models/relay_proxy_config_body_spec.rb +1 -1
- data/spec/models/relay_proxy_config_spec.rb +1 -1
- data/spec/models/relay_proxy_configs_spec.rb +1 -1
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollout_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +1 -1
- data/spec/models/semantic_patch_instruction_inner_spec.rb +1 -1
- data/spec/models/semantic_patch_instruction_spec.rb +1 -1
- data/spec/models/semantic_patch_operation_spec.rb +1 -1
- data/spec/models/site_spec.rb +1 -1
- data/spec/models/statement_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_spec.rb +1 -1
- data/spec/models/stream_by_sdk_spec.rb +1 -1
- data/spec/models/stream_links_spec.rb +1 -1
- data/spec/models/stream_sdk_version_data_spec.rb +1 -1
- data/spec/models/stream_sdk_version_spec.rb +1 -1
- data/spec/models/stream_spec.rb +1 -1
- data/spec/models/stream_usage_error_spec.rb +1 -1
- data/spec/models/stream_usage_links_spec.rb +1 -1
- data/spec/models/stream_usage_metadata_spec.rb +1 -1
- data/spec/models/stream_usage_series_spec.rb +1 -1
- data/spec/models/streams_spec.rb +1 -1
- data/spec/models/subscription_body_spec.rb +1 -1
- data/spec/models/target_spec.rb +1 -1
- data/spec/models/token_body_spec.rb +1 -1
- data/spec/models/token_spec.rb +1 -1
- data/spec/models/tokens_spec.rb +1 -1
- data/spec/models/unbounded_segment_target_changes_spec.rb +1 -1
- data/spec/models/unbounded_segment_targets_body_spec.rb +1 -1
- data/spec/models/usage_error_spec.rb +1 -1
- data/spec/models/usage_links_spec.rb +1 -1
- data/spec/models/usage_spec.rb +1 -1
- data/spec/models/user_flag_setting_spec.rb +1 -1
- data/spec/models/user_flag_settings_spec.rb +1 -1
- data/spec/models/user_record_spec.rb +1 -1
- data/spec/models/user_segment_body_spec.rb +1 -1
- data/spec/models/user_segment_rule_spec.rb +1 -1
- data/spec/models/user_segment_spec.rb +1 -1
- data/spec/models/user_segments_spec.rb +1 -1
- data/spec/models/user_settings_body_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +1 -1
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/variation_spec.rb +1 -1
- data/spec/models/webhook_body_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/webhooks_spec.rb +1 -1
- data/spec/models/weighted_variation_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +2 -6
- data/docs/UserRecordApi.md +0 -67
- data/lib/launchdarkly_api/api/user_record_api.rb +0 -87
- data/spec/api/user_record_api_spec.rb +0 -48
data/docs/UsersApi.md
CHANGED
|
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**delete_user**](UsersApi.md#delete_user) | **DELETE** /users/{projectKey}/{environmentKey}/{userKey} | Delete a user by ID.
|
|
8
8
|
[**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.
|
|
9
10
|
[**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.
|
|
10
11
|
|
|
11
12
|
|
|
@@ -131,6 +132,64 @@ Name | Type | Description | Notes
|
|
|
131
132
|
|
|
132
133
|
|
|
133
134
|
|
|
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
|
+
|
|
134
193
|
# **get_users**
|
|
135
194
|
> Users get_users(project_key, environment_key, , opts)
|
|
136
195
|
|
data/launchdarkly_api.gemspec
CHANGED
data/lib/launchdarkly_api.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#Build custom integrations with the LaunchDarkly REST API
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 5.0.
|
|
6
|
+
OpenAPI spec version: 5.0.1
|
|
7
7
|
Contact: support@launchdarkly.com
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
9
|
Swagger Codegen version: 2.4.8
|
|
@@ -158,7 +158,6 @@ require 'launchdarkly_api/api/projects_api'
|
|
|
158
158
|
require 'launchdarkly_api/api/relay_proxy_configurations_api'
|
|
159
159
|
require 'launchdarkly_api/api/root_api'
|
|
160
160
|
require 'launchdarkly_api/api/team_members_api'
|
|
161
|
-
require 'launchdarkly_api/api/user_record_api'
|
|
162
161
|
require 'launchdarkly_api/api/user_segments_api'
|
|
163
162
|
require 'launchdarkly_api/api/user_settings_api'
|
|
164
163
|
require 'launchdarkly_api/api/users_api'
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#Build custom integrations with the LaunchDarkly REST API
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 5.0.
|
|
6
|
+
OpenAPI spec version: 5.0.1
|
|
7
7
|
Contact: support@launchdarkly.com
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
9
|
Swagger Codegen version: 2.4.8
|
|
@@ -152,6 +152,70 @@ module LaunchDarklyApi
|
|
|
152
152
|
end
|
|
153
153
|
return data, status_code, headers
|
|
154
154
|
end
|
|
155
|
+
# Get a user by key.
|
|
156
|
+
# @param project_key The project key, used to tie the flags together under one project so they can be managed together.
|
|
157
|
+
# @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
158
|
+
# @param user_key The user's key.
|
|
159
|
+
# @param [Hash] opts the optional parameters
|
|
160
|
+
# @return [UserRecord]
|
|
161
|
+
def get_user(project_key, environment_key, user_key, opts = {})
|
|
162
|
+
data, _status_code, _headers = get_user_with_http_info(project_key, environment_key, user_key, opts)
|
|
163
|
+
data
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
# Get a user by key.
|
|
167
|
+
# @param project_key The project key, used to tie the flags together under one project so they can be managed together.
|
|
168
|
+
# @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
169
|
+
# @param user_key The user's key.
|
|
170
|
+
# @param [Hash] opts the optional parameters
|
|
171
|
+
# @return [Array<(UserRecord, Fixnum, Hash)>] UserRecord data, response status code and response headers
|
|
172
|
+
def get_user_with_http_info(project_key, environment_key, user_key, opts = {})
|
|
173
|
+
if @api_client.config.debugging
|
|
174
|
+
@api_client.config.logger.debug 'Calling API: UsersApi.get_user ...'
|
|
175
|
+
end
|
|
176
|
+
# verify the required parameter 'project_key' is set
|
|
177
|
+
if @api_client.config.client_side_validation && project_key.nil?
|
|
178
|
+
fail ArgumentError, "Missing the required parameter 'project_key' when calling UsersApi.get_user"
|
|
179
|
+
end
|
|
180
|
+
# verify the required parameter 'environment_key' is set
|
|
181
|
+
if @api_client.config.client_side_validation && environment_key.nil?
|
|
182
|
+
fail ArgumentError, "Missing the required parameter 'environment_key' when calling UsersApi.get_user"
|
|
183
|
+
end
|
|
184
|
+
# verify the required parameter 'user_key' is set
|
|
185
|
+
if @api_client.config.client_side_validation && user_key.nil?
|
|
186
|
+
fail ArgumentError, "Missing the required parameter 'user_key' when calling UsersApi.get_user"
|
|
187
|
+
end
|
|
188
|
+
# resource path
|
|
189
|
+
local_var_path = '/users/{projectKey}/{environmentKey}/{userKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'userKey' + '}', user_key.to_s)
|
|
190
|
+
|
|
191
|
+
# query parameters
|
|
192
|
+
query_params = {}
|
|
193
|
+
|
|
194
|
+
# header parameters
|
|
195
|
+
header_params = {}
|
|
196
|
+
# HTTP header 'Accept' (if needed)
|
|
197
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
198
|
+
# HTTP header 'Content-Type'
|
|
199
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
200
|
+
|
|
201
|
+
# form parameters
|
|
202
|
+
form_params = {}
|
|
203
|
+
|
|
204
|
+
# http body (model)
|
|
205
|
+
post_body = nil
|
|
206
|
+
auth_names = ['Token']
|
|
207
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
208
|
+
:header_params => header_params,
|
|
209
|
+
:query_params => query_params,
|
|
210
|
+
:form_params => form_params,
|
|
211
|
+
:body => post_body,
|
|
212
|
+
:auth_names => auth_names,
|
|
213
|
+
:return_type => 'UserRecord')
|
|
214
|
+
if @api_client.config.debugging
|
|
215
|
+
@api_client.config.logger.debug "API called: UsersApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
216
|
+
end
|
|
217
|
+
return data, status_code, headers
|
|
218
|
+
end
|
|
155
219
|
# 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.
|
|
156
220
|
# @param project_key The project key, used to tie the flags together under one project so they can be managed together.
|
|
157
221
|
# @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|