GuidesRecipesAPI ReferenceChangelogDiscussions
Log In

Teams

Overview

Teams organize groups of users within an account. Developers and Data Scientists may be members of many teams and have access only to the data within those teams. Teams have a Team Administrator assigned and may have several members with the team administrator role.

The admin team is a default team set upon installation. Members of the admin team create and manage other teams.

Team administrators create and manage teams. Then, they can add and invite users as team members. When users are added to a team, a team API key with specific roles is created and assigned to them.

The teams object

{
  "identifier": "...",
  "name": "...",
  "status": "...",
  "teamAdmin": {
    "identifier": "...",
    "firstName": "...",
    "lastName": "...",
    "email": "...",
    "status": "...",
    "lastActiveDateTime": "..."
  },
  "members": [],
  "accessKey": [],
  "account": {
    "identifier": "...",
    "name": "..."
  },
  "createdAt": "...",
  "updatedAt": "..."
}
ParameterTypeDescription
identifierstringThe team's identifiers.
namestringThe team's name.
statusstringThe team's status. Values can be ACTIVE and INACTIVE.
teamAdminobjectAn object that contains the team administrator's basic user details.
membersarrayAn array that contains the team member's basic user details.
accessKeyarrayAn array that contains the team's API keys.
accountobjectAn object that contains the team's associated account details.
createdAtstringThe date the user was created in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
updatedAtstringThe date the user was updated in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.