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

Files

Latest commit

author
LaunchDarklyCI
Version 5.0.1 automatically generated from ld-openapi@b34b97c.
Feb 19, 2021
998f240 · Feb 19, 2021

History

History
145 lines (93 loc) · 5.8 KB

UsersApi.md

File metadata and controls

145 lines (93 loc) · 5.8 KB

UsersApi

All URIs are relative to /api/v2

Method HTTP request Description
deleteUser DELETE /users/{projectKey}/{environmentKey}/{userKey} Delete a user by ID.
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.
getUser GET /users/{projectKey}/{environmentKey}/{userKey} Get a user by key.
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.

deleteUser

Delete a user by ID.

Example

 deleteUser 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

(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]

getSearchUsers

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.

Example

 getSearchUsers projectKey=value environmentKey=value  q=value  limit=value  offset=value  after=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.
q string Search query. [optional]
limit integer Pagination limit. [optional]
offset integer Specifies the first item to return in the collection. [optional]
after integer A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. [optional]

Return type

Users

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]

getUser

Get a user by key.

Example

 getUser 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

UserRecord

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]

getUsers

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.

Example

 getUsers projectKey=value environmentKey=value  limit=value  h=value  scrollId=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.
limit integer Pagination limit. [optional]
h string This parameter is required when following "next" links. [optional]
scrollId string This parameter is required when following "next" links. [optional]

Return type

Users

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]