Skip to content
This repository was archived by the owner on Sep 3, 2021. It is now read-only.

Latest commit

 

History

History
177 lines (113 loc) · 6.81 KB

UserSettingsApi.md

File metadata and controls

177 lines (113 loc) · 6.81 KB

UserSettingsApi

All URIs are relative to /api/v2

Method HTTP request Description
getExpiringUserTargetsForUser GET /users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} Get expiring dates on flags for user
getUserFlagSetting GET /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} Fetch a single flag setting for a user by key.
getUserFlagSettings GET /users/{projectKey}/{environmentKey}/{userKey}/flags Fetch a single flag setting for a user by key.
patchExpiringUserTargetsForFlags PATCH /users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} Update, add, or delete expiring user targets for a single user on all flags
putFlagSetting PUT /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} Specifically enable or disable a feature flag for a user based on their key.

getExpiringUserTargetsForUser

Get expiring dates on flags for user

Example

 getExpiringUserTargetsForUser projectKey=value environmentKey=value userKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userKey string The user's key.

Return type

UserTargetingExpirationOnFlagsForUser

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserFlagSetting

Fetch a single flag setting for a user by key.

Example

 getUserFlagSetting projectKey=value environmentKey=value userKey=value featureFlagKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userKey string The user's key.
featureFlagKey string The feature flag's key. The key identifies the flag in your code.

Return type

UserFlagSetting

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserFlagSettings

Fetch a single flag setting for a user by key.

Example

 getUserFlagSettings projectKey=value environmentKey=value userKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userKey string The user's key.

Return type

UserFlagSettings

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchExpiringUserTargetsForFlags

Update, add, or delete expiring user targets for a single user on all flags

Example

 patchExpiringUserTargetsForFlags projectKey=value environmentKey=value userKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userKey string The user's key.
semanticPatchWithComment map Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.

Return type

UserTargetingExpirationOnFlagsForUser

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putFlagSetting

Specifically enable or disable a feature flag for a user based on their key.

Example

 putFlagSetting projectKey=value environmentKey=value userKey=value featureFlagKey=value

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
userKey string The user's key.
featureFlagKey string The feature flag's key. The key identifies the flag in your code.
userSettingsBody UserSettingsBody

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]