You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,15 @@ This REST API is for custom integrations, data export, or automating your featur
6
6
This client library is only compatible with the latest version of our REST API, version `20220603`. Previous versions of this client library, prior to version 10.0.0, are only compatible with earlier versions of our REST API. When you create an access token, you can set the REST API version associated with the token. By default, API requests you send using the token will use the specified API version. To learn more, read [Versioning](https://apidocs.launchdarkly.com/#section/Overview/Versioning).
7
7
View our [sample code](#sample-code) for example usage.
8
8
9
-
## launchdarkly-api-typescript@16.1.1
9
+
## launchdarkly-api-typescript@17.0.0
10
10
11
11
# Overview
12
12
13
13
## Authentication
14
14
15
15
LaunchDarkly's REST API uses the HTTPS protocol with a minimum TLS version of 1.2.
16
16
17
-
All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account/api), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [**Account settings**](https://app.launchdarkly.com/settings/tokens) page.
17
+
All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account/api), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [**Authorization**](https://app.launchdarkly.com/settings/authorization) page in the LaunchDarkly UI.
18
18
19
19
LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and JavaScript-based SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations such as fetching feature flag settings.
20
20
@@ -27,15 +27,15 @@ LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used b
27
27
28
28
> #### Keep your access tokens and SDK keys private
29
29
>
30
-
> Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [**Account settings**](https://app.launchdarkly.com/settings/tokens) page.
30
+
> Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [**Authorization**](https://app.launchdarkly.com/settings/authorization) page.
31
31
>
32
32
> The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript.
33
33
34
34
### Authentication using request header
35
35
36
36
The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token.
37
37
38
-
Manage personal access tokens from the [**Account settings**](https://app.launchdarkly.com/settings/tokens) page.
38
+
Manage personal access tokens from the [**Authorization**](https://app.launchdarkly.com/settings/authorization) page.
39
39
40
40
### Authentication using session cookie
41
41
@@ -73,7 +73,7 @@ The best way to find a detailed representation is to follow links. Every summary
73
73
74
74
Sometimes the detailed representation of a resource does not include all of the attributes of the resource by default. If this is the case, the request method will clearly document this and describe which attributes you can include in an expanded response.
75
75
76
-
To include the additional attributes, append the `expand` request parameter to your request and add a comma-separated list of the attributes to include. For example, when you append `?expand=members,roles` to the [Get team](/tag/Teams#operation/getTeam) endpoint, the expanded response includes both of these attributes.
76
+
To include the additional attributes, append the `expand` request parameter to your request and add a comma-separated list of the attributes to include. For example, when you append `?expand=members,maintainers` to the [Get team](/tag/Teams#operation/getTeam) endpoint, the expanded response includes both of these attributes.
77
77
78
78
### Links and addressability
79
79
@@ -432,7 +432,7 @@ navigate to the folder of your consuming project and run one of the following co
0 commit comments