> ## Documentation Index
> Fetch the complete documentation index at: https://launchdarkly-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Invite new members
> > For the complete documentation index, see [llms.txt](https://launchdarkly-preview.mintlify.app/llms.txt). For the full documentation snapshot, see [llms-full.txt](https://launchdarkly-preview.mintlify.app/llms-full.txt).
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).
## OpenAPI
````yaml /openapi/launchdarkly-api.json post /api/v2/members
openapi: 3.0.3
info:
title: LaunchDarkly REST API
description: >
> For the complete documentation index, see
https://launchdarkly-preview.mintlify.app/llms.txt.
> For the full documentation snapshot, see
https://launchdarkly-preview.mintlify.app/llms-full.txt.
This is the LaunchDarkly REST API. It lets you build custom integrations,
automate your workflow, and manage feature flags and other LaunchDarkly
resources programmatically.
For authentication, rate limits, pagination, versioning, JSON Patch and
semantic patches, beta resources, and the full SDK End-of-Life table, read
the [REST API overview](https://launchdarkly-preview.mintlify.app/api).
To fetch the complete OpenAPI spec, use [Get OpenAPI
spec](https://launchdarkly.com/docs/api/other/get-openapi-spec).
contact:
name: LaunchDarkly Technical Support Team
url: https://support.launchdarkly.com
email: support@launchdarkly.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2.0'
servers:
- url: https://app.launchdarkly.com
description: ' Default'
- url: https://app.launchdarkly.us
description: ' Federal'
security:
- ApiKey:
- read
- write
tags:
- name: Access tokens
description: >-
The access tokens API allows you to list, create, modify, and delete
access tokens programmatically.
- name: Account members
description: >-
The account members API allows you to invite new members to an account by
making a `POST` request to `/api/v2/members`. When you invite a new member
to an account, an invitation is sent to the email you provided.
- name: Account usage (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: AI Configs
description: >-
The AI Configs API allows you to create, retrieve, and edit AI Configs, AI
Config variations, and AI model configurations.
- name: Announcements
description: >-
The announcements API lets you create and update a custom announcement
banner that appears in the LaunchDarkly user interface for everyone in
your organization.
- name: Applications (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Approvals
description: >-
An account member can request approval on changes to a flag or AI Config's
targeting or variations, or to a segment's targeting. Members may be
required to request approval depending on the settings in their
LaunchDarkly project.
- name: Approvals (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Audit log
description: >-
LaunchDarkly maintains a record of all the changes made to any resource in
the system. You can access this history using the audit log API, including
filtering by timestamps, or using a custom policy to select which entries
to receive.
- name: Code references
description: >-
> ### Code references is an Enterprise feature > > Code references is
available to customers on an Enterprise plan. To learn more, [read about
our pricing](https://launchdarkly.com/pricing/).
- name: Context settings
description: >-
You can use the context settings API to assign a context to a specific
variation for any feature flag. To learn more, read [View and manage
contexts](https://launchdarkly.com/docs/home/observability/context-attributes#view-and-manage-contexts).
- name: Contexts
description: >-
Contexts are people, services, machines, or other resources that encounter
feature flags in your product. Contexts are identified by their `kind`,
which describes the type of resources encountering flags, and by their
`key`.
- name: Custom roles
description: >-
> ### Custom roles is an Enterprise feature > > Custom roles is available
to customers on an Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Data Export destinations
description: >-
> ### Data Export is an add-on feature > > Data Export is available as an
add-on for customers on a Foundation or Enterprise plan. To learn more,
[read about our pricing](https://launchdarkly.com/pricing/).
- name: Environments
description: >-
Environments allow you to maintain separate rollout rules in different
contexts, from local development to QA, staging, and production. With the
LaunchDarkly Environments API, you can programmatically list, create, and
manage environments.
- name: Experiments
description: >-
> ### Available for subscription customers > > Experimentation is
available to all customers on a Developer, Foundation, or Enterprise
subscription. If you're on an older Pro or Enterprise plan,
Experimentation is available as an add-on.
- name: Feature flags
description: >-
The feature flags API allows you to list, create, and modify feature flags
and their targeting. For example, you can control percentage rollouts,
target specific contexts, or even toggle off a feature flag
programmatically.
- name: Feature flags (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag import configurations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag links (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Flag triggers
description: >-
> ### Flag triggers is an Enterprise feature > > Flag triggers is
available to customers on an Enterprise plan. To learn more, [read about
our pricing](https://launchdarkly.com/pricing/).
- name: Follow flags
description: >-
Follow flags to receive email updates about targeting changes to a flag in
a project and environment.
- name: Holdouts (beta)
description: >-
> ### Available for customers using Experimentation > > Holdouts are
available to customers using
[Experimentation](https://launchdarkly.com/docs/api/experiments).
- name: Insights charts (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights deployments (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights flag events (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights pull requests (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights repositories (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Insights scores (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Integration audit log subscriptions
description: >-
Audit log integration subscriptions allow you to send audit log events
hooks to one of dozens of external tools. For example, you can send flag
change event webhooks to external third party software.
- name: Integration delivery configurations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Integrations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Layers
description: >-
> ### Available for customers using Experimentation > > Layers are
available to customers using
[Experimentation](https://launchdarkly.com/docs/api/experiments).
- name: Metrics
description: >-
Metrics track flag behavior over time when an experiment is running. The
data generated from experiments gives you more insight into the impact of
a particular flag.
- name: Metrics (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: OAuth2 Clients
description: >-
The OAuth2 client API allows you to register a LaunchDarkly OAuth client
for use in your own custom integrations.
- name: Persistent store integrations (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Projects
description: >-
Projects allow you to manage multiple different software projects under
one LaunchDarkly account. Each project has its own unique set of
environments and feature flags.
- name: Relay Proxy configurations
description: >-
> ### Relay Proxy automatic configuration is an Enterprise feature > >
Relay Proxy automatic configuration is available to customers on an
Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Release pipelines (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Release policies (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Releases (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Scheduled changes
description: >-
> ### Scheduled flag changes is an Enterprise feature > > Scheduled flag
changes is available to customers on an Enterprise plan. To learn more,
[read about our pricing](https://launchdarkly.com/pricing/).
- name: Segments
description: >-
> ### Synced segments and larger list-based segments are an Enterprise
feature > > This section documents endpoints for rule-based, list-based,
and synced segments.
- name: Tags
description: >-
Tags are simple strings that you can attach to most resources in
LaunchDarkly. Tags are useful for grouping resources into a set that you
can name in a resource specifier.
- name: Teams
description: >-
> ### Teams is an Enterprise feature > > Teams is available to customers
on an Enterprise plan. To learn more, [read about our
pricing](https://launchdarkly.com/pricing/).
- name: Teams (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: User settings
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of the user
settings API.
- name: Users
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of these
endpoints.
- name: Users (beta)
description: >-
> ### Contexts are now available > > After you have upgraded your
LaunchDarkly SDK to use contexts instead of users, you should use
[Contexts](https://launchdarkly.com/docs/api/contexts) instead of these
endpoints.
- name: Views (beta)
description: >-
> ### This feature is in beta > > To use this feature, pass in a header
including the `LD-API-Version` key with value set to `beta`. Use this
header with each call.
- name: Webhooks
description: >-
The webhooks API lets you build your own integrations that subscribe to
activities in LaunchDarkly. When you generate an activity in LaunchDarkly,
such as when you change a flag or you create a project, LaunchDarkly sends
an HTTP POST payload to the...
- name: Workflow templates
description: >-
> ### Workflows are in maintenance mode > > The workflows feature is in
maintenance mode, and is planned for future deprecation at a date not yet
specified.
- name: Workflows
description: >-
> ### Workflows are in maintenance mode > > The workflows feature is in
maintenance mode, and is planned for future deprecation at a date not yet
specified.
- name: Other
description: Other requests available in the LaunchDarkly API.
paths:
/api/v2/members:
post:
tags:
- Account members
summary: Invite new members
description: >
> For the complete documentation index, see
[llms.txt](https://launchdarkly-preview.mintlify.app/llms.txt). For the
full documentation snapshot, see
[llms-full.txt](https://launchdarkly-preview.mintlify.app/llms-full.txt).
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).
operationId: postMembers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewMemberFormListPost'
required: true
responses:
'201':
description: Member collection response
content:
application/json:
schema:
$ref: '#/components/schemas/Members'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestErrorRep'
'401':
description: Invalid access token
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorRep'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorRep'
'409':
description: Status conflict
content:
application/json:
schema:
$ref: '#/components/schemas/StatusConflictErrorRep'
'429':
description: Rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/RateLimitedErrorRep'
components:
schemas:
NewMemberFormListPost:
type: array
items:
$ref: '#/components/schemas/NewMemberForm'
Members:
type: object
required:
- items
- _links
properties:
items:
type: array
description: An array of members
items:
$ref: '#/components/schemas/Member'
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: The location and content type of related resources
totalCount:
type: integer
description: The number of members returned
InvalidRequestErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: invalid_request
message:
type: string
description: Description of the error
example: Invalid request body
UnauthorizedErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: unauthorized
message:
type: string
description: Description of the error
example: Invalid access token
ForbiddenErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: forbidden
message:
type: string
description: Description of the error
example: Forbidden. Access to the requested resource was denied.
StatusConflictErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: optimistic_locking_error
message:
type: string
description: Description of the error
example: Conflict. Optimistic lock error. Try again later.
RateLimitedErrorRep:
type: object
required:
- code
- message
properties:
code:
type: string
description: Specific error code encountered
example: rate_limited
message:
type: string
description: Description of the error
example: You've exceeded the API rate limit. Try again later.
NewMemberForm:
type: object
required:
- email
properties:
email:
type: string
description: The member's email
example: sandy@acme.com
password:
type: string
description: The member's password
example: '***'
firstName:
type: string
description: The member's first name
example: Ariel
lastName:
type: string
description: The member's last name
example: Flores
role:
type: string
description: >-
The member's initial role, if you are using a base role for the
initial role
example: reader
enum:
- reader
- writer
- admin
- no_access
customRoles:
type: array
description: >-
An array of the member's initial roles, if you are using custom
roles or preset roles provided by LaunchDarkly
items:
type: string
example:
- customRole1
- launchdarkly-developer
teamKeys:
type: array
description: An array of the member's teams
items:
type: string
example:
- team-1
- team-2
roleAttributes:
$ref: '#/components/schemas/RoleAttributeMap'
description: An object of role attributes for the member
example: '{"developerProjectKeys": ["default"]}'
Member:
type: object
required:
- _links
- _id
- role
- email
- _pendingInvite
- _verified
- customRoles
- mfa
- _lastSeen
- creationDate
properties:
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: The location and content type of related resources
_id:
type: string
description: The member's ID
example: 507f1f77bcf86cd799439011
firstName:
type: string
description: The member's first name
example: Ariel
lastName:
type: string
description: The member's last name
example: Flores
role:
type: string
description: >-
The member's base role. If the member has no additional roles, this
role will be in effect.
example: reader
email:
type: string
description: The member's email address
example: ariel@acme.com
_pendingInvite:
type: boolean
description: Whether the member has a pending invitation
example: false
_verified:
type: boolean
description: Whether the member's email address has been verified
example: true
_pendingEmail:
type: string
description: >-
The member's email address before it has been verified, for accounts
where email verification is required
customRoles:
type: array
description: >-
The set of additional roles, besides the base role, assigned to the
member
items:
type: string
example:
- devOps
- backend-devs
mfa:
type: string
description: Whether multi-factor authentication is enabled for this member
excludedDashboards:
type: array
description: Default dashboards that the member has chosen to ignore
items:
type: string
_lastSeen:
$ref: '#/components/schemas/UnixMillis'
description: The member's last session date (as Unix milliseconds since epoch)
example: '1608260796147'
_lastSeenMetadata:
$ref: '#/components/schemas/LastSeenMetadata'
description: >-
Additional metadata associated with the member's last session, for
example, whether a token was used
_integrationMetadata:
$ref: '#/components/schemas/IntegrationMetadata'
description: >-
Details on the member account in an external source, if this member
is provisioned externally
teams:
type: array
description: Details on the teams this member is assigned to
items:
$ref: '#/components/schemas/MemberTeamSummaryRep'
permissionGrants:
type: array
description: >-
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.
items:
$ref: '#/components/schemas/MemberPermissionGrantSummaryRep'
creationDate:
$ref: '#/components/schemas/UnixMillis'
description: Timestamp of when the member was created
example: '1628001602644'
oauthProviders:
type: array
description: A list of OAuth providers
items:
$ref: '#/components/schemas/OAuthProviderKind'
version:
type: integer
description: Version of the current configuration
example: 1
roleAttributes:
$ref: '#/components/schemas/RoleAttributeMap'
description: The role attributes for the member
Link:
type: object
properties:
href:
type: string
type:
type: string
RoleAttributeMap:
type: object
additionalProperties:
$ref: '#/components/schemas/RoleAttributeValues'
UnixMillis:
type: integer
format: int64
LastSeenMetadata:
type: object
properties:
tokenId:
type: string
description: The ID of the token used in the member's last session
example: 5b52207f8ca8e631d31fdb2b
IntegrationMetadata:
type: object
required:
- externalId
- externalStatus
- externalUrl
- lastChecked
properties:
externalId:
type: string
externalStatus:
$ref: '#/components/schemas/IntegrationStatus'
externalUrl:
type: string
lastChecked:
$ref: '#/components/schemas/UnixMillis'
MemberTeamSummaryRep:
type: object
required:
- customRoleKeys
- key
- name
properties:
customRoleKeys:
type: array
description: A list of keys of the custom roles this team has access to
items:
type: string
example:
- access-to-test-projects
key:
type: string
description: The team key
example: team-key-123abc
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
name:
type: string
description: The team name
example: QA Team
MemberPermissionGrantSummaryRep:
type: object
required:
- resource
properties:
actionSet:
type: string
description: >-
The name of the group of related actions to allow. A permission
grant may have either an actionSet or a list of
actions but not both at the same time.
actions:
type: array
description: >-
A list of actions to allow. A permission grant may have either an
actionSet or a list of actions but not
both at the same time.
items:
type: string
example:
- maintainTeam
resource:
type: string
description: The resource for which the actions are allowed
example: team/qa-team
OAuthProviderKind:
type: string
RoleAttributeValues:
type: array
items:
type: string
IntegrationStatus:
type: object
required:
- display
- value
properties:
display:
type: string
value:
type: string
securitySchemes:
ApiKey:
type: apiKey
in: header
name: Authorization
````