Create team

POST

/api/v2/teams

POST

/api/v2/teams

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

{
  "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": [
            {
              "_id": "57be1db38b75bf0772d11383",
              "_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": [
      {
        "_id": "57be1db38b75bf0772d11383",
        "_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": [
      {
        "_links": {
          "self": {
            "href": "/api/v2/members/569f183514f4432160000007",
            "type": "application/json"
          }
        },
        "_id": "569f183514f4432160000007",
        "role": "reader",
        "email": "ariel@acme.com",
        "firstName": "Ariel",
        "lastName": "Flores"
      }
    ],
    "_links": {
      "self": {
        "href": "/api/v2/teams/example-team/maintainers?limit=20",
        "type": "application/json"
      }
    }
  }
}

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.

Create a team. To learn more, read [Creating a team](https://launchdarkly.com/docs/home/account/create-teams). ### 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.

Authentication

Authorizationstring

API Key authentication via header

Query parameters

expandstringOptionalformat: "string"

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

Request

This endpoint expects an object.

keystringRequired

The team key

namestringRequired

A human-friendly name for the team

customRoleKeyslist of stringsOptional

List of custom role keys the team will access

descriptionstringOptional

A description of the team

memberIDslist of stringsOptional

A list of member IDs who belong to the team

permissionGrantslist of objectsOptional

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

roleAttributesmap from strings to lists of stringsOptional

A map of role attributes for the team

Response

Teams response

descriptionstringOptional

A description of the team

keystringOptional

The team key

namestringOptional

A human-friendly name for the team

_accessobjectOptional

Details on the allowed and denied actions for this team

_creationDatelongOptional

Timestamp of when the team was created

_linksmap from strings to objectsOptional

The location and content type of related resources

_lastModifiedlongOptional

Timestamp of when the team was most recently updated

_versionintegerOptional

The team version

_idpSyncedbooleanOptional

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

roleAttributesmap from strings to lists of stringsOptional

A map of role attributes for the team

rolesobjectOptional

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

membersobjectOptional

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

projectsobjectOptional

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

maintainersobjectOptional

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

Errors

400

Bad Request Error

401

Unauthorized Error

405

Method Not Allowed Error

429

Too Many Requests Error