Skip to content

Commit 6271e3b

Browse files
author
LaunchDarklyCI
committed
Version 5.0.1 automatically generated from ld-openapi@b34b97c.
1 parent e27af0f commit 6271e3b

File tree

292 files changed

+802
-678
lines changed

Some content is hidden

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

292 files changed

+802
-678
lines changed

README.md

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

docs/UsersApi.md

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

1112

@@ -125,6 +126,63 @@ Name | Type | Description | Notes
125126

126127
[Token](../README.md#Token)
127128

129+
### HTTP request headers
130+
131+
- **Content-Type**: application/json
132+
- **Accept**: application/json
133+
134+
<a name="getUser"></a>
135+
# **getUser**
136+
> UserRecord getUser(projectKey, environmentKey, userKey, )
137+
138+
Get a user by key.
139+
140+
### Example
141+
```javascript
142+
var LaunchDarklyApi = require('launchdarkly-api');
143+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
144+
145+
// Configure API key authorization: Token
146+
var Token = defaultClient.authentications['Token'];
147+
Token.apiKey = 'YOUR API KEY';
148+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
149+
//Token.apiKeyPrefix = 'Token';
150+
151+
var apiInstance = new LaunchDarklyApi.UsersApi();
152+
153+
var projectKey = "projectKey_example"; // String | The project key, used to tie the flags together under one project so they can be managed together.
154+
155+
var environmentKey = "environmentKey_example"; // String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
156+
157+
var userKey = "userKey_example"; // String | The user's key.
158+
159+
160+
var callback = function(error, data, response) {
161+
if (error) {
162+
console.error(error);
163+
} else {
164+
console.log('API called successfully. Returned data: ' + data);
165+
}
166+
};
167+
apiInstance.getUser(projectKey, environmentKey, userKey, , callback);
168+
```
169+
170+
### Parameters
171+
172+
Name | Type | Description | Notes
173+
------------- | ------------- | ------------- | -------------
174+
**projectKey** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
175+
**environmentKey** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
176+
**userKey** | **String**| The user&#39;s key. |
177+
178+
### Return type
179+
180+
[**UserRecord**](UserRecord.md)
181+
182+
### Authorization
183+
184+
[Token](../README.md#Token)
185+
128186
### HTTP request headers
129187

130188
- **Content-Type**: application/json

openapi.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ info:
1010
license:
1111
name: Apache 2.0
1212
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
13-
version: 5.0.0
13+
version: 5.0.1
1414
host: app.launchdarkly.com
1515
basePath: /api/v2
1616
schemes:
@@ -887,13 +887,13 @@ paths:
887887
'200':
888888
description: User response.
889889
schema:
890-
$ref: '#/definitions/User'
890+
$ref: '#/definitions/UserRecord'
891891
'401':
892892
$ref: '#/responses/Standard401'
893893
'404':
894894
$ref: '#/responses/Standard404'
895895
tags:
896-
- UserRecord
896+
- Users
897897
delete:
898898
summary: Delete a user by ID.
899899
operationId: deleteUser

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "launchdarkly-api",
3-
"version": "5.0.0",
3+
"version": "5.0.1",
44
"description": "Build_custom_integrations_with_the_LaunchDarkly_REST_API",
55
"license": "Apache 2.0",
66
"main": "src/index.js",

src/ApiClient.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.0.0
5+
* OpenAPI spec version: 5.0.1
66
* Contact: support@launchdarkly.com
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -33,7 +33,7 @@
3333

3434
/**
3535
* @module ApiClient
36-
* @version 5.0.0
36+
* @version 5.0.1
3737
*/
3838

3939
/**

src/api/AccessTokensApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.0.0
5+
* OpenAPI spec version: 5.0.1
66
* Contact: support@launchdarkly.com
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* AccessTokens service.
3636
* @module api/AccessTokensApi
37-
* @version 5.0.0
37+
* @version 5.0.1
3838
*/
3939

4040
/**

src/api/AuditLogApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.0.0
5+
* OpenAPI spec version: 5.0.1
66
* Contact: support@launchdarkly.com
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* AuditLog service.
3636
* @module api/AuditLogApi
37-
* @version 5.0.0
37+
* @version 5.0.1
3838
*/
3939

4040
/**

src/api/CustomRolesApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.0.0
5+
* OpenAPI spec version: 5.0.1
66
* Contact: support@launchdarkly.com
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* CustomRoles service.
3636
* @module api/CustomRolesApi
37-
* @version 5.0.0
37+
* @version 5.0.1
3838
*/
3939

4040
/**

src/api/CustomerMetricsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.0.0
5+
* OpenAPI spec version: 5.0.1
66
* Contact: support@launchdarkly.com
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* CustomerMetrics service.
3636
* @module api/CustomerMetricsApi
37-
* @version 5.0.0
37+
* @version 5.0.1
3838
*/
3939

4040
/**

src/api/DataExportDestinationsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.0.0
5+
* OpenAPI spec version: 5.0.1
66
* Contact: support@launchdarkly.com
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* DataExportDestinations service.
3636
* @module api/DataExportDestinationsApi
37-
* @version 5.0.0
37+
* @version 5.0.1
3838
*/
3939

4040
/**

0 commit comments

Comments
 (0)