Get account member

GET

/api/v2/members/:id

GET

/api/v2/members/:id

$ curl https://app.launchdarkly.com/api/v2/members/id \
>      -H "Authorization: <apiKey>"

1 {
2   "_links": {},
3   "_id": "507f1f77bcf86cd799439011",
4   "role": "reader",
5   "email": "ariel@acme.com",
6   "_pendingInvite": false,
7   "_verified": true,
8   "customRoles": [
9     "devOps",
10     "backend-devs"
11   ],
12   "mfa": "string",
13   "_lastSeen": 1608260796147,
14   "creationDate": 1628001602644,
15   "firstName": "Ariel",
16   "lastName": "Flores",
17   "_pendingEmail": "string",
18   "excludedDashboards": [
19     "string"
20   ],
21   "_lastSeenMetadata": {
22     "tokenId": "5b52207f8ca8e631d31fdb2b"
23   },
24   "_integrationMetadata": {
25     "externalId": "string",
26     "externalStatus": {
27       "display": "string",
28       "value": "string"
29     },
30     "externalUrl": "string",
31     "lastChecked": 1
32   },
33   "teams": [
34     {
35       "customRoleKeys": [
36         "access-to-test-projects"
37       ],
38       "key": "team-key-123abc",
39       "name": "QA Team",
40       "_links": {}
41     }
42   ],
43   "permissionGrants": [
44     {
45       "resource": "team/qa-team",
46       "actionSet": "string",
47       "actions": [
48         "maintainTeam"
49       ]
50     }
51   ],
52   "oauthProviders": [
53     "string"
54   ],
55   "version": 1,
56   "roleAttributes": {}
57 }

Get a single account member by member ID. `me` is a reserved value for the `id` parameter that returns the caller's member information. ### Expanding the member response LaunchDarkly supports the following fields for expanding the "Get member" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `customRoles` includes details on each custom role assigned to the member, including the role key, name, and ID. * `roleAttributes` includes a list of the role attributes that you have assigned to the member. For example, `expand=customRoles,roleAttributes` includes both the `customRolesInfo` and `roleAttributes` fields in the response.

Get account member

GET

/api/v2/members/:id

GET

/api/v2/members/:id

$ curl https://app.launchdarkly.com/api/v2/members/id \
>      -H "Authorization: <apiKey>"

1 {
2   "_links": {},
3   "_id": "507f1f77bcf86cd799439011",
4   "role": "reader",
5   "email": "ariel@acme.com",
6   "_pendingInvite": false,
7   "_verified": true,
8   "customRoles": [
9     "devOps",
10     "backend-devs"
11   ],
12   "mfa": "string",
13   "_lastSeen": 1608260796147,
14   "creationDate": 1628001602644,
15   "firstName": "Ariel",
16   "lastName": "Flores",
17   "_pendingEmail": "string",
18   "excludedDashboards": [
19     "string"
20   ],
21   "_lastSeenMetadata": {
22     "tokenId": "5b52207f8ca8e631d31fdb2b"
23   },
24   "_integrationMetadata": {
25     "externalId": "string",
26     "externalStatus": {
27       "display": "string",
28       "value": "string"
29     },
30     "externalUrl": "string",
31     "lastChecked": 1
32   },
33   "teams": [
34     {
35       "customRoleKeys": [
36         "access-to-test-projects"
37       ],
38       "key": "team-key-123abc",
39       "name": "QA Team",
40       "_links": {}
41     }
42   ],
43   "permissionGrants": [
44     {
45       "resource": "team/qa-team",
46       "actionSet": "string",
47       "actions": [
48         "maintainTeam"
49       ]
50     }
51   ],
52   "oauthProviders": [
53     "string"
54   ],
55   "version": 1,
56   "roleAttributes": {}
57 }

Get a single account member by member ID.

me is a reserved value for the id parameter that returns the caller’s member information.

Expanding the member response

LaunchDarkly supports the following fields for expanding the “Get member” response. By default, these fields are not included in the response.

To expand the response, append the expand query parameter and add a comma-separated list with any of the following fields:

customRoles includes details on each custom role assigned to the member, including the role key, name, and ID.
roleAttributes includes a list of the role attributes that you have assigned to the member.

For example, expand=customRoles,roleAttributes includes both the customRolesInfo and roleAttributes fields in the response.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequiredformat: "string"

The member ID

Query parameters

expandstringOptionalformat: "string"

A comma-separated list of properties that can reveal additional information in the response.

Response

Member response

_linksmap from strings to objects

The location and content type of related resources

_idstring

The member's ID

rolestring

The member's base role. If the member has no additional roles, this role will be in effect.

emailstring

The member's email address

_pendingInviteboolean

Whether the member has a pending invitation

_verifiedboolean

Whether the member's email address has been verified

customRoleslist of strings

The set of additional roles, besides the base role, assigned to the member

mfastring

Whether multi-factor authentication is enabled for this member

_lastSeenlong

The member’s last session date (as Unix milliseconds since epoch)

creationDatelong

Timestamp of when the member was created

firstNamestring

The member's first name

lastNamestring

The member's last name

_pendingEmailstring

The member's email address before it has been verified, for accounts where email verification is required

excludedDashboardslist of strings

Default dashboards that the member has chosen to ignore

_lastSeenMetadataobject

Additional metadata associated with the member's last session, for example, whether a token was used

_integrationMetadataobject

Details on the member account in an external source, if this member is provisioned externally

teamslist of objects

Details on the teams this member is assigned to

permissionGrantslist of objects

A list of permission grants. Permission grants allow a member to have access to a specific action, without having to create or update a custom role.

oauthProviderslist of strings

A list of OAuth providers

versioninteger

Version of the current configuration

roleAttributesmap from strings to lists of strings

The role attributes for the member

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequiredformat: "string"

The member ID

Query parameters

expandstringOptionalformat: "string"

A comma-separated list of properties that can reveal additional information in the response.

Response

Member response

_linksmap from strings to objects

The location and content type of related resources

_idstring

The member's ID

rolestring

The member's base role. If the member has no additional roles, this role will be in effect.

emailstring

The member's email address

_pendingInviteboolean

Whether the member has a pending invitation

_verifiedboolean

Whether the member's email address has been verified

customRoleslist of strings

The set of additional roles, besides the base role, assigned to the member

mfastring

Whether multi-factor authentication is enabled for this member

_lastSeenlong

The member’s last session date (as Unix milliseconds since epoch)

creationDatelong

Timestamp of when the member was created

firstNamestring

The member's first name

lastNamestring

The member's last name

_pendingEmailstring

The member's email address before it has been verified, for accounts where email verification is required

excludedDashboardslist of strings

Default dashboards that the member has chosen to ignore

_lastSeenMetadataobject

Additional metadata associated with the member's last session, for example, whether a token was used

_integrationMetadataobject

Details on the member account in an external source, if this member is provisioned externally

teamslist of objects

Details on the teams this member is assigned to

permissionGrantslist of objects

A list of permission grants. Permission grants allow a member to have access to a specific action, without having to create or update a custom role.

oauthProviderslist of strings

A list of OAuth providers

versioninteger

Version of the current configuration

roleAttributesmap from strings to lists of strings

The role attributes for the member

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

$	curl https://app.launchdarkly.com/api/v2/members/id \
>	-H "Authorization: <apiKey>"

1	{
2	"_links": {},
3	"_id": "507f1f77bcf86cd799439011",
4	"role": "reader",
5	"email": "ariel@acme.com",
6	"_pendingInvite": false,
7	"_verified": true,
8	"customRoles": [
9	"devOps",
10	"backend-devs"
11	],
12	"mfa": "string",
13	"_lastSeen": 1608260796147,
14	"creationDate": 1628001602644,
15	"firstName": "Ariel",
16	"lastName": "Flores",
17	"_pendingEmail": "string",
18	"excludedDashboards": [
19	"string"
20	],
21	"_lastSeenMetadata": {
22	"tokenId": "5b52207f8ca8e631d31fdb2b"
23	},
24	"_integrationMetadata": {
25	"externalId": "string",
26	"externalStatus": {
27	"display": "string",
28	"value": "string"
29	},
30	"externalUrl": "string",
31	"lastChecked": 1
32	},
33	"teams": [
34	{
35	"customRoleKeys": [
36	"access-to-test-projects"
37	],
38	"key": "team-key-123abc",
39	"name": "QA Team",
40	"_links": {}
41	}
42	],
43	"permissionGrants": [
44	{
45	"resource": "team/qa-team",
46	"actionSet": "string",
47	"actions": [
48	"maintainTeam"
49	]
50	}
51	],
52	"oauthProviders": [
53	"string"
54	],
55	"version": 1,
56	"roleAttributes": {}
57	}