Skip to main content
Server path: /launchdarkly-account | Type: Application | PCID required: Yes

Tools

ToolDescription
launchdarkly_account_create_oauth2clientCreate a LaunchDarkly OAuth 2.0 client
launchdarkly_account_delete_custom_roleDelete custom role
launchdarkly_account_delete_memberDelete account member
launchdarkly_account_delete_oauth_clientDelete OAuth 2.0 client
launchdarkly_account_delete_teamDelete team
launchdarkly_account_delete_tokenDelete access token
launchdarkly_account_get_custom_roleGet custom role
launchdarkly_account_get_custom_rolesList custom roles
launchdarkly_account_get_memberGet account member
launchdarkly_account_get_membersList account members
launchdarkly_account_get_oauth_client_by_idGet client by ID
launchdarkly_account_get_oauth_clientsGet clients
launchdarkly_account_get_teamGet team
launchdarkly_account_get_team_maintainersGet team maintainers
launchdarkly_account_get_team_rolesGet team custom roles
launchdarkly_account_get_teamsList teams
launchdarkly_account_get_tokenGet access token
launchdarkly_account_get_tokensList access tokens
launchdarkly_account_patch_custom_roleUpdate custom role
launchdarkly_account_patch_memberModify an account member
launchdarkly_account_patch_membersModify account members
launchdarkly_account_patch_oauth_clientPatch client by ID
launchdarkly_account_patch_teamUpdate team
launchdarkly_account_patch_teamsUpdate teams
launchdarkly_account_patch_tokenPatch access token
launchdarkly_account_post_custom_roleCreate custom role
launchdarkly_account_post_member_teamsAdd a member to teams
launchdarkly_account_post_membersInvite new members
launchdarkly_account_post_teamCreate team
launchdarkly_account_post_team_membersAdd multiple members to team
launchdarkly_account_post_tokenCreate access token
launchdarkly_account_reset_tokenReset access token

launchdarkly_account_create_oauth2client

Create a LaunchDarkly OAuth 2.0 client Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoDescription of your OAuth 2.0 client.
namestringNoThe name of your new LaunchDarkly OAuth 2.0 client.
redirectUristringNoThe redirect URI for your new OAuth 2.0 application. This should be an absolute URL conforming with the standard HTTPS protocol.

launchdarkly_account_delete_custom_role

Delete custom role Parameters:
ParameterTypeRequiredDefaultDescription
customRoleKeystringYesThe custom role key

launchdarkly_account_delete_member

Delete account member Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe member ID

launchdarkly_account_delete_oauth_client

Delete OAuth 2.0 client Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesThe client ID

launchdarkly_account_delete_team

Delete team Parameters:
ParameterTypeRequiredDefaultDescription
teamKeystringYesThe team key

launchdarkly_account_delete_token

Delete access token Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the access token to update

launchdarkly_account_get_custom_role

Get custom role Parameters:
ParameterTypeRequiredDefaultDescription
customRoleKeystringYesThe custom role key or ID

launchdarkly_account_get_custom_roles

List custom roles Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of custom roles to return. Defaults to 20.
offsetintegerNoWhere to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

launchdarkly_account_get_member

Get account member Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe member ID
expandstringNoA comma-separated list of properties that can reveal additional information in the response.

launchdarkly_account_get_members

List account members Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of members to return in the response. Defaults to 20.
offsetintegerNoWhere to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.
filterstringNoA comma-separated list of filters. Each filter is of the form field:value. Supported fields are explained above.
expandstringNoA comma-separated list of properties that can reveal additional information in the response.
sortstringNoA comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.

launchdarkly_account_get_oauth_client_by_id

Get client by ID Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesThe client ID

launchdarkly_account_get_oauth_clients

Get clients

launchdarkly_account_get_team

Get team Parameters:
ParameterTypeRequiredDefaultDescription
teamKeystringYesThe team key.
expandstringNoA comma-separated list of properties that can reveal additional information in the response.

launchdarkly_account_get_team_maintainers

Get team maintainers Parameters:
ParameterTypeRequiredDefaultDescription
teamKeystringYesThe team key
limitintegerNoThe number of maintainers to return in the response. Defaults to 20.
offsetintegerNoWhere to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

launchdarkly_account_get_team_roles

Get team custom roles Parameters:
ParameterTypeRequiredDefaultDescription
teamKeystringYesThe team key
limitintegerNoThe number of roles to return in the response. Defaults to 20.
offsetintegerNoWhere to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

launchdarkly_account_get_teams

List teams Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of teams to return in the response. Defaults to 20.
offsetintegerNoWhere to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items.
filterstringNoA comma-separated list of filters. Each filter is constructed as field:value.
expandstringNoA comma-separated list of properties that can reveal additional information in the response.

launchdarkly_account_get_token

Get access token Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the access token

launchdarkly_account_get_tokens

List access tokens Parameters:
ParameterTypeRequiredDefaultDescription
showAllbooleanNoIf set to true, and the authentication access token has the ‘Admin’ role, personal access tokens for all members will be retrieved.
limitintegerNoThe number of access tokens to return in the response. Defaults to 25.
offsetintegerNoWhere to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

launchdarkly_account_patch_custom_role

Update custom role Parameters:
ParameterTypeRequiredDefaultDescription
customRoleKeystringYesThe custom role key
commentstringNoOptional comment
patchobject[]YesThe patch value

launchdarkly_account_patch_member

Modify an account member Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe member ID
bodyobject[]YesRequest body

launchdarkly_account_patch_members

Modify account members Parameters:
ParameterTypeRequiredDefaultDescription
commentstringNoOptional comment describing the update
instructionsobject[]YesThe instructions value

launchdarkly_account_patch_oauth_client

Patch client by ID Parameters:
ParameterTypeRequiredDefaultDescription
clientIdstringYesThe client ID
bodyobject[]YesRequest body

launchdarkly_account_patch_team

Update team Parameters:
ParameterTypeRequiredDefaultDescription
teamKeystringYesThe team key
expandstringNoA comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above.
commentstringNoOptional comment describing the update
instructionsobject[]YesThe instructions value

launchdarkly_account_patch_teams

Update teams Parameters:
ParameterTypeRequiredDefaultDescription
commentstringNoOptional comment describing the update
instructionsobject[]YesThe instructions value

launchdarkly_account_patch_token

Patch access token Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the access token to update
bodyobject[]YesRequest body

launchdarkly_account_post_custom_role

Create custom role Parameters:
ParameterTypeRequiredDefaultDescription
basePermissionsstringNoBase Permissions
descriptionstringNoDescription of custom role
keystringYesThe custom role key
namestringYesA human-friendly name for the custom role
policyobject[]YesThe policy value
resourceCategorystringNoResource Category

launchdarkly_account_post_member_teams

Add a member to teams Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe member ID
teamKeysstring[]YesList of team keys

launchdarkly_account_post_members

Invite new members Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]YesRequest body

launchdarkly_account_post_team

Create team Parameters:
ParameterTypeRequiredDefaultDescription
expandstringNoA comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above.
customRoleKeysstring[]NoList of custom role keys the team will access
descriptionstringNoA description of the team
keystringYesThe team key
memberIDsstring[]NoA list of member IDs who belong to the team
namestringYesA human-friendly name for the team
permissionGrantsobject[]NoA list of permission grants. Permission grants allow access to a specific action, without having to create or update a custom role.
roleAttributesobjectNoRole Attributes

launchdarkly_account_post_team_members

Add multiple members to team Parameters:
ParameterTypeRequiredDefaultDescription
teamKeystringYesThe team key
filestringNoCSV file containing email addresses

launchdarkly_account_post_token

Create access token Parameters:
ParameterTypeRequiredDefaultDescription
customRoleIdsstring[]NoA list of custom role IDs to use as access limits for the access token
defaultApiVersionintegerNoThe default API version for this token
descriptionstringNoA description for the access token
inlineRoleobject[]NoA JSON array of statements represented as JSON objects with three attributes: effect, resources, actions. May be used in place of a role.
namestringNoA human-friendly name for the access token
rolestringNoBase role for the token
serviceTokenbooleanNoWhether the token is a service token

launchdarkly_account_reset_token

Reset access token Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the access token to update
expiryintegerNoAn expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.