Invite new members | LaunchDarkly

Invite one or more new members to join an account. Each member is sent an invitation. Members with Admin or Owner roles may create new members, as well as anyone with a createMember permission for “member/*”. If a member cannot be invited, the entire request is rejected and no members are invited from that request.

Each member must have an email field and either a role or a customRoles field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the “message” field of the response.

Valid base role names that you can provide for the role field include reader, writer, admin, owner/admin, and no_access. To learn more about base roles, read Organization roles.

If you are using the customRoles field instead, you can provide the key for any role that you have created, or for any preset organization role or project role provided by LaunchDarkly. Some preset roles additionally require that you specify roleAttributes. To learn more, read Using role scope.

Requests to create account members will not work if SCIM is enabled for the account.

No more than 50 members may be created per request.

A request may also fail because of conflicts with existing members. These conflicts are reported using the additional code and invalid_emails response fields with the following possible values for code:

email_already_exists_in_account: A member with this email address already exists in this account.
email_taken_in_different_account: A member with this email address exists in another account.
duplicate_emails: This request contains two or more members with the same email address.

A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).

Invite one or more new members to join an account. Each member is sent an invitation. Members with Admin or Owner roles may create new members, as well as anyone with a `createMember` permission for "member/\*". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the "message" field of the response. Valid base role names that you can provide for the `role` field include `reader`, `writer`, `admin`, `owner/admin`, and `no_access`. To learn more about base roles, read [Organization roles](https://launchdarkly.com/docs/home/account/roles/organization-roles). If you are using the `customRoles` field instead, you can provide the key for any role that you have created, or for any preset [organization role](https://launchdarkly.com/docs/home/account/roles/organization-roles) or [project role](https://launchdarkly.com/docs/home/account/roles/project-roles) provided by LaunchDarkly. Some preset roles additionally require that you specify `roleAttributes`. To learn more, read [Using role scope](https://launchdarkly.com/docs/home/account/roles/role-scope). Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects a list of objects.

emailstringRequired

The member's email

passwordstringOptional

The member's password

firstNamestringOptional

The member's first name

lastNamestringOptional

The member's last name

roleenumOptional

The member's initial role, if you are using a base role for the initial role

Allowed values:

customRoleslist of stringsOptional

An array of the member's initial roles, if you are using custom roles or preset roles provided by LaunchDarkly

teamKeyslist of stringsOptional

An array of the member's teams

roleAttributesmap from strings to lists of stringsOptional

An object of role attributes for the member

Response

Member collection response

itemslist of objects

An array of members

_linksmap from strings to objects

The location and content type of related resources

totalCountinteger or null

The number of members returned

Errors

Valid base role names that you can provide for the role field include reader, writer, admin, owner/admin, and no_access. To learn more about base roles, read Organization roles.

Requests to create account members will not work if SCIM is enabled for the account.

No more than 50 members may be created per request.

email_already_exists_in_account: A member with this email address already exists in this account.
email_taken_in_different_account: A member with this email address exists in another account.
duplicate_emails: This request contains two or more members with the same email address.

A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).

1	import requests
2
3	url = "https://app.launchdarkly.com/api/v2/members"
4
5	payload = { "0": { "email": "sandy@acme.com" } }
6	headers = {
7	"Authorization": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

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