Get user — LaunchDarkly

Use contexts instead

After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should use Get context instances instead of this endpoint.

Get a user by key. The user object contains all attributes sent in variation calls for that key.

Path parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

userKeystringRequired

The user key

Response

User response

lastPingdatetimeOptional

Timestamp of the last time this user was seen

environmentIdstringOptional

The environment ID

ownerIdstringOptional

The ID of the member who is the owner for this account

userobjectOptional

Details on the user

sortValueanyOptional

_linksmap from strings to objectsOptional

The location and content type of related resources

_accessobjectOptional

Details on the allowed and denied actions for this user

Errors

1 curl https://app.launchdarkly.com/api/v2/users/projectKey/environmentKey/userKey \ 2 -H "Authorization: <apiKey>"

1 { 2 "lastPing": "2022-06-28T23:21:29Z", 3 "environmentId": "environmentId", 4 "ownerId": "ownerId", 5 "user": { 6 "key": "user-key-123abc", 7 "secondary": "2398127", 8 "ip": "10.10.10.10", 9 "country": "United States", 10 "email": "sandy@example.com", 11 "firstName": "Sandy", 12 "lastName": "Smith", 13 "avatar": "http://example.com/avatar.png", 14 "name": "Sandy Smith", 15 "anonymous": false, 16 "custom": { 17 "key": "value" 18 }, 19 "privateAttrs": [ 20 "privateAttrs" 21 ] 22 }, 23 "sortValue": { 24 "key": "value" 25 }, 26 "_links": { 27 "parent": { 28 "href": "/api/v2/users/my-project/my-environment", 29 "type": "application/json" 30 }, 31 "self": { 32 "href": "/api/v2/users/my-project/my-environment/my-user", 33 "type": "application/json" 34 }, 35 "settings": { 36 "href": "/api/v2/users/my-project/my-environment/my-user/flags", 37 "type": "text/html" 38 }, 39 "site": { 40 "href": "/my-project/my-environment/users/my-user", 41 "type": "text/html" 42 } 43 }, 44 "_access": { 45 "denied": [ 46 { 47 "action": "action", 48 "reason": { 49 "effect": "allow" 50 } 51 } 52 ], 53 "allowed": [ 54 { 55 "action": "action", 56 "reason": { 57 "effect": "allow" 58 } 59 } 60 ] 61 } 62 }

1	curl https://app.launchdarkly.com/api/v2/users/projectKey/environmentKey/userKey \
2	-H "Authorization: <apiKey>"

1	{
2	"lastPing": "2022-06-28T23:21:29Z",
3	"environmentId": "environmentId",
4	"ownerId": "ownerId",
5	"user": {
6	"key": "user-key-123abc",
7	"secondary": "2398127",
8	"ip": "10.10.10.10",
9	"country": "United States",
10	"email": "sandy@example.com",
11	"firstName": "Sandy",
12	"lastName": "Smith",
13	"avatar": "http://example.com/avatar.png",
14	"name": "Sandy Smith",
15	"anonymous": false,
16	"custom": {
17	"key": "value"
18	},
19	"privateAttrs": [
20	"privateAttrs"
21	]
22	},
23	"sortValue": {
24	"key": "value"
25	},
26	"_links": {
27	"parent": {
28	"href": "/api/v2/users/my-project/my-environment",
29	"type": "application/json"
30	},
31	"self": {
32	"href": "/api/v2/users/my-project/my-environment/my-user",
33	"type": "application/json"
34	},
35	"settings": {
36	"href": "/api/v2/users/my-project/my-environment/my-user/flags",
37	"type": "text/html"
38	},
39	"site": {
40	"href": "/my-project/my-environment/users/my-user",
41	"type": "text/html"
42	}
43	},
44	"_access": {
45	"denied": [
46	{
47	"action": "action",
48	"reason": {
49	"effect": "allow"
50	}
51	}
52	],
53	"allowed": [
54	{
55	"action": "action",
56	"reason": {
57	"effect": "allow"
58	}
59	}
60	]
61	}
62	}