Create team

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Create a team. To learn more, read Creating a team.

Expanding the teams response

LaunchDarkly supports four fields for expanding the “Create team” 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:

• members includes the total count of members that belong to the team.
• roles includes a paginated list of the custom roles that you have assigned to the team.
• projects includes a paginated list of the projects that the team has any write access to.
• maintainers includes a paginated list of the maintainers that you have assigned to the team.

For example, expand=members,roles includes the members and roles fields in the response.

POST /api/v2/teams

Create team

cURL

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/teams \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customRoleKeys": [
    "example-role1",
    "example-role2"
  ],
  "description": "An example team",
  "key": "team-key-123abc",
  "memberIDs": [
    "12ab3c45de678910fgh12345"
  ],
  "name": "Example team"
}
'

201

{
  "description": "Description for this team.",
  "key": "team-key-123abc",
  "name": "Example team",
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "_creationDate": "1648671956143",
  "_links": {
    "parent": {
      "href": "/api/v2/teams",
      "type": "application/json"
    },
    "roles": {
      "href": "/api/v2/teams/example-team/roles",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/teams/example-team",
      "type": "application/json"
    }
  },
  "_lastModified": "1648672446072",
  "_version": 3,
  "_idpSynced": true,
  "roleAttributes": "{\"developerProjectKey\": [\"default\"]}",
  "roles": {
    "totalCount": 1,
    "items": [
      {
        "key": "role-key-123abc",
        "name": "Example role",
        "projects": {
          "totalCount": 1,
          "items": [
            {
              "_links": {
                "environments": {
                  "href": "/api/v2/projects/example-project/environments",
                  "type": "application/json"
                },
                "self": {
                  "href": "/api/v2/projects/example-project",
                  "type": "application/json"
                }
              },
              "key": "project-key-123abc",
              "name": "Example project"
            }
          ]
        },
        "appliedOn": "1648672018410"
      }
    ],
    "_links": {
      "self": {
        "href": "/api/v2/teams/example-team/roles?limit=25",
        "type": "application/json"
      }
    }
  },
  "members": {
    "totalCount": 15
  },
  "projects": {
    "totalCount": 1,
    "items": [
      {
        "_links": {
          "environments": {
            "href": "/api/v2/projects/example-project/environments",
            "type": "application/json"
          },
          "self": {
            "href": "/api/v2/projects/example-project",
            "type": "application/json"
          }
        },
        "key": "project-key-123abc",
        "name": "Example project"
      }
    ]
  },
  "maintainers": {
    "totalCount": 1,
    "items": [
      {
        "_id": "569f183514f4432160000007",
        "_links": {
          "self": {
            "href": "/api/v2/members/569f183514f4432160000007",
            "type": "application/json"
          }
        },
        "email": "[e-mail]",
        "firstName": "Ariel",
        "lastName": "Flores",
        "role": "reader"
      }
    ],
    "_links": {
      "self": {
        "href": "/api/v2/teams/example-team/maintainers?limit=20",
        "type": "application/json"
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Query Parameters

expand · string<string>

A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above.

Body

application/json

key · string · required

The team key

Example:

"team-key-123abc"

name · string · required

A human-friendly name for the team

Example:

"Example team"

customRoleKeys · string[]

List of custom role keys the team will access

Example:

["example-role1", "example-role2"]

description · string

A description of the team

Example:

"An example team"

memberIDs · string[]

A list of member IDs who belong to the team

Example:

["12ab3c45de678910fgh12345"]

permissionGrants · object[]

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

Show child attributes

roleAttributes · object

A map of role attributes for the team

Show child attributes

Example:

"{\"developerProjectKey\": [\"default\"]}"

Response

201

application/json

Teams response

description · string

A description of the team

Example:

"Description for this team."

key · string

The team key

Example:

"team-key-123abc"

name · string

A human-friendly name for the team

Example:

"Example team"

_access · object

Details on the allowed and denied actions for this team

Show child attributes

_creationDate · integer<int64>

Timestamp of when the team was created

Example:

"1648671956143"

_links · object

The location and content type of related resources

Show child attributes

Example:

{
  "parent": {
    "href": "/api/v2/teams",
    "type": "application/json"
  },
  "roles": {
    "href": "/api/v2/teams/example-team/roles",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/teams/example-team",
    "type": "application/json"
  }
}

_lastModified · integer<int64>

Timestamp of when the team was most recently updated

Example:

"1648672446072"

_version · integer

The team version

Example:

3

_idpSynced · boolean

Whether the team has been synced with an external identity provider (IdP). Team sync is available to customers on an Enterprise plan.

Example:

true

roleAttributes · object

A map of role attributes for the team

Show child attributes

Example:

"{\"developerProjectKey\": [\"default\"]}"

roles · object

Paginated list of the custom roles assigned to this team. Only included if specified in the expand query parameter.

Show child attributes

members · object

Details on the total count of members that belong to the team. Only included if specified in the expand query parameter.

Show child attributes

projects · object

Paginated list of the projects that the team has any write access to. Only included if specified in the expand query parameter.

Show child attributes

maintainers · object

Paginated list of the maintainers assigned to this team. Only included if specified in the expand query parameter.

Show child attributes